Package org.odpi.openmetadata.adminservices.configuration.properties

Class AccessServiceConfig

  • All Implemented Interfaces:
    java.io.Serializable
    public class AccessServiceConfig
extends AdminServicesConfigHeader
    AccessServiceConfig provides the configuration for a single Open Metadata Access Service (OMAS).
    See Also:
    Serialized Form

    • Constructor Detail

      • AccessServiceConfig

        public AccessServiceConfig()
        Default constructor for use with Jackson libraries

      • AccessServiceConfig

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

      • AccessServiceConfig

        public AccessServiceConfig​(AccessServiceRegistration accessServiceRegistration)
        Set up the default values for an access service using an access service description.
        Parameters:
        accessServiceRegistration - fixed properties about the access service

    • Method Detail

      • getAccessServiceId

        public int getAccessServiceId()
        Return the code number (ordinal) for this access service.
        Returns:
        int ordinal

      • setAccessServiceId

        public void setAccessServiceId​(int accessServiceId)
        Set up the code number (ordinal) for this access service.
        Parameters:
        accessServiceId - int ordinal

      • getAccessServiceDevelopmentStatus

        public ComponentDevelopmentStatus getAccessServiceDevelopmentStatus()
        Return the development status of the service.
        Returns:
        enum describing the status

      • setAccessServiceDevelopmentStatus

        public void setAccessServiceDevelopmentStatus​(ComponentDevelopmentStatus accessServiceDevelopmentStatus)
        Set up the development status of the service.
        Parameters:
        accessServiceDevelopmentStatus - enum describing the status

      • getAccessServiceAdminClass

        public java.lang.String getAccessServiceAdminClass()
        Return the Java class name of the admin-services interface for this access service.
        Returns:
        String class name implementing the AccessServiceAdmin interface.

      • setAccessServiceAdminClass

        public void setAccessServiceAdminClass​(java.lang.String accessServiceAdminClass)
        Set up the Java class name of the admin services interface for this access service.
        Parameters:
        accessServiceAdminClass - String class name implementing the AccessServiceAdmin interface.

      • getAccessServiceName

        public java.lang.String getAccessServiceName()
        Return the name of the access service.
        Returns:
        String name

      • setAccessServiceFullName

        public void setAccessServiceFullName​(java.lang.String accessServiceFullName)
        Set up the full name of the access service.
        Parameters:
        accessServiceFullName - String name

      • setAccessServiceName

        public void setAccessServiceName​(java.lang.String accessServiceName)
        Set up the name of the access service.
        Parameters:
        accessServiceName - String name

      • getAccessServiceFullName

        public java.lang.String getAccessServiceFullName()
        Return the full name of the access service.
        Returns:
        String name

      • getAccessServiceURLMarker

        public java.lang.String getAccessServiceURLMarker()
        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

      • setAccessServiceURLMarker

        public void setAccessServiceURLMarker​(java.lang.String accessServiceURLMarker)
        Set up the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.
        Parameters:
        accessServiceURLMarker - url fragment

      • getAccessServiceDescription

        public java.lang.String getAccessServiceDescription()
        Return the short description of the access service. The default value is in English but this can be changed.
        Returns:
        String description

      • setAccessServiceDescription

        public void setAccessServiceDescription​(java.lang.String accessServiceDescription)
        Set up the short description of the access service.
        Parameters:
        accessServiceDescription - String description

      • getAccessServiceWiki

        public java.lang.String getAccessServiceWiki()
        Return the wiki page link for the access service.
        Returns:
        String url

      • setAccessServiceWiki

        public void setAccessServiceWiki​(java.lang.String accessServiceWiki)
        Set up the wiki page link for the access service.
        Parameters:
        accessServiceWiki - String url

      • getAccessServiceOperationalStatus

        public ServiceOperationalStatus getAccessServiceOperationalStatus()
        Return the status of this access service.
        Returns:
        AccessServiceOperationalStatus enum

      • setAccessServiceOperationalStatus

        public void setAccessServiceOperationalStatus​(ServiceOperationalStatus accessServiceOperationalStatus)
        Set up the status of the access service.
        Parameters:
        accessServiceOperationalStatus - AccessServiceOperationalStatus enum

      • getAccessServiceInTopic

        public Connection getAccessServiceInTopic()
        Return the OCF Connection for the topic used to pass requests to this access service. The default values are constructed from the access service name. If this value is set to null then the access service ignores incoming events.
        Returns:
        Connection for InTopic

      • setAccessServiceInTopic

        public void setAccessServiceInTopic​(Connection accessServiceInTopic)
        Set up the OCF Connection for the topic used to pass requests to this access service. The default values are constructed from the access service name. If this value is set to null then the access service ignores incoming events.
        Parameters:
        accessServiceInTopic - Connection properties

      • getAccessServiceOutTopic

        public Connection getAccessServiceOutTopic()
        Return the OCF Connection for the topic used by this access service to publish events. The default values are constructed from the access service name. If this value is set to null then events are not published by this OMAS.
        Returns:
        Connection for OutTopic

      • setAccessServiceOutTopic

        public void setAccessServiceOutTopic​(Connection accessServiceOutTopic)
        Set up the OCF Connection of the topic used by this access service to publish events. The default values are constructed from the access service name. If this value is set to null then events are not published by this OMAS.
        Parameters:
        accessServiceOutTopic - Connection properties

      • getAccessServiceOptions

        public java.util.Map<java.lang.String,​java.lang.Object> getAccessServiceOptions()
        Return the options for this access service. These are properties that are specific to the access service.
        Returns:
        Map from String to String

      • setAccessServiceOptions

        public void setAccessServiceOptions​(java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
        Set up the options for this access service. These are properties that are specific to the access service.
        Parameters:
        accessServiceOptions - Map from String to String

      • 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