de.smartics.maven.issues
Class IssueManagementConfig

java.lang.Object
  de.smartics.maven.issues.IssueManagementConfig

public class IssueManagementConfig
     
     

      
      extends 
      
      Object
     
     

Provides configuration information for issue management facades.

Author:

Robert Reiner

Constructor Summary

IssueManagementConfig(String issueManagementId, String connectionUrl)
Default constructor.

Method Summary

String	getBuildDirectory() Returns the directory to store task data information for the task cache.
String	getConnectionUrl() Returns the URL to connect to the issue management system.
String	getIssueManagementId() Returns the identifier of the issue management system this configuration applies to.
String	getIssueManagementPassword() Returns the password for authentication to access a private installation of a issue management system.
String	getIssueManagementUser() Returns the name of the user for authentication to access a private installation of a issue management system.
int	getMaxEntries() Returns the value for maxEntries.
int	getMaxRetries() Returns the value for maxRetries.
String	getRepositoryVersion() Returns the value for repositoryVersion.
long	getTimeout() Returns the timeout in milliseconds between retries of connection attempts.
String	getWebPassword() Returns the password for HTTP basic authentication to the issue management webserver.
String	getWebUser() Returns the name of the user for HTTP basic authentication to the issue management webserver.
boolean	isIgnoreLogoutProblem() Returns the flag indicates whether (true) or not ( false) logout problems from the task repository should be ignored.
boolean	isLogColumns() Returns the value for logColumns.
void	setBuildDirectory(String buildDirectory) Sets the directory to store task data information for the task cache.
void	setIgnoreLogoutProblem(boolean ignoreLogoutProblem) Sets the flag indicates whether (true) or not ( false) logout problems from the task repository should be ignored.
void	setIssueManagementPassword(String issueManagementPassword) Sets the password for authentication to access a private installation of a issue management system.
void	setIssueManagementUser(String issueManagementUser) Sets the name of the user for authentication to access a private installation of a issue management system.
void	setLogColumns(boolean logColumns) Sets the value for logColumns.
void	setMaxEntries(int maxEntries) Sets the value for maxEntries.
void	setMaxRetries(int maxRetries) Sets the value for maxRetries.
void	setRepositoryVersion(String repositoryVersion) Sets the value for repositoryVersion.
void	setTimeout(long timeout) Sets the timeout between retries of connection attempts.
void	setWebPassword(String webPassword) Sets the password for HTTP basic authentication to the issue management webserver.
void	setWebUser(String webUser) Sets the name of the user for HTTP basic authentication to the issue management webserver.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueManagementConfig

public IssueManagementConfig(String issueManagementId,
                             String connectionUrl)
                      throws IllegalArgumentException

Default constructor.

Parameters:

issueManagementId - the identifier of the issue management system this configuration applies to.

connectionUrl - the URL to connect to the issue management system.

Throws:

IllegalArgumentException - if any of the given strings is blank.

Method Detail

getIssueManagementId

public String getIssueManagementId()

Returns the identifier of the issue management system this configuration applies to. The identifier is specified in the Maven POM and is evaluated by a RepositoryFacadeFactory to create a RepositoryFacade capable to access the remote issue management repository.

Returns:

the identifier of the issue management system this configuration applies to.

getConnectionUrl

public String getConnectionUrl()

Returns the URL to connect to the issue management system.

Returns:

the URL to connect to the issue management system.

getIssueManagementUser

public String getIssueManagementUser()

Returns the name of the user for authentication to access a private installation of a issue management system.

Returns:

the name of the user for authentication to access a private installation of a issue management system.

setIssueManagementUser

public void setIssueManagementUser(String issueManagementUser)

Sets the name of the user for authentication to access a private installation of a issue management system.

Parameters:

issueManagementUser - the name of the user for authentication to access a private installation of a issue management system.

getIssueManagementPassword

public String getIssueManagementPassword()

Returns the password for authentication to access a private installation of a issue management system.

Returns:

the password for authentication to access a private installation of a issue management system.

setIssueManagementPassword

public void setIssueManagementPassword(String issueManagementPassword)

Sets the password for authentication to access a private installation of a issue management system.

Parameters:

issueManagementPassword - the password for authentication to access a private installation of a issue management system.

getWebUser

public String getWebUser()

Returns the name of the user for HTTP basic authentication to the issue management webserver.

Returns:

the name of the user for HTTP basic authentication to the issue management webserver.

setWebUser

public void setWebUser(String webUser)

Sets the name of the user for HTTP basic authentication to the issue management webserver.

Parameters:

webUser - the name of the user for HTTP basic authentication to the issue management webserver.

getWebPassword

public String getWebPassword()

Returns the password for HTTP basic authentication to the issue management webserver.

Returns:

the password for HTTP basic authentication to the issue management webserver.

setWebPassword

public void setWebPassword(String webPassword)

Sets the password for HTTP basic authentication to the issue management webserver.

Parameters:

webPassword - the password for HTTP basic authentication to the issue management webserver.

getRepositoryVersion

public String getRepositoryVersion()

Returns the value for repositoryVersion.

Sets the version of the task repository.

Returns:

the value for repositoryVersion.

setRepositoryVersion

public void setRepositoryVersion(String repositoryVersion)

Sets the value for repositoryVersion.

Sets the version of the task repository.

Parameters:

repositoryVersion - the value for repositoryVersion.

getMaxEntries

public int getMaxEntries()

Returns the value for maxEntries.

Maximum number of entries to be displayed by the Bugzilla Report. Use -1 for unlimited entries.

Returns:

the value for maxEntries.

setMaxEntries

public void setMaxEntries(int maxEntries)

Sets the value for maxEntries.

Maximum number of entries to be displayed by the Bugzilla Report. Use -1 for unlimited entries.

Parameters:

maxEntries - the value for maxEntries.

getMaxRetries

public int getMaxRetries()

Returns the value for maxRetries.

Maximum number retries to connect to the issue management system.

Returns:

the value for maxRetries.

setMaxRetries

public void setMaxRetries(int maxRetries)

Sets the value for maxRetries.

Maximum number retries to connect to the issue management system.

Parameters:

maxRetries - the value for maxRetries.

getTimeout

public long getTimeout()

Returns the timeout in milliseconds between retries of connection attempts.

Returns:

the timeout in milliseconds between retries of connection attempts.

setTimeout

public void setTimeout(long timeout)

Sets the timeout between retries of connection attempts.

Parameters:

timeout - the timeout between retries of connection attempts.

isIgnoreLogoutProblem

public boolean isIgnoreLogoutProblem()

Returns the flag indicates whether ( true) or not ( false) logout problems from the task repository should be ignored.

This is a kind of hack that grabs for the string 'Logout' in the exception message reported from the task repository. It may be useful if the task repository's response is quite slow.

Returns:

the flag indicates whether ( true) or not ( false) logout problems from the task repository should be ignored.

setIgnoreLogoutProblem

public void setIgnoreLogoutProblem(boolean ignoreLogoutProblem)

Sets the flag indicates whether ( true) or not ( false) logout problems from the task repository should be ignored.

This is a kind of hack that grabs for the string 'Logout' in the exception message reported from the task repository. It may be useful if the task repository's response is quite slow.

Parameters:

ignoreLogoutProblem - the flag indicates whether ( true) or not ( false) logout problems from the task repository should be ignored.

getBuildDirectory

public String getBuildDirectory()

Returns the directory to store task data information for the task cache. This is an optimization to not fetch tasks already fetched.

Returns:

the directory to store task data information for the task cache.

setBuildDirectory

public void setBuildDirectory(String buildDirectory)

Sets the directory to store task data information for the task cache. This is an optimization to not fetch tasks already fetched.

Parameters:

buildDirectory - the directory to store task data information for the task cache.

isLogColumns

public boolean isLogColumns()

Returns the value for logColumns.

Informs that the column names retrieved by the query should be logged at the end of the query. This allows to grab the keywords returned by the issue management system.

Returns:

the value for logColumns.

setLogColumns

public void setLogColumns(boolean logColumns)

Sets the value for logColumns.

Informs that the column names retrieved by the query should be logged at the end of the query. This allows to grab the keywords returned by the issue management system.

Parameters:

logColumns - the value for logColumns.