com.atlassian.jira.service

Interface ServiceConfigStore

All Known Implementing Classes:

OfBizServiceConfigStore

public interface ServiceConfigStore

A store interface for the ServiceConfigs

Method Summary

Modifier and Type	Method and Description
JiraServiceContainer	addServiceConfig(String serviceName, Class<? extends JiraService> serviceClass, long serviceDelay) Deprecated.
JiraServiceContainer	addServiceConfig(String name, Class<? extends JiraService> serviceClass, String cronExpression, Long serviceDelay) Adds a new Service of the given class with the the given configuration.
void	editServiceConfig(JiraServiceContainer config, long delay, Map<String,String[]> params) Deprecated.
void	editServiceConfig(JiraServiceContainer serviceContainer, String cronExpression, Map<String,String[]> params) Edit the schedule and parameters for a service.
Collection<JiraServiceContainer>	getAllServiceConfigs()
JiraServiceContainer	getServiceConfigForId(Long id)
JiraServiceContainer	getServiceConfigForName(String name)
void	removeServiceConfig(JiraServiceContainer config)

Method Detail

addServiceConfig

@Deprecated
JiraServiceContainer addServiceConfig(String serviceName,
                                                  Class<? extends JiraService> serviceClass,
                                                  long serviceDelay)
                                           throws ServiceException

Deprecated.

Adds a new Service of the given class with the the given configuration.

Parameters:

serviceName - The service name.

serviceClass - The JiraService class that we wish to add as a service.

serviceDelay - the service delay.

Returns:

JiraServiceContainer for this service.

Throws:

ServiceException - If there is any errors trying to add this Service.

addServiceConfig

JiraServiceContainer addServiceConfig(String name,
                                      Class<? extends JiraService> serviceClass,
                                      String cronExpression,
                                      Long serviceDelay)
                               throws ServiceException

Adds a new Service of the given class with the the given configuration.

Parameters:

name - Service name

serviceClass - Class implementing the service

cronExpression - Cron expression

serviceDelay - the service delay. Only used if the instance is downgraded to a JIRA version prior to 6.4

Returns:

JiraServiceContainer for this service.

Throws:

ServiceException

editServiceConfig

@Deprecated
void editServiceConfig(JiraServiceContainer config,
                                   long delay,
                                   Map<String,String[]> params)
                            throws ServiceException

Deprecated.

Throws:

ServiceException

editServiceConfig

void editServiceConfig(JiraServiceContainer serviceContainer,
                       String cronExpression,
                       Map<String,String[]> params)
                throws ServiceException

Edit the schedule and parameters for a service.

Parameters:

serviceContainer - The service container

cronExpression - Cron expression

params - Service parameter map.

Throws:

ServiceException

removeServiceConfig

void removeServiceConfig(JiraServiceContainer config)

getServiceConfigForId

JiraServiceContainer getServiceConfigForId(Long id)

getServiceConfigForName

JiraServiceContainer getServiceConfigForName(String name)

getAllServiceConfigs

Collection<JiraServiceContainer> getAllServiceConfigs()