java.lang.Object
- org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler
- - org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler
  - - org.odpi.openmetadata.commonservices.multitenant.OMASServiceInstanceHandler
    - - org.odpi.openmetadata.accessservices.dataengine.server.admin.DataEngineInstanceHandler

```
public class DataEngineInstanceHandler
extends OMASServiceInstanceHandler
```
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 Description

DataEngineInstanceHandler()
Default constructor registers the access service

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DataEngineCollectionHandler`	`getCollectionHandler(String userId, String serverName, String serviceOperationName)`
`DataEngineCommonHandler`	`getCommonHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the common handler for the access service
`DataEngineConnectionAndEndpointHandler`	`getConnectionAndEndpointHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the connection and endpoint handler for the access service
`DataEngineSchemaTypeHandler`	`getDataEngineSchemaTypeHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the data engine schema type handler for the access service
`DataEngineDataFileHandler`	`getDataFileHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the DataFile handler for the access service
`DataEngineEventTypeHandler`	`getEventTypeHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the event type handler for the access service
`DataEngineFindHandler`	`getFindHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the find handler for the access service
`DataEngineFolderHierarchyHandler`	`getFolderHierarchyHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the folder hierarchy 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.
`DataEnginePortHandler`	`getPortHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the port handler for the access service
`DataEngineProcessHandler`	`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
`DataEngineRelationalDataHandler`	`getRelationalDataHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the port handler for the access service
`DataEngineTopicHandler`	`getTopicHandler(String userId, String serverName, String serviceOperationName)`	Retrieve the topic handler for the access service

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMASServiceInstanceHandler
getDefaultZones, getDefaultZones, getErrorHandler, getExceptionHandler, getInTopicConnection, getMetadataCollection, getOutTopicConnection, 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 DataEngineProcessHandler 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

getCollectionHandler

public DataEngineCollectionHandler getCollectionHandler(String userId,
                                                        String serverName,
                                                        String serviceOperationName)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Throws:: InvalidParameterException; UserNotAuthorizedException; PropertyServerException

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

getCommonHandler

public DataEngineCommonHandler getCommonHandler(String userId,
                                                String serverName,
                                                String serviceOperationName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Retrieve the common 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 DataEnginePortHandler 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

getRelationalDataHandler

public DataEngineRelationalDataHandler getRelationalDataHandler(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

getDataFileHandler

public DataEngineDataFileHandler getDataFileHandler(String userId,
                                                    String serverName,
                                                    String serviceOperationName)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the DataFile 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

getFolderHierarchyHandler

public DataEngineFolderHierarchyHandler getFolderHierarchyHandler(String userId,
                                                                  String serverName,
                                                                  String serviceOperationName)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException

Retrieve the folder hierarchy 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

getConnectionAndEndpointHandler

public DataEngineConnectionAndEndpointHandler getConnectionAndEndpointHandler(String userId,
                                                                              String serverName,
                                                                              String serviceOperationName)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException

Retrieve the connection and endpoint 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

getFindHandler

public DataEngineFindHandler getFindHandler(String userId,
                                            String serverName,
                                            String serviceOperationName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve the find 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

getTopicHandler

public DataEngineTopicHandler getTopicHandler(String userId,
                                              String serverName,
                                              String serviceOperationName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the topic 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

getEventTypeHandler

public DataEngineEventTypeHandler getEventTypeHandler(String userId,
                                                      String serverName,
                                                      String serviceOperationName)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Retrieve the event 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

Class DataEngineInstanceHandler

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

DataEngineInstanceHandler