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

Enum Class AccessServiceDescription

java.lang.Object

java.lang.Enum<AccessServiceDescription>

org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription

All Implemented Interfaces:

Serializable, Comparable<AccessServiceDescription>, Constable

public enum AccessServiceDescription
extends Enum<AccessServiceDescription>
implements Serializable

AccessServiceDescription provides a list of registered OMAS services.

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
GAF_METADATA_MANAGEMENT	Support governance action services.
OCF_METADATA_MANAGEMENT	Common metadata services for the Open Connector Framework (OCF).
OIF_METADATA_MANAGEMENT	Provides operational support for the integration connectors.
OMF_METADATA_MANAGEMENT	Provides generic open metadata retrieval and management services for the Open Frameworks and Open Metadata Access Services (OMASs).

Method Summary

Modifier and Type	Method	Description
ServiceOperationalStatus	getOutTopicStatus()	Return the status of the services' out topic.
String	getServerType()	Return the name of the type of server where this service resides.
int	getServiceCode()	Return the code for this enum instance
String	getServiceDescription()	Return the default description for the type for this enum instance.
ComponentDevelopmentStatus	getServiceDevelopmentStatus()	Return the development status of the component.
String	getServiceName()	Return the default name for this enum instance.
String	getServiceURLMarker()	Return the string that appears in the REST API URL that identifies the owning service.
String	getServiceWiki()	Return the URL for the wiki page describing this access service.
static AccessServiceDescription	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AccessServiceDescription[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OCF_METADATA_MANAGEMENT

public static final AccessServiceDescription OCF_METADATA_MANAGEMENT

Common metadata services for the Open Connector Framework (OCF).

GAF_METADATA_MANAGEMENT

public static final AccessServiceDescription GAF_METADATA_MANAGEMENT

Support governance action services.

OIF_METADATA_MANAGEMENT

public static final AccessServiceDescription OIF_METADATA_MANAGEMENT

Provides operational support for the integration connectors.

OMF_METADATA_MANAGEMENT

public static final AccessServiceDescription OMF_METADATA_MANAGEMENT

Provides generic open metadata retrieval and management services for the Open Frameworks and Open Metadata Access Services (OMASs).

Method Details

values

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

getOutTopicStatus

public ServiceOperationalStatus getOutTopicStatus()

Return the status of the services' out topic.

Returns:

not-implemented, enabled, disabled