Class EnterpriseAccessConfig

  • All Implemented Interfaces:
    java.io.Serializable

    public class EnterpriseAccessConfig
    extends AdminServicesConfigHeader
    EnterpriseAccessConfig describes the properties that control the enterprise access services that the OMRS provides to the Open Metadata Access Services (OMASs).
    • enterpriseMetadataCollectionName - name of the combined metadata collection covered by the connected open metadata repositories. Used for messages.
    • enterpriseMetadataCollectionId - unique identifier for the combined metadata collection covered by the connected open metadata repositories.
    • enterpriseOMRSTopicConnection - connection for the enterprise OMRS Topic connector.
    • enterpriseOMRSTopicProtocolVersion - the protocol version for the events passed on the enterprise OMRS topic.
    • remoteEnterpriseOMRSTopicConnection - connection for the remote (external) enterprise OMRS Topic connector.
    See Also:
    Serialized Form
    • Constructor Detail

      • EnterpriseAccessConfig

        public EnterpriseAccessConfig()
        Default Constructor does nothing.
      • EnterpriseAccessConfig

        public EnterpriseAccessConfig​(EnterpriseAccessConfig template)
        Copy/clone constructor
        Parameters:
        template - object to copy
      • EnterpriseAccessConfig

        public EnterpriseAccessConfig​(java.lang.String enterpriseMetadataCollectionName,
                                      java.lang.String enterpriseMetadataCollectionId,
                                      Connection enterpriseOMRSTopicConnection,
                                      OpenMetadataEventProtocolVersion enterpriseOMRSTopicProtocolVersion,
                                      Connection remoteEnterpriseOMRSTopicConnection)
        Constructor to set up all configuration values.
        Parameters:
        enterpriseMetadataCollectionName - name of the combined metadata collection covered by the connected open metadata repositories. Used for messages.
        enterpriseMetadataCollectionId - unique identifier for the combined metadata collection covered by the connected open metadata repositories.
        enterpriseOMRSTopicConnection - connection for the OMRS Topic connector.
        enterpriseOMRSTopicProtocolVersion - protocol version enum
        remoteEnterpriseOMRSTopicConnection - connection to publish OMRS events to external parties
    • Method Detail

      • getEnterpriseMetadataCollectionName

        public java.lang.String getEnterpriseMetadataCollectionName()
        Return the name of the combined metadata collection covered by the connected open metadata repositories. Used for messages.
        Returns:
        String name
      • setEnterpriseMetadataCollectionName

        public void setEnterpriseMetadataCollectionName​(java.lang.String enterpriseMetadataCollectionName)
        Set up the name of the combined metadata collection covered by the connected open metadata repositories. Used for messages.
        Parameters:
        enterpriseMetadataCollectionName - String name
      • getEnterpriseMetadataCollectionId

        public java.lang.String getEnterpriseMetadataCollectionId()
        Return the unique identifier for the combined metadata collection covered by the connected open metadata repositories.
        Returns:
        Unique identifier (guid)
      • setEnterpriseMetadataCollectionId

        public void setEnterpriseMetadataCollectionId​(java.lang.String enterpriseMetadataCollectionId)
        Set up the unique identifier for the combined metadata collection covered by the connected open metadata repositories.
        Parameters:
        enterpriseMetadataCollectionId - Unique identifier (guid)
      • getEnterpriseOMRSTopicConnection

        public Connection getEnterpriseOMRSTopicConnection()
        Return the connection for the Enterprise OMRS Topic connector.
        Returns:
        Connection object
      • setEnterpriseOMRSTopicConnection

        public void setEnterpriseOMRSTopicConnection​(Connection enterpriseOMRSTopicConnection)
        Set up the connection for the Enterprise OMRS Topic connector.
        Parameters:
        enterpriseOMRSTopicConnection - Connection object
      • getEnterpriseOMRSTopicProtocolVersion

        public OpenMetadataEventProtocolVersion getEnterpriseOMRSTopicProtocolVersion()
        Return the protocol version to use on the EnterpriseOMRSTopicConnector.
        Returns:
        protocol version enum
      • setEnterpriseOMRSTopicProtocolVersion

        public void setEnterpriseOMRSTopicProtocolVersion​(OpenMetadataEventProtocolVersion enterpriseOMRSTopicProtocolVersion)
        Set up the protocol version to use on the EnterpriseOMRSTopicConnector.
        Parameters:
        enterpriseOMRSTopicProtocolVersion - protocol version enum
      • getRemoteEnterpriseOMRSTopicConnection

        public Connection getRemoteEnterpriseOMRSTopicConnection()
        Return the optional connection for an external topic for enterprise events.
        Returns:
        connection
      • setRemoteEnterpriseOMRSTopicConnection

        public void setRemoteEnterpriseOMRSTopicConnection​(Connection remoteEnterpriseOMRSTopicConnection)
        Set up the optional connection for an external topic for enterprise events.
        Parameters:
        remoteEnterpriseOMRSTopicConnection - connection
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        JSON style description of variables.
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class java.lang.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 java.lang.Object
        Returns:
        in hash code