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

Class EngineServiceConfig

  • All Implemented Interfaces:
    Serializable
    public class EngineServiceConfig
extends OMAGServerClientConfig
    EngineServiceConfig provides the properties to configure a single engine service in an engine hosting server. The engine service runs one or more engines of a specific type. The configuration for each of these engines is extracted from the partner OMAS using the engine name as the qualified name.
    See Also:
    Serialized Form

    • Constructor Detail

      • EngineServiceConfig

        public EngineServiceConfig()
        Default constructor

      • EngineServiceConfig

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

      • EngineServiceConfig

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

    • Method Detail

      • getEngineServiceId

        public int getEngineServiceId()
        Return the code number (ordinal) for this engine service.
        Returns:
        int ordinal

      • setEngineServiceId

        public void setEngineServiceId​(int engineServiceId)
        Set up the code number (ordinal) for this engine service.
        Parameters:
        engineServiceId - int ordinal

      • getEngineServiceAdminClass

        public String getEngineServiceAdminClass()
        Return the Java class name of the admin-services interface for this engine service.
        Returns:
        String class name implementing the EngineServiceAdmin interface.

      • setEngineServiceAdminClass

        public void setEngineServiceAdminClass​(String engineServiceAdminClass)
        Set up the Java class name of the admin services interface for this engine service.
        Parameters:
        engineServiceAdminClass - String class name implementing the EngineServiceAdmin interface.

      • getEngineServiceName

        public String getEngineServiceName()
        Return the name of the engine service.
        Returns:
        String name

      • setEngineServiceFullName

        public void setEngineServiceFullName​(String engineServiceFullName)
        Set up the full name of the engine service.
        Parameters:
        engineServiceFullName - String name

      • setEngineServiceName

        public void setEngineServiceName​(String engineServiceName)
        Set up the name of the engine service.
        Parameters:
        engineServiceName - String name

      • getEngineServiceFullName

        public String getEngineServiceFullName()
        Return the full name of the engine service.
        Returns:
        String name

      • getEngineServiceURLMarker

        public String getEngineServiceURLMarker()
        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

      • setEngineServiceURLMarker

        public void setEngineServiceURLMarker​(String engineServiceURLMarker)
        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:
        engineServiceURLMarker - url fragment

      • getEngineServiceDescription

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

      • setEngineServiceDescription

        public void setEngineServiceDescription​(String engineServiceDescription)
        Set up the short description of the engine service.
        Parameters:
        engineServiceDescription - String description

      • getEngineServiceWiki

        public String getEngineServiceWiki()
        Return the wiki page link for the engine service.
        Returns:
        String url

      • setEngineServiceWiki

        public void setEngineServiceWiki​(String engineServiceWiki)
        Set up the wiki page link for the engine service.
        Parameters:
        engineServiceWiki - String url

      • getEngineServicePartnerOMAS

        public String getEngineServicePartnerOMAS()
        Return the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.
        Returns:
        Full name of OMAS

      • setEngineServicePartnerOMAS

        public void setEngineServicePartnerOMAS​(String engineServicePartnerOMAS)
        Set up the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.
        Parameters:
        engineServicePartnerOMAS - Full name of OMAS

      • getEngineServiceOperationalStatus

        public ServiceOperationalStatus getEngineServiceOperationalStatus()
        Return the status of this engine service.
        Returns:
        ServiceOperationalStatus enum

      • setEngineServiceOperationalStatus

        public void setEngineServiceOperationalStatus​(ServiceOperationalStatus engineServiceOperationalStatus)
        Set up the status of the engine service.
        Parameters:
        engineServiceOperationalStatus - ServiceOperationalStatus enum

      • getEngineServiceOptions

        public Map<String,​Object> getEngineServiceOptions()
        Return the options for this engine service. These are properties that are specific to the engine service.
        Returns:
        Map from String to String

      • setEngineServiceOptions

        public void setEngineServiceOptions​(Map<String,​Object> engineServiceOptions)
        Set up the options for this engine service. These are properties that are specific to the engine service.
        Parameters:
        engineServiceOptions - Map from String to String

      • getEngines

        public List<EngineConfig> getEngines()
        Return the list of unique names (qualifiedName) for the governance engines that will run in this server.
        Returns:
        list of qualified names and userIds

      • setEngines

        public void setEngines​(List<EngineConfig> engines)
        Set up the list of unique names (qualifiedName) for the governance engines that will run in this server.
        Parameters:
        engines - list of qualified names and userIds

      • equals

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