Package org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers

Class ConnectorTypeHandler

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.RootHandler

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.ConnectorTypeHandler

public class ConnectorTypeHandler
extends RootHandler

ConnectorTypeHandler manages the ConnectorType entity found within a connection object. The ConnectorType entity describes the type of connector used to access a specific type of asset. It may belong to multiple connections. This means it must be handled assuming it may be part of many constructs. This is particularly important on delete.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.RootHandler

invalidParameterHandler, repositoryHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

Constructor	Description
ConnectorTypeHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper)	Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
ConnectorType	getConnectorType(String userId, String connectorTypeGUID)	Retrieve the requested connectorType object.
void	removeConnectorType(String userId, String externalSourceGUID, String externalSourceName, String connectorTypeGUID)	Remove the requested ConnectorType if it is no longer connected to any other connection or server definition.
String	saveConnectorType(String userId, String externalSourceGUID, String externalSourceName, ConnectorType connectorType)	Verify that the ConnectorType object is stored in the repository and create it if it is not.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.RootHandler

getRepositoryHelper, getServiceName

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorTypeHandler

public ConnectorTypeHandler(String serviceName,
                            String serverName,
                            InvalidParameterHandler invalidParameterHandler,
                            RepositoryHandler repositoryHandler,
                            OMRSRepositoryHelper repositoryHelper)

Construct the handler information needed to interact with the repository services

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

Method Detail

saveConnectorType

public String saveConnectorType(String userId,
                                String externalSourceGUID,
                                String externalSourceName,
                                ConnectorType connectorType)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Verify that the ConnectorType object is stored in the repository and create it if it is not. If the connectorType is located, there is no check that the connectorType values are equal to those in the supplied connectorType object.

Parameters:

userId - calling userId

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

connectorType - object to add

Returns:

unique identifier of the connectorType in the repository.

Throws:

InvalidParameterException - the connectorType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeConnectorType

public void removeConnectorType(String userId,
                                String externalSourceGUID,
                                String externalSourceName,
                                String connectorTypeGUID)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Remove the requested ConnectorType if it is no longer connected to any other connection or server definition.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

connectorTypeGUID - object to delete

Throws:

InvalidParameterException - the entity guid is not known

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getConnectorType

public ConnectorType getConnectorType(String userId,
                                      String connectorTypeGUID)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Retrieve the requested connectorType object.

Parameters:

userId - calling user

connectorTypeGUID - unique identifier of the connectorType object.

Returns:

ConnectorType bean

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server