Package org.odpi.openmetadata.repositoryservices.auditlog

Enum Class OMRSAuditingComponent

java.lang.Object
java.lang.Enum<OMRSAuditingComponent>
org.odpi.openmetadata.repositoryservices.auditlog.OMRSAuditingComponent
All Implemented Interfaces:
Serializable, Comparable<OMRSAuditingComponent>, Constable, ComponentDescription
public enum OMRSAuditingComponent extends Enum<OMRSAuditingComponent> implements ComponentDescription
OMRSAuditingComponent provides identifying and background information about the many of the core components writing log records to the OMRS Audit log. This is to help a consumer understand the OMRS Audit Log records.

  • 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
    ARCHIVE_MANAGER
    Archive Manager - Supports the platform services for the Open Metadata Repository Services (OMRS).
    ARCHIVE_STORE_CONNECTOR
    Open Metadata Archive Store Connector - Reads and writes open metadata types and instances to an open metadata archive.
    AUDIT_LOG
    Audit Log - Reads and writes records to the Open Metadata Repository Services (OMRS) audit log.
    COHORT_MANAGER
    Cohort Manager - Manages the initialization and shutdown of the server's connectivity to a cohort.
    COHORT_REGISTRY
    Cohort Registry - Manages the registration requests send and received from this local repository.
    ENTERPRISE_CONNECTOR_MANAGER
    Enterprise Connector Manager - Manages the list of open metadata repositories that the Enterprise OMRS Repository Connector should call to retrieve an enterprise view of the metadata collections supported by these repositories.
    ENTERPRISE_REPOSITORY_CONNECTOR
    Enterprise Repository Connector - Supports enterprise access to the list of open metadata repositories registered with the OMRS Enterprise Connector Manager.
    ENTERPRISE_TOPIC_LISTENER
    Enterprise Topic Listener - Receives events from the open metadata repository cohorts that this server is registered with and distributes them to the Open Metadata Access Services (OMASs).
    EVENT_LISTENER
    Event Listener - Manages the receipt of incoming OMRS events.
    EVENT_PUBLISHER
    Event Publisher - Manages the publishing of events that this repository sends to the OMRS topic.
    GOVERNANCE_ACTION_SERVICE_CONNECTOR
    Governance Action Service Connector - A connector that coordinates governance of digital resources and metadata.
    INSTANCE_EVENT_PROCESSOR
    Local Inbound Instance Event Processor - Supports the loading of reference metadata into the local repository that has come from other members of the local server's cohorts and open metadata archives.
    INTEGRATION_CONNECTOR
    Integration Connector - Connector that manages metadata exchange with a third-party technology.
    LOCAL_REPOSITORY_CONNECTOR
    Local Repository Connector - Supports access to metadata stored in the local server's repository and ensures repository events are generated when metadata changes in the local repository.
    LOCAL_REPOSITORY_EVENT_MAPPER
    Local Repository Event Mapper Connector - Provides access to an event bus to process events from a specific local repository.
    METADATA_HIGHWAY_MANAGER
    Metadata Highway Manager - Manages the initialization and shutdown of the components that connector to each of the cohorts that the local server is a member of.
    OMAS_IN_TOPIC
    Open Metadata Access Service (OMAS) In Topic - Receives events from external servers and tools directed at a specific access service.
    OMAS_OUT_TOPIC
    Open Metadata Access Service (OMAS) Out Topic - Publishes events from a specific access service.
    OMRS_TOPIC_CONNECTOR
    OMRS Topic Connector - Provides access to the OMRS Topic that is used to exchange events between members of a cohort, or to notify Open Metadata Access Services (OMASs) of changes to metadata in the enterprise.
    OPEN_DISCOVERY_SERVICE_CONNECTOR
    Open Discovery Service Connector - A connector that analyzing the contents of a digital resource.
    OPEN_METADATA_TOPIC_CONNECTOR
    Open Metadata Topic Connector - Provides access to an event bus to exchange events with participants in the open metadata ecosystem.
    OPERATIONAL_SERVICES
    Operational Services - Supports the administration services for the Open Metadata Repository Services (OMRS).
    PLATFORM_SECURITY_CONNECTOR
    Platform Metadata Security Connector - Connector that manages authorization requests to the OMAG Server Platform.
    REGISTRY_STORE
    Registry Store - Stores information about the repositories registered in the open metadata repository cohort.
    REMOTE_REPOSITORY_CONNECTOR
    Cohort Member Client Open Metadata Repository Connector - Provides access to open metadata located in a remote repository for remote members of a cohort.
    REPOSITORY_CONNECTOR
    OMRS Repository Connector - Maps open metadata calls to a metadata repository.
    REPOSITORY_CONTENT_MANAGER
    Repository Content Manager - Supports an in-memory cache for open metadata type definitions (TypeDefs) used for verifying TypeDefs in use in other open metadata repositories and for constructing new metadata instances.
    REPOSITORY_EVENT_MANAGER
    Repository Event Manager - Distribute repository events (TypeDefs, Entity and Instance events) between internal OMRS components within a server.
    REPOSITORY_GOVERNANCE_SERVICE_CONNECTOR
    Repository Governance Service Connector - A connector that dynamically governs the activity of the open metadata repositories.
    REST_REPOSITORY_CONNECTOR
    REST Repository Connector - Supports an OMRS Repository Connector for calling the OMRS Repository REST API in a remote open metadata repository.
    REST_SERVICES
    Repository REST Services - Provides the server-side support of the OMRS Repository Services REST API.
    SERVER_SECURITY_CONNECTOR
    Server Metadata Security Connector - Connector that manages authorization requests to the OMAG Server.
    UNKNOWN
    Unknown - Uninitialized component name

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getComponentDescription()
    Return the short description of the component.
    ComponentDevelopmentStatus
    getComponentDevelopmentStatus()
    Return the development status of the component.
    int
    getComponentId()
    Return the numerical code for this component.
    String
    getComponentName()
    Return the name of the component.
    String
    getComponentWikiURL()
    URL to the wiki page that describes this component.
    String
    toString()
    toString, JSON-style
    static OMRSAuditingComponent
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OMRSAuditingComponent[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final OMRSAuditingComponent UNKNOWN
      Unknown - Uninitialized component name

    • AUDIT_LOG

      public static final OMRSAuditingComponent AUDIT_LOG
      Audit Log - Reads and writes records to the Open Metadata Repository Services (OMRS) audit log.

    • OPERATIONAL_SERVICES

      public static final OMRSAuditingComponent OPERATIONAL_SERVICES
      Operational Services - Supports the administration services for the Open Metadata Repository Services (OMRS).

    • ARCHIVE_MANAGER

      public static final OMRSAuditingComponent ARCHIVE_MANAGER
      Archive Manager - Supports the platform services for the Open Metadata Repository Services (OMRS).

    • ENTERPRISE_CONNECTOR_MANAGER

      public static final OMRSAuditingComponent ENTERPRISE_CONNECTOR_MANAGER
      Enterprise Connector Manager - Manages the list of open metadata repositories that the Enterprise OMRS Repository Connector should call to retrieve an enterprise view of the metadata collections supported by these repositories.

    • ENTERPRISE_REPOSITORY_CONNECTOR

      public static final OMRSAuditingComponent ENTERPRISE_REPOSITORY_CONNECTOR
      Enterprise Repository Connector - Supports enterprise access to the list of open metadata repositories registered with the OMRS Enterprise Connector Manager.

    • LOCAL_REPOSITORY_CONNECTOR

      public static final OMRSAuditingComponent LOCAL_REPOSITORY_CONNECTOR
      Local Repository Connector - Supports access to metadata stored in the local server's repository and ensures repository events are generated when metadata changes in the local repository.

    • REPOSITORY_CONTENT_MANAGER

      public static final OMRSAuditingComponent REPOSITORY_CONTENT_MANAGER
      Repository Content Manager - Supports an in-memory cache for open metadata type definitions (TypeDefs) used for verifying TypeDefs in use in other open metadata repositories and for constructing new metadata instances.

    • INSTANCE_EVENT_PROCESSOR

      public static final OMRSAuditingComponent INSTANCE_EVENT_PROCESSOR
      Local Inbound Instance Event Processor - Supports the loading of reference metadata into the local repository that has come from other members of the local server's cohorts and open metadata archives.

    • REPOSITORY_EVENT_MANAGER

      public static final OMRSAuditingComponent REPOSITORY_EVENT_MANAGER
      Repository Event Manager - Distribute repository events (TypeDefs, Entity and Instance events) between internal OMRS components within a server.

    • REST_SERVICES

      public static final OMRSAuditingComponent REST_SERVICES
      Repository REST Services - Provides the server-side support of the OMRS Repository Services REST API.

    • REST_REPOSITORY_CONNECTOR

      public static final OMRSAuditingComponent REST_REPOSITORY_CONNECTOR
      REST Repository Connector - Supports an OMRS Repository Connector for calling the OMRS Repository REST API in a remote open metadata repository.

    • METADATA_HIGHWAY_MANAGER

      public static final OMRSAuditingComponent METADATA_HIGHWAY_MANAGER
      Metadata Highway Manager - Manages the initialization and shutdown of the components that connector to each of the cohorts that the local server is a member of.

    • COHORT_MANAGER

      public static final OMRSAuditingComponent COHORT_MANAGER
      Cohort Manager - Manages the initialization and shutdown of the server's connectivity to a cohort.

    • COHORT_REGISTRY

      public static final OMRSAuditingComponent COHORT_REGISTRY
      Cohort Registry - Manages the registration requests send and received from this local repository.

    • REGISTRY_STORE

      public static final OMRSAuditingComponent REGISTRY_STORE
      Registry Store - Stores information about the repositories registered in the open metadata repository cohort.

    • EVENT_PUBLISHER

      public static final OMRSAuditingComponent EVENT_PUBLISHER
      Event Publisher - Manages the publishing of events that this repository sends to the OMRS topic.

    • EVENT_LISTENER

      public static final OMRSAuditingComponent EVENT_LISTENER
      Event Listener - Manages the receipt of incoming OMRS events.

    • OMRS_TOPIC_CONNECTOR

      public static final OMRSAuditingComponent OMRS_TOPIC_CONNECTOR
      OMRS Topic Connector - Provides access to the OMRS Topic that is used to exchange events between members of a cohort, or to notify Open Metadata Access Services (OMASs) of changes to metadata in the enterprise.

    • OPEN_METADATA_TOPIC_CONNECTOR

      public static final OMRSAuditingComponent OPEN_METADATA_TOPIC_CONNECTOR
      Open Metadata Topic Connector - Provides access to an event bus to exchange events with participants in the open metadata ecosystem.

    • LOCAL_REPOSITORY_EVENT_MAPPER

      public static final OMRSAuditingComponent LOCAL_REPOSITORY_EVENT_MAPPER
      Local Repository Event Mapper Connector - Provides access to an event bus to process events from a specific local repository.

    • ARCHIVE_STORE_CONNECTOR

      public static final OMRSAuditingComponent ARCHIVE_STORE_CONNECTOR
      Open Metadata Archive Store Connector - Reads and writes open metadata types and instances to an open metadata archive.

    • REMOTE_REPOSITORY_CONNECTOR

      public static final OMRSAuditingComponent REMOTE_REPOSITORY_CONNECTOR
      Cohort Member Client Open Metadata Repository Connector - Provides access to open metadata located in a remote repository for remote members of a cohort.

    • OMAS_OUT_TOPIC

      public static final OMRSAuditingComponent OMAS_OUT_TOPIC
      Open Metadata Access Service (OMAS) Out Topic - Publishes events from a specific access service.

    • OMAS_IN_TOPIC

      public static final OMRSAuditingComponent OMAS_IN_TOPIC
      Open Metadata Access Service (OMAS) In Topic - Receives events from external servers and tools directed at a specific access service.

    • ENTERPRISE_TOPIC_LISTENER

      public static final OMRSAuditingComponent ENTERPRISE_TOPIC_LISTENER
      Enterprise Topic Listener - Receives events from the open metadata repository cohorts that this server is registered with and distributes them to the Open Metadata Access Services (OMASs).

    • REPOSITORY_CONNECTOR

      public static final OMRSAuditingComponent REPOSITORY_CONNECTOR
      OMRS Repository Connector - Maps open metadata calls to a metadata repository.

    • OPEN_DISCOVERY_SERVICE_CONNECTOR

      public static final OMRSAuditingComponent OPEN_DISCOVERY_SERVICE_CONNECTOR
      Open Discovery Service Connector - A connector that analyzing the contents of a digital resource.

    • GOVERNANCE_ACTION_SERVICE_CONNECTOR

      public static final OMRSAuditingComponent GOVERNANCE_ACTION_SERVICE_CONNECTOR
      Governance Action Service Connector - A connector that coordinates governance of digital resources and metadata.

    • REPOSITORY_GOVERNANCE_SERVICE_CONNECTOR

      public static final OMRSAuditingComponent REPOSITORY_GOVERNANCE_SERVICE_CONNECTOR
      Repository Governance Service Connector - A connector that dynamically governs the activity of the open metadata repositories.

    • INTEGRATION_CONNECTOR

      public static final OMRSAuditingComponent INTEGRATION_CONNECTOR
      Integration Connector - Connector that manages metadata exchange with a third-party technology.

    • PLATFORM_SECURITY_CONNECTOR

      public static final OMRSAuditingComponent PLATFORM_SECURITY_CONNECTOR
      Platform Metadata Security Connector - Connector that manages authorization requests to the OMAG Server Platform.

    • SERVER_SECURITY_CONNECTOR

      public static final OMRSAuditingComponent SERVER_SECURITY_CONNECTOR
      Server Metadata Security Connector - Connector that manages authorization requests to the OMAG Server.

  • Method Details

    • values

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

    • getComponentId

      public int getComponentId()
      Return the numerical code for this component.
      Specified by:
      getComponentId in interface ComponentDescription
      Returns:
      int componentId

    • getComponentDevelopmentStatus

      public ComponentDevelopmentStatus getComponentDevelopmentStatus()
      Return the development status of the component.
      Specified by:
      getComponentDevelopmentStatus in interface ComponentDescription
      Returns:
      enum describing the status

    • getComponentName

      public String getComponentName()
      Return the name of the component. This is the name used in the audit log records.
      Specified by:
      getComponentName in interface ComponentDescription
      Returns:
      String component name

    • getComponentDescription

      public String getComponentDescription()
      Return the short description of the component. This is an English description. Natural language support for these values can be added to UIs using a resource bundle indexed with the component id. This value is provided as a default if the resource bundle is not available.
      Specified by:
      getComponentDescription in interface ComponentDescription
      Returns:
      String description

    • getComponentWikiURL

      public String getComponentWikiURL()
      URL to the wiki page that describes this component. This provides more information to the log reader on the operation of the component.
      Specified by:
      getComponentWikiURL in interface ComponentDescription
      Returns:
      String URL

    • toString

      public String toString()
      toString, JSON-style
      Overrides:
      toString in class Enum<OMRSAuditingComponent>
      Returns:
      string description