org.odpi.openmetadata.accessservices.dataengine.server.admin

Class DataEngineInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.OMASServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.OCFOMASServiceInstanceHandler

org.odpi.openmetadata.accessservices.dataengine.server.admin.DataEngineInstanceHandler

public class DataEngineInstanceHandler
extends OCFOMASServiceInstanceHandler

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

Field Summary

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

platformInstanceMap, serviceName

Constructor Summary

Constructors

Constructor and Description
DataEngineInstanceHandler() Default constructor registers the access service

Method Summary

Modifier and Type	Method and Description
DataEngineSchemaTypeHandler	getDataEngineSchemaTypeHandler(String userId, String serverName, String serviceOperationName) Retrieve the data engine schema type handler for the access service
Connection	getInTopicConnection(String userId, String serverName, String serviceOperationName) Return the connection used in the client to create a connector to access events to the input topic.
PortHandler	getPortHandler(String userId, String serverName, String serviceOperationName) Retrieve the port handler for the access service
ProcessHandler	getProcessHandler(String userId, String serverName, String serviceOperationName) Retrieve the process handler for the access service
DataEngineRegistrationHandler	getRegistrationHandler(String userId, String serverName, String serviceOperationName) Retrieve the registration handler for the access service

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

getAssetHandler

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

getDefaultZones, getDefaultZones, getErrorHandler, getExceptionHandler, getMetadataCollection, getPublishZones, getPublishZones, getRepositoryConnector, getRepositoryHandler, getRepositoryHelper, getServiceName, getSupportedZones, getSupportedZones

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 Detail

DataEngineInstanceHandler

public DataEngineInstanceHandler()

Default constructor registers the access service

Method Detail

getProcessHandler

public ProcessHandler getProcessHandler(String userId,
                                        String serverName,
                                        String serviceOperationName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve the process handler for the access service

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)

Returns:

handler for use by the requested instance

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

getRegistrationHandler

public DataEngineRegistrationHandler getRegistrationHandler(String userId,
                                                            String serverName,
                                                            String serviceOperationName)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the registration handler for the access service

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of called operation

Returns:

handler for use by the requested instance

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

getDataEngineSchemaTypeHandler

public DataEngineSchemaTypeHandler getDataEngineSchemaTypeHandler(String userId,
                                                                  String serverName,
                                                                  String serviceOperationName)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException

Retrieve the data engine schema type handler for the access service

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)

Returns:

handler for use by the requested instance

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

getPortHandler

public PortHandler getPortHandler(String userId,
                                  String serverName,
                                  String serviceOperationName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Retrieve the port handler for the access service

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)

Returns:

handler for use by the requested instance

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

getInTopicConnection

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

Return the connection used in the client to create a connector to access events to the input 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)

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