Package org.odpi.openmetadata.adminservices.configuration.registration

Class EngineServiceRegistration

  • All Implemented Interfaces:
    Serializable
    public class EngineServiceRegistration
extends Object
implements Serializable
    EngineServiceRegistration is used by an engine service to register its admin services interface. The registration is dynamic because engine services from third parties can be written and run in the OMAGServerPlatform.
    See Also:
    Serialized Form

    • Constructor Detail

      • EngineServiceRegistration

        public EngineServiceRegistration​(int engineServiceCode,
                                 String engineServiceName,
                                 String engineServiceFullName,
                                 String engineServiceURLMarker,
                                 String engineServiceDescription,
                                 String engineServiceWiki,
                                 String engineServicePartnerOMAS,
                                 ServiceOperationalStatus engineServiceOperationalStatus,
                                 String engineServiceAdminClassName)
        Complete Constructor
        Parameters:
        engineServiceCode - ordinal for this engine service
        engineServiceName - symbolic name for this engine service
        engineServiceFullName - full name for this engine service
        engineServiceURLMarker - name of the part of the URL that is the name of the engine service
        engineServiceDescription - short description for this engine service
        engineServiceWiki - wiki page for the engine service for this engine service
        engineServicePartnerOMAS - full name of the OMAS that this engine service is partnered with
        engineServiceOperationalStatus - default initial operational status for the engine service
        engineServiceAdminClassName - name of EngineServiceAdmin implementation class for the engine service

      • EngineServiceRegistration

        public EngineServiceRegistration​(EngineServiceDescription engineServiceDescription,
                                 ServiceOperationalStatus engineServiceOperationalStatus,
                                 String engineServiceAdminClassName)
        Enum Constructor
        Parameters:
        engineServiceDescription - enum for this engine service
        engineServiceOperationalStatus - default initial operational status for the engine service
        engineServiceAdminClassName - name of EngineServiceAdmin implementation class for the engine service

      • EngineServiceRegistration

        public EngineServiceRegistration()
        Default constructor for use with Jackson libraries

      • EngineServiceRegistration

        public EngineServiceRegistration​(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

      • 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