org.odpi.openmetadata.adminservices.configuration.properties

Class CohortConfig

java.lang.Object

org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig

public class CohortConfig
extends Object

CohortConfig provides the configuration properties used to connect to an open metadata repository cohort.

• cohortName is a descriptive name for the cohort that is used primarily for messages and diagnostics. It is also used to create a default name for the cohort's OMRS Topic and the cohortRegistry's store if these names are not explicitly defined.
• cohortRegistryConnection is the connection properties necessary to create the connector to the cohort registry store. This is the store where the cohort registry keeps information about its local metadata collection Id and details of other repositories in the cohort. The default value is to use a local file called "cohort.registry" that is stored in the server's home directory.
• cohortOMRSTopicConnection is the connection properties necessary to create the connector to the OMRS Topic. This is used to send/receive events between members of the open metadata repository cohort.
• cohortOMRSTopicProtocolVersion defines the version of the event payload to use when communicating with other members of the cohort through the OMRS Topic.
• eventsToProcessRule defines how incoming events on the OMRS Topic should be processed.
• selectedTypesToProcess - list of TypeDefs used if the eventsToProcess rule (above) says "SELECTED_TYPES" - otherwise it is set to null.

Constructor Summary

Constructors

Constructor and Description
CohortConfig() Default constructor does nothing.
CohortConfig(String cohortName, Connection cohortRegistryConnection, Connection cohortOMRSTopicConnection, OpenMetadataExchangeRule eventsToProcessRule, List<TypeDefSummary> selectedTypesToProcess) Constructor to populate all config values.

Method Summary

Modifier and Type	Method and Description
String	getCohortName() Return the name of the cohort.
Connection	getCohortOMRSTopicConnection() Return the connection to the cohort's OMRS Topic.
OpenMetadataEventProtocolVersion	getCohortOMRSTopicProtocolVersion() Return the protocol version to use when exchanging events amongst the cohort members.
Connection	getCohortRegistryConnection() Set up the connection to the cohort registry store.
OpenMetadataExchangeRule	getEventsToProcessRule() Return the rule indicating whether incoming metadata events from a cohort should be processed.
List<TypeDefSummary>	getSelectedTypesToProcess() Return the list of TypeDefs used if the eventsToProcess rule (above) says "SELECTED_TYPES" - otherwise it is set to null.
void	setCohortName(String cohortName) Set up the name of the cohort.
void	setCohortOMRSTopicConnection(Connection cohortOMRSTopicConnection) Set up the connection to the cohort's OMRS Topic.
void	setCohortOMRSTopicProtocolVersion(OpenMetadataEventProtocolVersion cohortOMRSTopicProtocolVersion) Set up the protocol version to use when exchanging events amongst the cohort members.
void	setCohortRegistryConnection(Connection cohortRegistryConnection) Set up the connection for the cohort registry store.
void	setEventsToProcessRule(OpenMetadataExchangeRule eventsToProcessRule) Set up the rule indicating whether incoming metadata events from a cohort should be processed.
void	setSelectedTypesToProcess(List<TypeDefSummary> selectedTypesToProcess) Set up the list of TypeDefs used if the EventsToProcess rule (above) says "SELECTED_TYPES" - otherwise it is set to null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CohortConfig

public CohortConfig()

Default constructor does nothing.

CohortConfig

public CohortConfig(String cohortName,
                    Connection cohortRegistryConnection,
                    Connection cohortOMRSTopicConnection,
                    OpenMetadataExchangeRule eventsToProcessRule,
                    List<TypeDefSummary> selectedTypesToProcess)

Constructor to populate all config values.

Parameters:

cohortName - name of the cohort

cohortRegistryConnection - connection to the cohort registry store

cohortOMRSTopicConnection - connection to the OMRS Topic

eventsToProcessRule - rule indicating whether metadata events should be sent to the federated OMRS Topic.

selectedTypesToProcess - if the rule says "SELECTED_TYPES" then this is the list of types otherwise it is set to null.

Method Detail

getCohortName

public String getCohortName()

Return the name of the cohort.

Returns:

String name

setCohortName

public void setCohortName(String cohortName)

Set up the name of the cohort.

Parameters:

cohortName - String

getCohortRegistryConnection

public Connection getCohortRegistryConnection()

Set up the connection to the cohort registry store.

Returns:

Connection object

setCohortRegistryConnection

public void setCohortRegistryConnection(Connection cohortRegistryConnection)

Set up the connection for the cohort registry store.

Parameters:

cohortRegistryConnection - Connection object

getCohortOMRSTopicConnection

public Connection getCohortOMRSTopicConnection()

Return the connection to the cohort's OMRS Topic.

Returns:

Connection object

setCohortOMRSTopicConnection

public void setCohortOMRSTopicConnection(Connection cohortOMRSTopicConnection)

Set up the connection to the cohort's OMRS Topic.

Parameters:

cohortOMRSTopicConnection - Connection object

getCohortOMRSTopicProtocolVersion

public OpenMetadataEventProtocolVersion getCohortOMRSTopicProtocolVersion()

Return the protocol version to use when exchanging events amongst the cohort members.

Returns:

protocol version enum

setCohortOMRSTopicProtocolVersion

public void setCohortOMRSTopicProtocolVersion(OpenMetadataEventProtocolVersion cohortOMRSTopicProtocolVersion)

Set up the protocol version to use when exchanging events amongst the cohort members.

Parameters:

cohortOMRSTopicProtocolVersion - protocol version enum

getEventsToProcessRule

public OpenMetadataExchangeRule getEventsToProcessRule()

Return the rule indicating whether incoming metadata events from a cohort should be processed.

Returns:

OpenMetadataExchangeRule - NONE, JUST_TYPEDEFS, SELECTED_TYPES and ALL.

setEventsToProcessRule

public void setEventsToProcessRule(OpenMetadataExchangeRule eventsToProcessRule)

Set up the rule indicating whether incoming metadata events from a cohort should be processed.

Parameters:

eventsToProcessRule - OpenMetadataExchangeRule - NONE, JUST_TYPEDEFS, SELECTED_TYPES and ALL.

getSelectedTypesToProcess

public List<TypeDefSummary> getSelectedTypesToProcess()

Return the list of TypeDefs used if the eventsToProcess rule (above) says "SELECTED_TYPES" - otherwise it is set to null.

Returns:

list of TypeDefs that determine which metadata instances to process

setSelectedTypesToProcess

public void setSelectedTypesToProcess(List<TypeDefSummary> selectedTypesToProcess)

Set up the list of TypeDefs used if the EventsToProcess rule (above) says "SELECTED_TYPES" - otherwise it is set to null.

Parameters:

selectedTypesToProcess - list of TypeDefs that determine which metadata instances to process