Class OMAGServerOperationalInstanceHandler


  • public class OMAGServerOperationalInstanceHandler
    extends org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler
    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.
    • Field Summary

      • Fields inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

        platformInstanceMap, serviceName
    • Constructor Summary

      Constructors 
      Constructor Description
      OMAGServerOperationalInstanceHandler​(java.lang.String serviceName)
      Constructor passes the service name that is used on all calls to this instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance getServerServiceInstance​(java.lang.String userId, java.lang.String serverName, java.lang.String serviceOperationName)
      Get the object containing the properties for this server.
      • Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

        getServerSecurityVerifier, getServiceName, isServerActive, removeServerServiceInstance
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OMAGServerOperationalInstanceHandler

        public OMAGServerOperationalInstanceHandler​(java.lang.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 Detail

      • getServerServiceInstance

        public org.odpi.openmetadata.adminservices.OMAGOperationalServicesInstance getServerServiceInstance​(java.lang.String userId,
                                                                                                            java.lang.String serverName,
                                                                                                            java.lang.String serviceOperationName)
                                                                                                     throws InvalidParameterException,
                                                                                                            UserNotAuthorizedException,
                                                                                                            PropertyServerException
        Get the object containing the properties for this server.
        Overrides:
        getServerServiceInstance in class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler
        Parameters:
        userId - calling user
        serverName - name of this server
        serviceOperationName - name of the REST API call (typically the top-level methodName)
        Returns:
        specific service instance
        Throws:
        InvalidParameterException - the server name is not known
        UserNotAuthorizedException - the user is not authorized to issue the request.
        PropertyServerException - the service name is not known - indicating a logic error