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

Class AccessServiceRegistrationEntry

java.lang.Object
org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceRegistrationEntry
public class AccessServiceRegistrationEntry extends Object
AccessServiceRegistrationEntry is used by an access service to register its admin services interface. The registration is dynamic because access services from third parties can be written and run in the OMAGServerPlatform.

  • Constructor Details

    • AccessServiceRegistrationEntry

      public AccessServiceRegistrationEntry(int accessServiceCode, ComponentDevelopmentStatus accessServiceDevelopmentStatus, String accessServiceName, String accessServiceFullName, String accessServiceURLMarker, String accessServiceDescription, String accessServiceWiki, ServiceOperationalStatus accessServiceInTopicStatus, ServiceOperationalStatus accessServiceOutTopicStatus, ServiceOperationalStatus accessServiceOperationalStatus, String accessServiceAdminClassName)
      Complete Constructor
      Parameters:
      accessServiceCode - ordinal for this access service
      accessServiceDevelopmentStatus - development status
      accessServiceName - symbolic name for this access service
      accessServiceFullName - full name for this access service
      accessServiceURLMarker - name of the part of the URL that is the name of the access service
      accessServiceDescription - short description for this access service
      accessServiceWiki - wiki page for the access service for this access service
      accessServiceInTopicStatus - is the access service inTopic implemented, operational or disabled?
      accessServiceOutTopicStatus - is the access service outTopic implemented, operational or disabled?
      accessServiceOperationalStatus - default initial operational status for the access service
      accessServiceAdminClassName - name of AccessServiceAdmin implementation class for the access service

    • AccessServiceRegistrationEntry

      public AccessServiceRegistrationEntry(AccessServiceDescription accessServiceDescription, ServiceOperationalStatus accessServiceOperationalStatus, String accessServiceAdminClassName)
      Enum Constructor
      Parameters:
      accessServiceDescription - enum for this access service
      accessServiceOperationalStatus - default initial operational status for the access service
      accessServiceAdminClassName - name of AccessServiceAdmin implementation class for the access service

    • AccessServiceRegistrationEntry

      public AccessServiceRegistrationEntry()
      Default constructor

  • Method Details

    • getAccessServiceCode

      public int getAccessServiceCode()
      Return the code for this access service
      Returns:
      int type code

    • setAccessServiceCode

      public void setAccessServiceCode(int accessServiceCode)
      Set up the code for this access service
      Parameters:
      accessServiceCode - int type code

    • 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

    • getAccessServiceName

      public String getAccessServiceName()
      Return the default name for this access service.
      Returns:
      String default name

    • setAccessServiceName

      public void setAccessServiceName(String accessServiceName)
      Set up the default name for this access service.
      Parameters:
      accessServiceName - String default name

    • getAccessServiceFullName

      public String getAccessServiceFullName()
      Return the full name for this access service.
      Returns:
      String default name

    • setAccessServiceFullName

      public void setAccessServiceFullName(String accessServiceFullName)
      Set up the full name for this access service.
      Parameters:
      accessServiceFullName - String default name

    • getAccessServiceURLMarker

      public 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

    • setServiceURLMarker

      public void setServiceURLMarker(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 String getAccessServiceDescription()
      Return the default description for the type for this access service.
      Returns:
      String default description

    • setAccessServiceDescription

      public void setAccessServiceDescription(String accessServiceDescription)
      Set up the default description for the type for this access service.
      Parameters:
      accessServiceDescription - String default description

    • getAccessServiceWiki

      public String getAccessServiceWiki()
      Return the URL for the wiki page describing this access service.
      Returns:
      String URL for the wiki page

    • setAccessServiceWiki

      public void setAccessServiceWiki(String accessServiceWiki)
      Set up the URL for the wiki page describing this access service.
      Parameters:
      accessServiceWiki - String URL for the wiki page

    • getAccessServiceOperationalStatus

      public ServiceOperationalStatus getAccessServiceOperationalStatus()
      Return the initial operational status for this access service.
      Returns:
      ServiceOperationalStatus enum

    • setAccessServiceOperationalStatus

      public void setAccessServiceOperationalStatus(ServiceOperationalStatus accessServiceOperationalStatus)
      Set up the initial operational status for this access service.
      Parameters:
      accessServiceOperationalStatus - ServiceOperationalStatus enum

    • getAccessServiceAdminClassName

      public String getAccessServiceAdminClassName()
      Return the class name of the admin class that should be called during initialization and termination.
      Returns:
      class name

    • setAccessServiceAdminClassName

      public void setAccessServiceAdminClassName(String accessServiceAdminClassName)
      Set up the class name of the admin class that should be called during initialization and termination.
      Parameters:
      accessServiceAdminClassName - class name

    • getAccessServiceInTopic

      public String getAccessServiceInTopic()
      Return the InTopic name for the access service. Null means that the topic is either not implemented or not enabled.
      Returns:
      String topic name

    • getAccessServiceOutTopic

      public String getAccessServiceOutTopic()
      Return the OutTopic name for the access service. Null means that the topic is either not implemented or not enabled.
      Returns:
      String topic name