Package org.odpi.openmetadata.commonservices.multitenant

Class AccessServerServiceInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AccessServerServiceInstanceHandler

Direct Known Subclasses:

GAFServicesInstanceHandler, OCFServicesInstanceHandler, OMFServicesInstanceHandler

public class AccessServerServiceInstanceHandler
extends AuditableServerServiceInstanceHandler

AccessServerServiceInstanceHandler retrieves information from the instance map for the access service instances. The instance map is thread-safe. Instances are added and removed by the GovernanceProgramAdmin class.

Field Summary

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

platformInstanceMap, serviceName

Constructor Summary

Constructors

Constructor	Description
AccessServerServiceInstanceHandler(String serviceName)	Constructor

Method Summary

Modifier and Type	Method	Description
RESTExceptionHandler	getExceptionHandler()	Retrieve the exception handler that can package up common exceptions and pack them into a REST Response.
OMRSMetadataCollection	getMetadataCollection(String userId, String serverName, String serviceOperationName)	Retrieve the metadata collection for the access service.
Connection	getOutTopicConnection(String userId, String serverName, String serviceOperationName, String callerId)	Return the connection used in the client to create a connector to access events from the out topic.
OMRSRepositoryHelper	getRepositoryHelper(String userId, String serverName, String serviceOperationName)	Retrieve the repository helper for the access service.
String	getServiceName(String callingServiceURLName)	Return the service's official name.

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

getAuditLog

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

getServerSecurityVerifier, getServerServiceInstance, getServiceName, isServerActive, removeServerServiceInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AccessServerServiceInstanceHandler

public AccessServerServiceInstanceHandler(String serviceName)

Constructor

Parameters:

serviceName - a descriptive name for the OMAS

Method Details

getRepositoryHelper

public OMRSRepositoryHelper getRepositoryHelper(String userId,
 String serverName,
 String serviceOperationName)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the repository helper for the access service.

Parameters:

userId - calling userId

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

repository connector for exclusive use by the requested 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 or the repository connector is not available - indicating a logic error

getMetadataCollection

public OMRSMetadataCollection getMetadataCollection(String userId,
 String serverName,
 String serviceOperationName)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the metadata collection for the access service.

Parameters:

userId - calling userId

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

metadata collection for exclusive use by the requested 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 or the metadata collection is not available - indicating a logic error

getServiceName

public String getServiceName(String callingServiceURLName)

Return the service's official name.

Parameters:

callingServiceURLName - url fragment that indicates the service name

Returns:

String name

getOutTopicConnection

public Connection getOutTopicConnection(String userId,
 String serverName,
 String serviceOperationName,
 String callerId)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the connection used in the client to create a connector to access events from the out topic.

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

callerId - unique identifier of the caller

Returns:

connection object for client

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error

getExceptionHandler

public RESTExceptionHandler getExceptionHandler()

Retrieve the exception handler that can package up common exceptions and pack them into a REST Response.

Returns:

exception handler object