com.redhat.rcm.maven.plugin.buildmetadata.scm.maven

Class ScmConnectionInfo

java.lang.Object

com.redhat.rcm.maven.plugin.buildmetadata.scm.maven.ScmConnectionInfo

All Implemented Interfaces:

Serializable

public final class ScmConnectionInfo
extends Object
implements Serializable

Provides the information required to connect to a SCM system.

Version:

$Revision:591 $

Author:

Robert Reiner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScmConnectionInfo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure(org.apache.maven.scm.provider.ScmProviderRepository repository) Configures the repository with authentication information.
protected void	configure(org.apache.maven.scm.provider.ScmProviderRepositoryWithHost repository) Configures the repository with private key and password information.
protected void	configure(org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository repository) Configures the repository with the tag base information.
org.apache.maven.scm.repository.ScmRepository	createRepository(org.apache.maven.scm.manager.ScmManager scmManager) Creates and configures the SCM repository.
String	getConnectionUrl() Returns the URL to connect to the SCM system.
String	getPassPhrase() Returns the pass phrase to authenticate against the SCM system.
String	getPassword() Returns the password to authenticate against the SCM system.
String	getPrivateKey() Returns the private key to authenticate against the SCM system.
org.apache.maven.scm.ScmVersion	getRemoteVersion() Returns the branch or tag version on the remote server to compare against.
String	getTagBase() Returns the url of tags base directory (used by svn protocol).
String	getUserName() Returns the user name to authenticate against the SCM system.
void	setPassPhrase(String passPhrase) Sets the pass phrase to authenticate against the SCM system.
void	setPassword(String password) Sets the password to authenticate against the SCM system.
void	setPrivateKey(String privateKey) Sets the private key to authenticate against the SCM system.
void	setRemoteVersion(org.apache.maven.scm.ScmVersion remoteVersion) Sets the branch or tag version on the remote server to compare against.
void	setScmConnectionUrl(String connectionUrl) Sets the URL to connect to the SCM system.
void	setTagBase(String tagBase) Sets the url of tags base directory (used by svn protocol).
void	setUserName(String userName) Sets the user name to authenticate against the SCM system.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScmConnectionInfo

public ScmConnectionInfo()

Method Detail

getConnectionUrl

public String getConnectionUrl()

Returns the URL to connect to the SCM system.

Returns:

the URL to connect to the SCM system.

setScmConnectionUrl

public void setScmConnectionUrl(String connectionUrl)

Sets the URL to connect to the SCM system.

Parameters:

connectionUrl - the URL to connect to the SCM system.

getUserName

public String getUserName()

Returns the user name to authenticate against the SCM system.

Returns:

the user name to authenticate against the SCM system.

setUserName

public void setUserName(String userName)

Sets the user name to authenticate against the SCM system.

Parameters:

userName - the user name to authenticate against the SCM system.

getPassword

public String getPassword()

Returns the password to authenticate against the SCM system.

Returns:

the password to authenticate against the SCM system.

setPassword

public void setPassword(String password)

Sets the password to authenticate against the SCM system.

Parameters:

password - the password to authenticate against the SCM system.

getPrivateKey

public String getPrivateKey()

Returns the private key to authenticate against the SCM system.

Returns:

the private key to authenticate against the SCM system.

setPrivateKey

public void setPrivateKey(String privateKey)

Sets the private key to authenticate against the SCM system.

Parameters:

privateKey - the private key to authenticate against the SCM system.

getPassPhrase

public String getPassPhrase()

Returns the pass phrase to authenticate against the SCM system.

Returns:

the pass phrase to authenticate against the SCM system.

setPassPhrase

public void setPassPhrase(String passPhrase)

Sets the pass phrase to authenticate against the SCM system.

Parameters:

passPhrase - the pass phrase to authenticate against the SCM system.

getTagBase

public String getTagBase()

Returns the url of tags base directory (used by svn protocol).

Returns:

the url of tags base directory (used by svn protocol).

setTagBase

public void setTagBase(String tagBase)

Sets the url of tags base directory (used by svn protocol).

Parameters:

tagBase - the url of tags base directory (used by svn protocol).

getRemoteVersion

public org.apache.maven.scm.ScmVersion getRemoteVersion()

Returns the branch or tag version on the remote server to compare against. If null, the SCM status will be used to determine the differences.

Returns:

the branch or tag version on the remote server to compare against.

setRemoteVersion

public void setRemoteVersion(org.apache.maven.scm.ScmVersion remoteVersion)

Sets the branch or tag version on the remote server to compare against. If null, the SCM status will be used to determine the differences.

Parameters:

remoteVersion - the branch or tag version on the remote server to compare against.

createRepository

public org.apache.maven.scm.repository.ScmRepository createRepository(org.apache.maven.scm.manager.ScmManager scmManager)
                                                               throws ScmException

Creates and configures the SCM repository.

Parameters:

scmManager - the manager to create the repository dependent on the connection URL.

Returns:

the repository implementation to connect to the SCM system.

Throws:

ScmException - if the repository implementation cannot be created or configured. This happens especially if no provider exists for the given connection URL.

configure

protected void configure(org.apache.maven.scm.provider.ScmProviderRepository repository)

Configures the repository with authentication information.

Parameters:

repository - the repository instance to configure.

configure

protected void configure(org.apache.maven.scm.provider.ScmProviderRepositoryWithHost repository)

Configures the repository with private key and password information.

Parameters:

repository - the repository instance to configure.

configure

protected void configure(org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository repository)

Configures the repository with the tag base information.

Parameters:

repository - the repository instance to configure.

toString

public String toString()

Returns the string representation of the object. Sensitive information is masked.

Overrides:

toString in class Object

Returns:

the string representation of the object.