com.atlassian.jira.component.pico.osgi

Enum OsgiServiceScope

java.lang.Object

java.lang.Enum<OsgiServiceScope>

com.atlassian.jira.component.pico.osgi.OsgiServiceScope

All Implemented Interfaces:

Serializable, Comparable<OsgiServiceScope>

public enum OsgiServiceScope
extends Enum<OsgiServiceScope>

The visibility of a Jira component as an OSGi service (for consumption by plugins).

Since:

8.0 was previously in ComponentManager

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTERNAL Components with this scope are not published as OSGi services.
PROVIDED Components with this scope are published as OSGi services that plugins can import.

Method Summary

Modifier and Type	Method and Description
void	registerService(Class<?> componentInterface, OsgiServiceRegistry registry) Registers the given component interface with the given registry.
void	registerService(Class<?> componentInterface, OsgiServiceRegistry registry, boolean trackBundle) Registers the given component interface with the given registry.
static OsgiServiceScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static OsgiServiceScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PROVIDED

public static final OsgiServiceScope PROVIDED

Components with this scope are published as OSGi services that plugins can import.

INTERNAL

public static final OsgiServiceScope INTERNAL

Components with this scope are not published as OSGi services.

Method Detail

values

public static OsgiServiceScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OsgiServiceScope c : OsgiServiceScope.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OsgiServiceScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

registerService

public void registerService(Class<?> componentInterface,
                            OsgiServiceRegistry registry)

Registers the given component interface with the given registry. By default, this is a no-op.

Parameters:

componentInterface - the interface to register

registry - the target registry

registerService

public void registerService(Class<?> componentInterface,
                            OsgiServiceRegistry registry,
                            boolean trackBundle)

Registers the given component interface with the given registry. By default, this is a no-op.

Parameters:

componentInterface - the interface to register

registry - the target registry

trackBundle - sets whether bundle tracking is enabled