Package jadex.bridge.service

Enum ServiceScope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ServiceScope>
    public enum ServiceScope
extends java.lang.Enum<ServiceScope>
    Scopes for service publication (provided) and search (e.g. required).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      APPLICATION
      Available in local application, i.e.
      APPLICATION_GLOBAL
      Global application scope.
      APPLICATION_NETWORK
      Application network scope (any platform with which a secret is shared and application tag must be shared).
      COMPONENT
      Available in component and all direct and indirect subcomponents.
      COMPONENT_ONLY
      Available in component itself.
      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.
      GLOBAL
      Global scope (any reachable platform including those with unrestricted services).
      NETWORK
      Network scope (any platform with which a secret is shared).
      NONE
      None component scope (nothing will be searched, forces required service creation).
      PARENT
      Available in immediate parent and all direct and indirect subcomponents.
      PLATFORM
      Available in all components on the local platform.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ServiceScope getEnum​(java.lang.String val)
      Get the enum per string.
      boolean isGlobal()
      Check if the scope is global.
      boolean isLocal()
      Check if the scope not remote.
      boolean isNetwork()
      Check if the scope is a network scope.
      static ServiceScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ServiceScope[] 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

      • 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 Detail

      • LOCAL_SCOPES

        public static final java.util.Set<ServiceScope> LOCAL_SCOPES
        The scopes local to a platform.

      • GLOBAL_SCOPES

        public static final java.util.Set<ServiceScope> GLOBAL_SCOPES
        The global scopes.

      • NETWORK_SCOPES

        public static final java.util.Set<ServiceScope> NETWORK_SCOPES
        The network scopes.

    • Method Detail

      • values

        public static ServiceScope[] 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 (ServiceScope c : ServiceScope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ServiceScope valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.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​(java.lang.String val)
        Get the enum per string.
        Parameters:
        val - The value.
        Returns:
        The enum or null.