org.odpi.openmetadata.commonservices.multitenant

Class GovernanceServerServiceInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.GovernanceServerServiceInstanceHandler

Direct Known Subclasses:

OMESServiceInstanceHandler

public class GovernanceServerServiceInstanceHandler
extends AuditableServerServiceInstanceHandler

GovernanceServerServiceInstanceHandler provides the base class for a governance server's instance handler.

Field Summary

Fields

Modifier and Type	Field and Description
protected InvalidParameterHandler	invalidParameterHandler

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

platformInstanceMap, serviceName

Constructor Summary

Constructors

Constructor and Description
GovernanceServerServiceInstanceHandler(String serviceName) Constructor passes the service name that is used on all calls to this instance.

Method Summary

Modifier and Type	Method and Description
ConnectorType	validateConnector(String connectorProviderClassName, Class<?> requiredConnectorInterface, String serviceName) Return the connector type for the requested connector provider after validating that the resulting connector implements the correct interface.

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

Field Detail

invalidParameterHandler

protected final InvalidParameterHandler invalidParameterHandler

Constructor Detail

GovernanceServerServiceInstanceHandler

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

validateConnector

public ConnectorType validateConnector(String connectorProviderClassName,
                                       Class<?> requiredConnectorInterface,
                                       String serviceName)
                                throws InvalidParameterException,
                                       ConnectionCheckedException,
                                       ConnectorCheckedException,
                                       ClassNotFoundException,
                                       InstantiationException,
                                       IllegalAccessException

Return the connector type for the requested connector provider after validating that the resulting connector implements the correct interface. This method is for tools that are configuring connector into an Egeria governance server. Each integration service/engine service has a specific REST API endpoint for their service. The configuration tool calls it and this method is called. Because the method is in the instance handler, a result can be returned for all registered services (the service does not need to be configured and running).

Parameters:

connectorProviderClassName - name of the connector provider class

requiredConnectorInterface - connector interface class

serviceName - service name

Returns:

ConnectorType bean

Throws:

InvalidParameterException - one of the parameters is null

ConnectionCheckedException - the connection passed to the connector provider is not valid

ConnectorCheckedException - the connector is not valid

ClassNotFoundException - when the provided class cannot be found

InstantiationException - when the provided class cannot be instantiated

IllegalAccessException - when there is insufficient access to instantiate the provided class