Package jadex.providedservice
Enum Class ServiceScope
- All Implemented Interfaces:
Serializable
,Comparable<ServiceScope>
,Constable
Scopes for service publication (provided) and search (e.g. required).
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAvailable in local application, i.e.Global application scope.Application network scope (any platform with which a secret is shared and application tag must be shared).Available in component and all direct and indirect subcomponents.Available in component itself.Marker for default scope to be replaced automatically according to context; for required services (search scope): the default scope is 'platform' for system services and 'application' for non-system services, for provided services (publication scope): the default scope is always platform.Marker for using a separate expression in required/provided service annotations.Global scope (any reachable platform including those with unrestricted services).Network scope (any platform with which a secret is shared).None component scope (nothing will be searched, forces required service creation).Available in immediate parent and all direct and indirect subcomponents.Available in all components on the local platform. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Set
<ServiceScope> The global scopes.static final Set
<ServiceScope> The scopes local to a platform.static final Set
<ServiceScope> The network scopes. -
Method Summary
Modifier and TypeMethodDescriptionstatic ServiceScope
Get the enum per string.boolean
isGlobal()
Check if the scope is global.boolean
isLocal()
Check if the scope not remote.boolean
Check if the scope is a network scope.static ServiceScope
Returns the enum constant of this class with the specified name.static ServiceScope[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
DEFAULT
Marker for default scope to be replaced automatically according to context; for required services (search scope): the default scope is 'platform' for system services and 'application' for non-system services, for provided services (publication scope): the default scope is always platform. -
EXPRESSION
Marker for using a separate expression in required/provided service annotations. This scope can not be used at runtime, e.g. for service queries. Concrete scope expression is given in further scopeexpression attribute. -
NONE
None component scope (nothing will be searched, forces required service creation). -
PARENT
Available in immediate parent and all direct and indirect subcomponents. -
COMPONENT_ONLY
Available in component itself. -
COMPONENT
Available in component and all direct and indirect subcomponents. -
APPLICATION
Available in local application, i.e. second level component plus direct and indirect subcomponents. -
PLATFORM
Available in all components on the local platform. -
APPLICATION_NETWORK
Application network scope (any platform with which a secret is shared and application tag must be shared). -
NETWORK
Network scope (any platform with which a secret is shared). -
APPLICATION_GLOBAL
Global application scope. -
GLOBAL
Global scope (any reachable platform including those with unrestricted services).
-
-
Field Details
-
LOCAL_SCOPES
The scopes local to a platform. -
GLOBAL_SCOPES
The global scopes. -
NETWORK_SCOPES
The network scopes.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
isLocal
public boolean isLocal()Check if the scope not remote.- Returns:
- True, scope on the local platform.
-
isGlobal
public boolean isGlobal()Check if the scope is global. -
isNetwork
public boolean isNetwork()Check if the scope is a network scope. -
getEnum
Get the enum per string.- Parameters:
val
- The value.- Returns:
- The enum or null.
-