Package org.odpi.openmetadata.metadatasecurity.accessconnector.controls

Enum Class OpenMetadataSecurityConfigurationProperty

java.lang.Object

java.lang.Enum<OpenMetadataSecurityConfigurationProperty>

org.odpi.openmetadata.metadatasecurity.accessconnector.controls.OpenMetadataSecurityConfigurationProperty

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataSecurityConfigurationProperty>, Constable

public enum OpenMetadataSecurityConfigurationProperty
extends Enum<OpenMetadataSecurityConfigurationProperty>

OpenMetadataSecurityConfigurationProperty provides definitions for the configuration properties used with the Open Metadata Access Security connector.

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
ALL_USER_ZONES_GROUP	A list of governance zones where any defined user may read the member assets.
AUTOMATED_ZONES_GROUP	A list of governance zones where only automated processes may read or maintain the member assets.
DEFAULT_ZONE_MEMBERSHIP	Provide a comma-separated list of zone names that should be added to an Asset when it is created.
DYNAMIC_TYPE_AUTHOR_GROUP	Name of the list of users/roles that are permitted to modify the open metadata type definitions in a Metadata Access Server.
ELEMENT_GROUP_NAME_PATTERN	Provide a string pattern (for MessageFormat.format()) to convert an element's type {0}, qualified name {1} and the operation {2} into the group name to use to look up whether a user has access to the element.
EMPLOYEE_ONLY_ZONES_GROUP	A list of governance zones where defined user with an account type of EMPLOYEE may read or maintain the member assets.
INSTANCE_HEADER_AUTHOR_GROUP	Name of the list of users/roles that are permitted to modify the header information for an existing open metadata instance in the Open Metadata Ecosystem.
NOT_EXTERNAL_ZONES_GROUP	A list of governance zones where defined user with an account type of EMPLOYEE or CONTRACTOR may read the member assets.
OWNER_GROUP_NAME_PATTERN	Provide a string pattern (for MessageFormat.format()) to convert an owner's name {0}, type name {1} and property name {2} into the group name to use to look up whether a user is the owner of an element.
PERSONAL_ZONES_GROUP	A list of governance zones that only allow update and access to the creator of the member assets.
READABLE_ZONES_GROUP	A list of governance zones where all user have read access.
SERVER_ADMINISTRATOR_GROUP	Name of the list of users/roles that are permitted to configure OMAG servers using the OMAG Server Platform's administration services.
SERVER_GROUP_NAME_PATTERN	Provide a string pattern (for MessageFormat.format()) to convert a server name {0} into the group name to use to look up whether a user has access to a server's functions.
SERVER_INVESTIGATORS_GROUP	Name of the list of users/roles that are permitted to start and stop OMAG Servers on an OMAG Server Platform.
SERVER_OPERATORS_GROUP	Name of the list of users/roles that are permitted to start and stop OMAG Servers on an OMAG Server Platform.
SERVER_SERVICE_GROUP_NAME_PATTERN	Provide a string pattern (for MessageFormat.format()) Provide a string pattern (for MessageFormat.format()) to convert a server name {0} and service name {1} into the group name to use to look up whether a user has access to a specific server's service.
SERVER_SERVICE_OPERATION_GROUP_NAME_PATTERN	Provide a string pattern (for MessageFormat.format()) to convert a server name {0}, a service name {1} and an operation {2} into the group name to use to look up whether a user has access to a specific server's service operation (method).
STEWARDSHIP_ZONES_GROUP	A list of governance zones where only the owner of a member asset may read or maintain the asset.
VALIDATION_ZONES_GROUP	A list of governance zones that require a different user from the creator to move a member asset out of the zone.
ZONE_GROUP_NAME_PATTERN	Provide a string pattern (for MessageFormat.format()) to convert a governance zone name into the group name to use to look up whether a user has access to assets in the zone.

Field Summary

Fields

Modifier and Type	Field	Description
final String	dataType
final String	defaultValue
final String	description
final boolean	isPlaceholder
final String	name

Method Summary

Modifier and Type	Method	Description
ConfigurationPropertyType	getConfigurationPropertyType()	Return a summary of this enum to use in a connector provider.
static List<ConfigurationPropertyType>	getConfigurationPropertyTypes()	Retrieve all the defined configuration properties
String	getDataType()	Return the data type for the configuration property.
String	getDefaultValue()	Return an example of the configuration property to help users understand how to set it up.
String	getDescription()	Return the description of the configuration property.
String	getName()	Return the name of the request parameter.
static List<String>	getRecognizedConfigurationPropertyTypes()	Retrieve all the defined configuration properties
boolean	isPlaceholder()	Return whether this value is also used as a placeholder property.
String	toString()	Output of this enum class and main value.
static OpenMetadataSecurityConfigurationProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenMetadataSecurityConfigurationProperty[]	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

DEFAULT_ZONE_MEMBERSHIP

public static final OpenMetadataSecurityConfigurationProperty DEFAULT_ZONE_MEMBERSHIP

Provide a comma-separated list of zone names that should be added to an Asset when it is created.

SERVER_ADMINISTRATOR_GROUP

public static final OpenMetadataSecurityConfigurationProperty SERVER_ADMINISTRATOR_GROUP

Name of the list of users/roles that are permitted to configure OMAG servers using the OMAG Server Platform's administration services.

SERVER_OPERATORS_GROUP

public static final OpenMetadataSecurityConfigurationProperty SERVER_OPERATORS_GROUP

Name of the list of users/roles that are permitted to start and stop OMAG Servers on an OMAG Server Platform.

SERVER_INVESTIGATORS_GROUP

public static final OpenMetadataSecurityConfigurationProperty SERVER_INVESTIGATORS_GROUP

Name of the list of users/roles that are permitted to start and stop OMAG Servers on an OMAG Server Platform.

DYNAMIC_TYPE_AUTHOR_GROUP

public static final OpenMetadataSecurityConfigurationProperty DYNAMIC_TYPE_AUTHOR_GROUP

Name of the list of users/roles that are permitted to modify the open metadata type definitions in a Metadata Access Server.

INSTANCE_HEADER_AUTHOR_GROUP

public static final OpenMetadataSecurityConfigurationProperty INSTANCE_HEADER_AUTHOR_GROUP

Name of the list of users/roles that are permitted to modify the header information for an existing open metadata instance in the Open Metadata Ecosystem.

SERVER_GROUP_NAME_PATTERN

public static final OpenMetadataSecurityConfigurationProperty SERVER_GROUP_NAME_PATTERN

Provide a string pattern (for MessageFormat.format()) to convert a server name {0} into the group name to use to look up whether a user has access to a server's functions.

SERVER_SERVICE_GROUP_NAME_PATTERN

public static final OpenMetadataSecurityConfigurationProperty SERVER_SERVICE_GROUP_NAME_PATTERN

Provide a string pattern (for MessageFormat.format()) Provide a string pattern (for MessageFormat.format()) to convert a server name {0} and service name {1} into the group name to use to look up whether a user has access to a specific server's service.

SERVER_SERVICE_OPERATION_GROUP_NAME_PATTERN

public static final OpenMetadataSecurityConfigurationProperty SERVER_SERVICE_OPERATION_GROUP_NAME_PATTERN

Provide a string pattern (for MessageFormat.format()) to convert a server name {0}, a service name {1} and an operation {2} into the group name to use to look up whether a user has access to a specific server's service operation (method).

ZONE_GROUP_NAME_PATTERN

public static final OpenMetadataSecurityConfigurationProperty ZONE_GROUP_NAME_PATTERN

Provide a string pattern (for MessageFormat.format()) to convert a governance zone name into the group name to use to look up whether a user has access to assets in the zone.

ELEMENT_GROUP_NAME_PATTERN

public static final OpenMetadataSecurityConfigurationProperty ELEMENT_GROUP_NAME_PATTERN

Provide a string pattern (for MessageFormat.format()) to convert an element's type {0}, qualified name {1} and the operation {2} into the group name to use to look up whether a user has access to the element.

OWNER_GROUP_NAME_PATTERN

public static final OpenMetadataSecurityConfigurationProperty OWNER_GROUP_NAME_PATTERN

Provide a string pattern (for MessageFormat.format()) to convert an owner's name {0}, type name {1} and property name {2} into the group name to use to look up whether a user is the owner of an element.

VALIDATION_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty VALIDATION_ZONES_GROUP

A list of governance zones that require a different user from the creator to move a member asset out of the zone.

PERSONAL_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty PERSONAL_ZONES_GROUP

A list of governance zones that only allow update and access to the creator of the member assets.

STEWARDSHIP_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty STEWARDSHIP_ZONES_GROUP

A list of governance zones where only the owner of a member asset may read or maintain the asset.

READABLE_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty READABLE_ZONES_GROUP

A list of governance zones where all user have read access. Maintenance (create, update, delete) requires explicit access.

AUTOMATED_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty AUTOMATED_ZONES_GROUP

A list of governance zones where only automated processes may read or maintain the member assets.

ALL_USER_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty ALL_USER_ZONES_GROUP

A list of governance zones where any defined user may read the member assets.

EMPLOYEE_ONLY_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty EMPLOYEE_ONLY_ZONES_GROUP

A list of governance zones where defined user with an account type of EMPLOYEE may read or maintain the member assets.

NOT_EXTERNAL_ZONES_GROUP

public static final OpenMetadataSecurityConfigurationProperty NOT_EXTERNAL_ZONES_GROUP

A list of governance zones where defined user with an account type of EMPLOYEE or CONTRACTOR may read the member assets.

Field Details

name

public final String name

description

public final String description

dataType

public final String dataType

defaultValue

public final String defaultValue

isPlaceholder

public final boolean isPlaceholder

Method Details

values

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

getName

public String getName()

Return the name of the request parameter.

Returns:

string name

getDescription

public String getDescription()

Return the description of the configuration property.

Returns:

text

getDataType

public String getDataType()

Return the data type for the configuration property.

Returns:

data type name

getDefaultValue

public String getDefaultValue()

Return an example of the configuration property to help users understand how to set it up.

Returns:

example

isPlaceholder

public boolean isPlaceholder()

Return whether this value is also used as a placeholder property.

Returns:

boolean

getRecognizedConfigurationPropertyTypes

public static List<String> getRecognizedConfigurationPropertyTypes()

Retrieve all the defined configuration properties

Returns:

list of configuration property types

getConfigurationPropertyTypes

public static List<ConfigurationPropertyType> getConfigurationPropertyTypes()

Retrieve all the defined configuration properties

Returns:

list of configuration property types

getConfigurationPropertyType

public ConfigurationPropertyType getConfigurationPropertyType()

Return a summary of this enum to use in a connector provider.

Returns:

request parameter type

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<OpenMetadataSecurityConfigurationProperty>

Returns:

string showing enum value