Package org.odpi.openmetadata.adminservices.configuration.registration

Enum Class CommonServicesDescription

java.lang.Object
java.lang.Enum<CommonServicesDescription>
org.odpi.openmetadata.adminservices.configuration.registration.CommonServicesDescription
All Implemented Interfaces:
Serializable, Comparable<CommonServicesDescription>, Constable
public enum CommonServicesDescription extends Enum<CommonServicesDescription> implements Serializable
CommonServicesDescription provides a list of fixed services that support the platform.

  • Enum Constant Details

    • REPOSITORY_SERVICES

      public static final CommonServicesDescription REPOSITORY_SERVICES
      Manages the synchronization, retrieval and maintenance of metadata stored in open metadata repositories.

    • ADMINISTRATION_SERVICES

      public static final CommonServicesDescription ADMINISTRATION_SERVICES
      Configuration of services for an Open Metadata and Governance server (OMAG Server).

    • OCF_METADATA_MANAGEMENT

      public static final CommonServicesDescription OCF_METADATA_MANAGEMENT
      Common metadata services for the Open Connector Framework (OCF).

    • OPEN_METADATA_SECURITY

      public static final CommonServicesDescription OPEN_METADATA_SECURITY
      Authorization services for Open Metadata and Governance

    • GAF_METADATA_MANAGEMENT

      public static final CommonServicesDescription GAF_METADATA_MANAGEMENT
      Support governance action services.

    • PLATFORM_SERVICES

      public static final CommonServicesDescription PLATFORM_SERVICES
      Provides information about the registered services and connectors available in an OMAG Server Platform along with services to control and query information about the OMAG Servers running on the platform.

    • OIF_METADATA_MANAGEMENT

      public static final CommonServicesDescription OIF_METADATA_MANAGEMENT
      Provides operational support for the integration connectors.

    • SERVER_OPERATIONS

      public static final CommonServicesDescription SERVER_OPERATIONS
      Supports the startup and shutdown of OMAG Servers.

    • OPEN_METADATA_STORE

      public static final CommonServicesDescription OPEN_METADATA_STORE
      Provides generic open metadata retrieval and management services for the Open Frameworks and Open Metadata Access Services (OMASs).

  • Method Details

    • values

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

    • getServiceCode

      public int getServiceCode()
      Return the code for this enum instance
      Returns:
      int type code

    • getServiceDevelopmentStatus

      public ComponentDevelopmentStatus getServiceDevelopmentStatus()
      Return the development status of the component.
      Returns:
      enum describing the status

    • getServiceName

      public String getServiceName()
      Return the default name for this enum instance.
      Returns:
      String default name

    • getServiceURLMarker

      public String getServiceURLMarker()
      Return the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.
      Returns:
      String default name

    • getServiceDescription

      public String getServiceDescription()
      Return the default description for the type for this enum instance.
      Returns:
      String default description

    • getServiceWiki

      public String getServiceWiki()
      Return the URL for the wiki page describing this access service.
      Returns:
      String URL for the wiki page

    • getServerType

      public String getServerType()
      Return the name of the type of server where this service resides.
      Returns:
      server type name

    • getPartnerServiceName

      public String getPartnerServiceName()
      Return the name of a service called in a remote server (if any).
      Returns:
      name of service

    • getPartnerServerType

      public String getPartnerServerType()
      Return the type of server where the partner service resides.
      Returns:
      name of type of server