Package org.odpi.openmetadata.serveroperations.server

Class OMAGServerOperationalInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.serveroperations.server.OMAGServerOperationalInstanceHandler

public class OMAGServerOperationalInstanceHandler
extends 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(String serviceName)	Constructor passes the service name that is used on all calls to this instance.

Method Summary

Modifier and Type	Method	Description
OMAGOperationalServicesInstance	getServerServiceInstance(String userId, String serverName, String serviceOperationName)	Get the object containing the properties for this server.
OMAGOperationalServicesInstance	getServerServiceInstance(String userId, String delegatingUserId, String serverName, 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 Details

OMAGServerOperationalInstanceHandler

public OMAGServerOperationalInstanceHandler(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

getServerServiceInstance

public OMAGOperationalServicesInstance getServerServiceInstance(String userId,
 String delegatingUserId,
 String serverName,
 String serviceOperationName)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Get the object containing the properties for this server.

Overrides:

getServerServiceInstance in class OMAGServerServiceInstanceHandler

Parameters:

userId - calling user

delegatingUserId - external userId making request

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

getServerServiceInstance

public OMAGOperationalServicesInstance getServerServiceInstance(String userId,
 String serverName,
 String serviceOperationName)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Get the object containing the properties for this server.

Overrides:

getServerServiceInstance in class 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