CohortConfig (Administration Services API 1.1 API)

java.lang.Object
- org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
- - org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig

All Implemented Interfaces:

Serializable
```
public class CohortConfig
extends AdminServicesConfigHeader
```
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.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CohortConfig()
Default constructor does nothing.

CohortConfig(CohortConfig template)
Copy/clone constructor

Constructors
Constructor and Description
`CohortConfig()` Default constructor does nothing.
`CohortConfig(CohortConfig template)` Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Validate that an object is equal depending on their stored values.
`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.
`int`	`hashCode()` Return a hash code based on the values of this object.
`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.
`String`	`toString()` Standard toString method.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CohortConfig
```
public CohortConfig()
```
    Default constructor does nothing.
  - CohortConfig
```
public CohortConfig(CohortConfig template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- 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
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    JSON style description of variables.
  - equals
```
public boolean equals(Object objectToCompare)
```
    Validate that an object is equal depending on their stored values.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    objectToCompare - object
    
    Returns:
    
    boolean result
  - hashCode
```
public int hashCode()
```
    Return a hash code based on the values of this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    in hash code

Class CohortConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CohortConfig

CohortConfig

Method Detail

getCohortName

setCohortName

getCohortRegistryConnection

setCohortRegistryConnection

getCohortOMRSTopicConnection

setCohortOMRSTopicConnection

getCohortOMRSTopicProtocolVersion

setCohortOMRSTopicProtocolVersion

getEventsToProcessRule

setEventsToProcessRule

getSelectedTypesToProcess

setSelectedTypesToProcess

toString

equals

hashCode