Package org.odpi.openmetadata.commonservices.multitenant

Class OMAGServerServiceInstanceHandler

java.lang.Object
org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler
Direct Known Subclasses:
AuditableServerServiceInstanceHandler
public abstract class OMAGServerServiceInstanceHandler extends Object
OMAGServerServiceInstanceHandler retrieves information from the instance map for an OMAG server service instance. The instance map is thread-safe. Instances are added and removed during server initialization and termination.

  • Constructor Details

    • OMAGServerServiceInstanceHandler

      public OMAGServerServiceInstanceHandler(String serviceName)
      Constructor passes the service name that is used on all calls to this instance.
      Parameters:
      serviceName - unique identifier for this service with a human meaningful value

  • Method Details

    • getServiceName

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

    • isServerActive

      public boolean isServerActive(String userId, String serverName) throws org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException
      Return whether a particular server is registered with the platform. This is used by the admin services when finding no instance is not an error.
      Parameters:
      userId - calling user or null if it is an anonymous request
      serverName - name of the server
      Returns:
      boolean
      Throws:
      org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException - the user is not authorized to issue the request.

    • getServerSecurityVerifier

      public org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier getServerSecurityVerifier(String userId, String serverName) throws org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException
      Return the security verifier for the server.
      Parameters:
      userId - calling user or null if it is an anonymous request
      serverName - name of the server
      Returns:
      OpenMetadataServerSecurityVerifier object - never null
      Throws:
      org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - the server name is not known

    • removeServerServiceInstance

      public void removeServerServiceInstance(String serverName)
      Remove the instance for this server.
      Parameters:
      serverName - name of the server