com.atlassian.jira.service.services.vcs
Class VcsService

java.lang.Object
  extended by com.atlassian.jira.service.AbstractService
      extended by com.atlassian.jira.service.services.vcs.VcsService
All Implemented Interfaces:
com.atlassian.configurable.ObjectConfigurable, JiraService

public class VcsService
extends AbstractService


Field Summary
 
Fields inherited from class com.atlassian.jira.service.AbstractService
name
 
Fields inherited from interface com.atlassian.jira.service.JiraService
NAME_COMPARATOR
 
Constructor Summary
VcsService()
           
VcsService(RepositoryManager repositoryManager)
           
 
Method Summary
 com.atlassian.configurable.ObjectConfiguration getObjectConfiguration()
           
 void init(com.opensymphony.module.propertyset.PropertySet props)
          Initialise the service.
 boolean isInternal()
          Indicates whether administrators can delete this service from within the web interface.
 boolean isUnique()
          By default, services are not unique.
 void run()
          This method must be implemented in a subclass, and performs the functionality that the service performs.
 
Methods inherited from class com.atlassian.jira.service.AbstractService
destroy, getDefaultProperty, getDescription, getKey, getLongProperty, getName, getObjectConfiguration, getProperties, getProperty, getTextProperty, hasProperty, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VcsService

public VcsService(RepositoryManager repositoryManager)

VcsService

public VcsService()
Method Detail

getObjectConfiguration

public com.atlassian.configurable.ObjectConfiguration getObjectConfiguration()
                                                                      throws com.atlassian.configurable.ObjectConfigurationException
Throws:
com.atlassian.configurable.ObjectConfigurationException

init

public void init(com.opensymphony.module.propertyset.PropertySet props)
          throws com.atlassian.configurable.ObjectConfigurationException
Description copied from interface: JiraService
Initialise the service. This method is guaranteed to be called before the first call to run().

As the parameters are gained from the user's interaction with the website, it is not guaranteed to be called with the correct, or indeed with any parameters.

init() may be called multiple times during the services lifetime.

Specified by:
init in interface JiraService
Overrides:
init in class AbstractService
Throws:
com.atlassian.configurable.ObjectConfigurationException

run

public void run()
Description copied from class: AbstractService
This method must be implemented in a subclass, and performs the functionality that the service performs. This method is called after the duration specified through the administration web interface.

Specified by:
run in interface JiraService
Specified by:
run in class AbstractService
See Also:
JiraService.init(com.opensymphony.module.propertyset.PropertySet)

isUnique

public boolean isUnique()
Description copied from class: AbstractService
By default, services are not unique.

Specified by:
isUnique in interface JiraService
Overrides:
isUnique in class AbstractService
Returns:
false.

isInternal

public boolean isInternal()
Description copied from interface: JiraService
Indicates whether administrators can delete this service from within the web interface.

Generally only Atlassian services should return true from this.

Specified by:
isInternal in interface JiraService
Overrides:
isInternal in class AbstractService


Copyright © 2002-2007 Atlassian. All Rights Reserved.