Package org.odpi.openmetadata.commonservices.multitenant

Class OMAGServerServiceInstance

java.lang.Object
org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstance
Direct Known Subclasses:
AuditableServerServiceInstance
public abstract class OMAGServerServiceInstance extends Object
OMAGServerServiceInstance represents an instance of a service in an OMAG Server. It is also responsible for registering itself in the instance map.

  • Constructor Details

    • OMAGServerServiceInstance

      public OMAGServerServiceInstance(String serverName, String serverType, String serviceName, int maxPageSize)
      Default constructor
      Parameters:
      serverName - name of the new server
      serverType - type for new server
      serviceName - name of the new service instance
      maxPageSize - maximum number of results that can be returned on a single call.

    • OMAGServerServiceInstance

      public OMAGServerServiceInstance(String serverName, String serviceName, int maxPageSize)
      Default constructor
      Parameters:
      serverName - name of the new server
      serviceName - name of the new service instance
      maxPageSize - maximum number of results that can be returned on a single call.

  • Method Details

    • setServiceInstanceStatus

      public void setServiceInstanceStatus(org.odpi.openmetadata.serveroperations.properties.ServerInstanceStatus serviceInstanceStatus)
      Set up the current status of the service.
      Parameters:
      serviceInstanceStatus - new status

    • getServiceInstanceStatus

      public org.odpi.openmetadata.serveroperations.properties.ServerInstanceStatus getServiceInstanceStatus()
      Return the current status of the service.
      Returns:
      server instance status enum

    • setSecurityVerifier

      public void setSecurityVerifier(org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier)
      Set up a new security verifier (the handler runs with a default verifier until this method is called). The security verifier provides authorization checks for access and maintenance changes to open metadata. Authorization checks are enabled through the OpenMetadataServerSecurityConnector.
      Parameters:
      securityVerifier - new security verifier

    • setMaxPageSize

      public void setMaxPageSize(int maxPageSize)
      Override the default maximum paging size.
      Parameters:
      maxPageSize - new value

    • getServerName

      public String getServerName() throws NewInstanceException
      Return the server name.
      Returns:
      serverName name of the server for this instance
      Throws:
      NewInstanceException - a problem occurred during initialization

    • getServiceName

      public String getServiceName()
      Return this service's official name.
      Returns:
      name

    • getInvalidParameterHandler

      public org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler getInvalidParameterHandler()
      Return the handler for validating parameters.
      Returns:
      invalid parameter handler

    • shutdown

      public void shutdown()
      Unregister this instance from the instance map.