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 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_STORE_CONNECTOR
AUDIT_LOG
COHORT_MANAGER
COHORT_REGISTRY
ENTERPRISE_CONNECTOR_MANAGER
ENTERPRISE_REPOSITORY_CONNECTOR
ENTERPRISE_TOPIC_LISTENER
EVENT_LISTENER
EVENT_PUBLISHER
GOVERNANCE_ACTION_SERVICE_CONNECTOR
INSTANCE_EVENT_PROCESSOR
INTEGRATION_CONNECTOR
LOCAL_REPOSITORY_CONNECTOR
LOCAL_REPOSITORY_EVENT_MAPPER
METADATA_HIGHWAY_MANAGER
OMAS_IN_TOPIC
OMAS_OUT_TOPIC
OMRS_TOPIC_CONNECTOR
OPEN_DISCOVERY_SERVICE_CONNECTOR
OPEN_METADATA_TOPIC_CONNECTOR
OPERATIONAL_SERVICES
PLATFORM_SECURITY_CONNECTOR
REGISTRY_STORE
REMOTE_REPOSITORY_CONNECTOR
REPOSITORY_CONNECTOR
REPOSITORY_CONTENT_MANAGER
REPOSITORY_EVENT_MANAGER
REPOSITORY_GOVERNANCE_SERVICE_CONNECTOR
REST_REPOSITORY_CONNECTOR
REST_SERVICES
SERVER_SECURITY_CONNECTOR
UNKNOWN

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

AUDIT_LOG

public static final OMRSAuditingComponent AUDIT_LOG

OPERATIONAL_SERVICES

public static final OMRSAuditingComponent OPERATIONAL_SERVICES

ARCHIVE_MANAGER

public static final OMRSAuditingComponent ARCHIVE_MANAGER

ENTERPRISE_CONNECTOR_MANAGER

public static final OMRSAuditingComponent ENTERPRISE_CONNECTOR_MANAGER

ENTERPRISE_REPOSITORY_CONNECTOR

public static final OMRSAuditingComponent ENTERPRISE_REPOSITORY_CONNECTOR

LOCAL_REPOSITORY_CONNECTOR

public static final OMRSAuditingComponent LOCAL_REPOSITORY_CONNECTOR

REPOSITORY_CONTENT_MANAGER

public static final OMRSAuditingComponent REPOSITORY_CONTENT_MANAGER

INSTANCE_EVENT_PROCESSOR

public static final OMRSAuditingComponent INSTANCE_EVENT_PROCESSOR

REPOSITORY_EVENT_MANAGER

public static final OMRSAuditingComponent REPOSITORY_EVENT_MANAGER

REST_SERVICES

public static final OMRSAuditingComponent REST_SERVICES

REST_REPOSITORY_CONNECTOR

public static final OMRSAuditingComponent REST_REPOSITORY_CONNECTOR

METADATA_HIGHWAY_MANAGER

public static final OMRSAuditingComponent METADATA_HIGHWAY_MANAGER

COHORT_MANAGER

public static final OMRSAuditingComponent COHORT_MANAGER

COHORT_REGISTRY

public static final OMRSAuditingComponent COHORT_REGISTRY

REGISTRY_STORE

public static final OMRSAuditingComponent REGISTRY_STORE

EVENT_PUBLISHER

public static final OMRSAuditingComponent EVENT_PUBLISHER

EVENT_LISTENER

public static final OMRSAuditingComponent EVENT_LISTENER

OMRS_TOPIC_CONNECTOR

public static final OMRSAuditingComponent OMRS_TOPIC_CONNECTOR

OPEN_METADATA_TOPIC_CONNECTOR

public static final OMRSAuditingComponent OPEN_METADATA_TOPIC_CONNECTOR

LOCAL_REPOSITORY_EVENT_MAPPER

public static final OMRSAuditingComponent LOCAL_REPOSITORY_EVENT_MAPPER

ARCHIVE_STORE_CONNECTOR

public static final OMRSAuditingComponent ARCHIVE_STORE_CONNECTOR

REMOTE_REPOSITORY_CONNECTOR

public static final OMRSAuditingComponent REMOTE_REPOSITORY_CONNECTOR

OMAS_OUT_TOPIC

public static final OMRSAuditingComponent OMAS_OUT_TOPIC

OMAS_IN_TOPIC

public static final OMRSAuditingComponent OMAS_IN_TOPIC

ENTERPRISE_TOPIC_LISTENER

public static final OMRSAuditingComponent ENTERPRISE_TOPIC_LISTENER

REPOSITORY_CONNECTOR

public static final OMRSAuditingComponent REPOSITORY_CONNECTOR

OPEN_DISCOVERY_SERVICE_CONNECTOR

public static final OMRSAuditingComponent OPEN_DISCOVERY_SERVICE_CONNECTOR

GOVERNANCE_ACTION_SERVICE_CONNECTOR

public static final OMRSAuditingComponent GOVERNANCE_ACTION_SERVICE_CONNECTOR

REPOSITORY_GOVERNANCE_SERVICE_CONNECTOR

public static final OMRSAuditingComponent REPOSITORY_GOVERNANCE_SERVICE_CONNECTOR

INTEGRATION_CONNECTOR

public static final OMRSAuditingComponent INTEGRATION_CONNECTOR

PLATFORM_SECURITY_CONNECTOR

public static final OMRSAuditingComponent PLATFORM_SECURITY_CONNECTOR

SERVER_SECURITY_CONNECTOR

public static final OMRSAuditingComponent SERVER_SECURITY_CONNECTOR

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