@PublicApi public interface

ServiceManager

com.atlassian.jira.service.ServiceManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Summary

Nested Classes
interface ServiceManager.ServiceScheduleSkipper This interface is deprecated. v6.2 This is no longer used.  
Fields
public static final String SERVICE_ID_KEY
Public Methods
JiraServiceContainer addService(String name, String className, long delay)
This method is deprecated. Use addService(String, String, String) instead. Since v6.4.
JiraServiceContainer addService(String name, Class<? extends JiraService> serviceClass, String cronExpression)
This will add a service configuration to the JIRA DB and the service to the list of services which are running.
JiraServiceContainer addService(String name, Class<? extends JiraService> serviceClass, long delay, Map<String, String[]> params)
This method is deprecated. Use addService(String, Class, String, java.util.Map) instead. Since v6.4.
@Internal JiraServiceContainer addService(String name, Class<? extends JiraService> serviceClass, String cronExpression, long delay, Map<String, String[]> params)
This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.
JiraServiceContainer addService(String name, Class<? extends JiraService> serviceClass, long delay)
This method is deprecated. Use addService(String, String, String) instead. Since v6.4.
JiraServiceContainer addService(String name, Class<? extends JiraService> serviceClass, String cronExpression, Map<String, String[]> params)
This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.
JiraServiceContainer addService(String name, String className, String cronExpression, long delay, Map<String, String[]> params)
This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.
JiraServiceContainer addService(String name, String className, long delay, Map<String, String[]> params)
This method is deprecated. Use addService(String, String, String, java.util.Map) instead. Since v6.4.
JiraServiceContainer addService(String name, String className, String cronExpression, Map<String, String[]> params)
This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.
JiraServiceContainer addService(String name, String className, String cronExpression)
This will add a service configuration to the JIRA DB and the service to the list of services which are running.
boolean containsServiceWithId(Long id)
Quick way of telling whether a service with a specific id is registered or not.
void editService(Long id, long delay, Map<String, String[]> params)
This method is deprecated. Use editService(Long, String, java.util.Map) instead. Since v6.4.
void editService(Long id, String cronExpression, Map<String, String[]> params)
This will update the service if a service with this id can be found.
void editServiceByName(String name, String cronExpression, Map<String, String[]> params)
This will update the service if a service by this name can be found.
void editServiceByName(String name, long delay, Map<String, String[]> params)
This method is deprecated. Use editServiceByName(String, String, java.util.Map) instead. Since v6.4.
ServiceManager.ServiceScheduleSkipper getScheduleSkipper()
This method is deprecated. v6.2 This is no longer used. Just call runNow(long)
@Nullable JiraServiceContainer getServiceWithId(Long id)
This will return a JiraServiceContainer for the provided id if one is registered otherwise it will return null.
@Nullable JiraServiceContainer getServiceWithName(String name)
This will return a JiraServiceContainer for the provided name if one is registered, otherwise this will return null.
Collection<JiraServiceContainer> getServices()
This gets all currently registered services with JIRA.
Iterable<JiraServiceContainer> getServicesForExecution(long currentTime)
This method is deprecated. since v6.2 This is going away, it was always only meant for internal use.
Iterable<JiraServiceContainer> getServicesManageableBy(ApplicationUser user)
Gets the services that can be managed by an specific user.
void refreshAll()
This will force a complete re-sync of the service cache with the values stored in the db.
void refreshService(Long id)
This will update the in-memory cache with the values from the db for the service with the id if it can be resolved.
void refreshServiceByName(String name)
This will update the in-memory cache with the values from the db for the named service if it can be resolved.
void removeService(Long id)
This will remove a service from the db and cache and it will try to resolve the service by id.
void removeServiceByName(String name)
This will remove a service from the db and cache and it will try to resolve the service by name.
void runNow(long serviceId)
Runs the service immediately.

Fields

public static final String SERVICE_ID_KEY

Public Methods

public JiraServiceContainer addService (String name, String className, long delay)

This method is deprecated.
Use addService(String, String, String) instead. Since v6.4.

This will add a service configuration to the JIRA DB and the service to the list of services which are running.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
className the class defining the service
delay how often the service should run in milliseconds
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
ClassNotFoundException If the className could not be resolved.
See Also

public JiraServiceContainer addService (String name, Class<? extends JiraService> serviceClass, String cronExpression)

This will add a service configuration to the JIRA DB and the service to the list of services which are running.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
serviceClass the class defining the service
cronExpression how the service should be scheduled
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
See Also

public JiraServiceContainer addService (String name, Class<? extends JiraService> serviceClass, long delay, Map<String, String[]> params)

This method is deprecated.
Use addService(String, Class, String, java.util.Map) instead. Since v6.4.

This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
serviceClass the class defining the service
delay how often the service should run in milliseconds
params Additional params to specify for the service
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
See Also

@Internal public JiraServiceContainer addService (String name, Class<? extends JiraService> serviceClass, String cronExpression, long delay, Map<String, String[]> params)

@Internal

This method is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
serviceClass the class defining the service
cronExpression how the service should be scheduled
delay How often the service should run in milliseconds. This is not used, but the value will be retained and will be used in place of the cron expression if the instance is downgraded to a JIRA version prior to 6.4.
params Additional params to specify for the service
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
See Also

public JiraServiceContainer addService (String name, Class<? extends JiraService> serviceClass, long delay)

This method is deprecated.
Use addService(String, String, String) instead. Since v6.4.

This will add a service configuration to the JIRA DB and the service to the list of services which are running.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
serviceClass the class defining the service
delay how often the service should run in milliseconds
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
See Also

public JiraServiceContainer addService (String name, Class<? extends JiraService> serviceClass, String cronExpression, Map<String, String[]> params)

This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
serviceClass the class defining the service
cronExpression how the service should be scheduled
params Additional params to specify for the service
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
See Also

public JiraServiceContainer addService (String name, String className, String cronExpression, long delay, Map<String, String[]> params)

This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
className the class defining the service
cronExpression how the service should be scheduled
delay How often the service should run in milliseconds. This is not used, but the value will be retained and will be used in place of the cron expression if the instance is downgraded to a JIRA version prior to 6.4.
params Additional params to specify for the service
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
ClassNotFoundException If the className could not be resolved.
See Also

public JiraServiceContainer addService (String name, String className, long delay, Map<String, String[]> params)

This method is deprecated.
Use addService(String, String, String, java.util.Map) instead. Since v6.4.

This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
className the class defining the service
delay how often the service should run in milliseconds
params Additional params to specify for the service
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
ClassNotFoundException If the className could not be resolved.
See Also

public JiraServiceContainer addService (String name, String className, String cronExpression, Map<String, String[]> params)

This will add a service configuration to the JIRA DB and the service to the list of services which are running with an optional list of params.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
className the class defining the service
cronExpression how the service should be scheduled
params Additional params to specify for the service
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
ClassNotFoundException If the className could not be resolved.
See Also

public JiraServiceContainer addService (String name, String className, String cronExpression)

This will add a service configuration to the JIRA DB and the service to the list of services which are running.

It is preferred to pass the actual Class rather than the class name when adding services to JIRA from plugins, because it avoids possible ClassLoader issues. See http://jira.atlassian.com/browse/JRA-18578.

Parameters
name the key this service is to be known by
className the class defining the service
cronExpression how the service should be scheduled
Returns
  • the JiraServiceContainer that was just created
Throws
ServiceException If there is an error creating the Service.
ClassNotFoundException If the className could not be resolved.
See Also

public boolean containsServiceWithId (Long id)

Quick way of telling whether a service with a specific id is registered or not.

Parameters
id service id
Returns
  • true if the service with the id is registered

public void editService (Long id, long delay, Map<String, String[]> params)

This method is deprecated.
Use editService(Long, String, java.util.Map) instead. Since v6.4.

This will update the service if a service with this id can be found. The delay and the params will be updated.

Parameters
id the id of the service to find.
delay the delay to set on the service in milliseconds
params the params to set on the service
Throws
Exception if there is a problem updating the value

public void editService (Long id, String cronExpression, Map<String, String[]> params)

This will update the service if a service with this id can be found. The cronExpression and the params will be updated.

Parameters
id the id of the service to find.
cronExpression how the service should be scheduled
params the params to set on the service
Throws
Exception if there is a problem updating the value

public void editServiceByName (String name, String cronExpression, Map<String, String[]> params)

This will update the service if a service by this name can be found. The cronExpression and the params will be updated.

Parameters
name the name of the service to find.
cronExpression how the service should be scheduled
params the params to set on the service
Throws
IllegalArgumentException if the name can not be resolved
Exception

public void editServiceByName (String name, long delay, Map<String, String[]> params)

This method is deprecated.
Use editServiceByName(String, String, java.util.Map) instead. Since v6.4.

This will update the service if a service by this name can be found. The delay and the params will be updated.

Parameters
name the name of the service to find.
delay the delay to set on the service in milliseconds
params the params to set on the service
Throws
IllegalArgumentException if the name can not be resolved
Exception

public ServiceManager.ServiceScheduleSkipper getScheduleSkipper ()

This method is deprecated.
v6.2 This is no longer used. Just call runNow(long)

Returns the service schedule skipper.

Returns
  • service schedule skipper

@Nullable public JiraServiceContainer getServiceWithId (Long id)

This will return a JiraServiceContainer for the provided id if one is registered otherwise it will return null.

Parameters
id service id
Returns
  • a JiraServiceContainer that is represented by the unique id.
Throws
Exception if there is a problem looking up the value in the db.

@Nullable public JiraServiceContainer getServiceWithName (String name)

This will return a JiraServiceContainer for the provided name if one is registered, otherwise this will return null.

Parameters
name the name of the JiraServiceContainer
Returns
  • a JiraServiceContainer if it is registered otherwise null
Throws
Exception if there is a problem looking up the value in the db.

public Collection<JiraServiceContainer> getServices ()

This gets all currently registered services with JIRA. This is an unmodifiable Collections that is returned, modifications to the services map will be made as a side-effect of calling the edit/refresh/add/remove methods of this manager.

Returns
  • an unmodifiable Collection with JiraServiceContainers as the value

public Iterable<JiraServiceContainer> getServicesForExecution (long currentTime)

This method is deprecated.
since v6.2 This is going away, it was always only meant for internal use.

Gets the services that are ready for execution at a particular time.

Parameters
currentTime the time to check for due services.
Returns
  • an immutable collection of services.

public Iterable<JiraServiceContainer> getServicesManageableBy (ApplicationUser user)

Gets the services that can be managed by an specific user.

Parameters
user The user in play.
Returns
  • A collection of services.

public void refreshAll ()

This will force a complete re-sync of the service cache with the values stored in the db.

public void refreshService (Long id)

This will update the in-memory cache with the values from the db for the service with the id if it can be resolved.

Parameters
id the id of the service to find.
Throws
Exception if the value can not be refreshed

public void refreshServiceByName (String name)

This will update the in-memory cache with the values from the db for the named service if it can be resolved.

Parameters
name the name of the service to find.
Throws
IllegalArgumentException if the name can not be resolved
Exception

public void removeService (Long id)

This will remove a service from the db and cache and it will try to resolve the service by id.

Parameters
id the id of the service to find.
Throws
Exception if there is a problem removing the service

public void removeServiceByName (String name)

This will remove a service from the db and cache and it will try to resolve the service by name.

Parameters
name the name of the service to find.
Throws
IllegalArgumentException if the name can not be resolved
Exception

public void runNow (long serviceId)

Runs the service immediately. This call returns once the job is submitted. It does not wait for the service to complete. In a clustered environment the service may run on any node in the cluster.

Throws
Exception