Enum Class ServiceScope

java.lang.Object
java.lang.Enum<ServiceScope>
jadex.providedservice.ServiceScope
All Implemented Interfaces:
Serializable, Comparable<ServiceScope>, Constable

public enum ServiceScope extends Enum<ServiceScope>
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 Constants
    Enum Constant
    Description
    Available 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

    Fields
    Modifier and Type
    Field
    Description
    static 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 Type
    Method
    Description
    Get the enum per string.
    boolean
    Check if the scope is global.
    boolean
    Check if the scope not remote.
    boolean
    Check if the scope is a network scope.
    Returns the enum constant of this class with the specified name.
    static ServiceScope[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • DEFAULT

      public static final ServiceScope 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

      public static final ServiceScope 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

      public static final ServiceScope NONE
      None component scope (nothing will be searched, forces required service creation).
    • PARENT

      public static final ServiceScope PARENT
      Available in immediate parent and all direct and indirect subcomponents.
    • COMPONENT_ONLY

      public static final ServiceScope COMPONENT_ONLY
      Available in component itself.
    • COMPONENT

      public static final ServiceScope COMPONENT
      Available in component and all direct and indirect subcomponents.
    • APPLICATION

      public static final ServiceScope APPLICATION
      Available in local application, i.e. second level component plus direct and indirect subcomponents.
    • PLATFORM

      public static final ServiceScope PLATFORM
      Available in all components on the local platform.
    • APPLICATION_NETWORK

      public static final ServiceScope APPLICATION_NETWORK
      Application network scope (any platform with which a secret is shared and application tag must be shared).
    • NETWORK

      public static final ServiceScope NETWORK
      Network scope (any platform with which a secret is shared).
    • APPLICATION_GLOBAL

      public static final ServiceScope APPLICATION_GLOBAL
      Global application scope.
    • GLOBAL

      public static final ServiceScope GLOBAL
      Global scope (any reachable platform including those with unrestricted services).
  • Field Details

    • LOCAL_SCOPES

      public static final Set<ServiceScope> LOCAL_SCOPES
      The scopes local to a platform.
    • GLOBAL_SCOPES

      public static final Set<ServiceScope> GLOBAL_SCOPES
      The global scopes.
    • NETWORK_SCOPES

      public static final Set<ServiceScope> NETWORK_SCOPES
      The network scopes.
  • Method Details

    • values

      public static ServiceScope[] 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

      public static ServiceScope valueOf(String name)
      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 name
      NullPointerException - 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

      public static ServiceScope getEnum(String val)
      Get the enum per string.
      Parameters:
      val - The value.
      Returns:
      The enum or null.