org.odpi.openmetadata.commonservices.generichandlers

Class ConnectionHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ConnectionHandler<B>

public class ConnectionHandler<B>
extends ReferenceableHandler<B>

ConnectionHandler manages Connection objects. These describe the network addresses where services are running. They are used by connection objects to describe the service that the connector should call. They are linked to servers to show their network address where the services that they are hosting are running. Most OMASs that work with Connection objects use the Open Connector Framework (OCF) Bean since this can be passed to the OCF Connector Broker to create an instance of a connector to the attached asset. Therefore this handler has a default bean and converter which is the one that works with the OCF bean. The call can either use these values or override with their own bean/converter implementations. ConnectionHandler runs server-side in the OMAG Server Platform and retrieves Connection entities through the OMRSRepositoryConnector via the generic handler and repository handler.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor and Description

ConnectionHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
void	addEmbeddedConnection(String userId, String externalSourceGUID, String externalSourceName, String virtualConnectionGUID, String virtualConnectionGUIDParameterName, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID, String embeddedConnectionGUIDParameterName, String methodName) Link a connection into a virtual connection using the EmbeddedConnection relationship.
int	countConnections(String userId, String assetGUID, String methodName) Count the number of informal connections attached to a supplied asset.
String	createConnection(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String assetSummary, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,String> securedProperties, Map<String,Object> configurationProperties, String connectorUserId, String clearPassword, String encryptedPassword, String connectorTypeGUID, String connectorTypeGUIDParameterName, String endpointGUID, String endpointGUIDParameterName, String methodName) Creates a new connection, connects it to the asset and returns the unique identifier for it.
String	createConnection(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String assetSummary, String connectionTypeId, String connectionTypeName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,String> securedProperties, Map<String,Object> configurationProperties, String connectorUserId, String clearPassword, String encryptedPassword, String connectorTypeGUID, String connectorTypeGUIDParameterName, String endpointGUID, String endpointGUIDParameterName, String methodName) Creates a new connection and returns the unique identifier for it.
String	createVirtualConnection(String userId, String externalSourceGUID, String externalSourceName, String assetGUID, String assetGUIDParameterName, String assetSummary, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,String> securedProperties, Map<String,Object> configurationProperties, String connectorUserId, String clearPassword, String encryptedPassword, String connectorTypeGUID, String connectorTypeGUIDParameterName, String methodName) Creates a new virtual connection and returns the unique identifier for it.
B	getConnectionForAsset(String userId, String assetGUID, String assetGUIDParameterName, List<String> serviceSupportedZones, String methodName) Retrieve the list of connection objects attached to the requested asset object.
B	getConnectionForAsset(String userId, String assetGUID, String assetGUIDParameterName, String methodName) Retrieve the list of connection objects attached to the requested asset object.
List<B>	getConnectionsForAsset(String userId, String assetGUID, String assetGUIDParameterName, List<String> serviceSupportedZones, int startingFrom, int pageSize, String methodName) Retrieve the list of connection objects attached to the requested asset object.
String	saveConnection(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String assetGUID, String assetGUIDParameterName, String assetTypeName, Connection connection, String assetSummary, String methodName) Determine if the Connection object is stored in the repository and create it if it is not.
void	updateConnection(String userId, String externalSourceGUID, String externalSourceName, String connectionGUID, String connectionGUIDParameterName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,String> securedProperties, Map<String,Object> configurationProperties, String connectorUserId, String clearPassword, String encryptedPassword, String typeGUID, String typeName, Map<String,Object> extendedProperties, String methodName) Updates the properties of an existing connection.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler

addSecurityTags, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, removeSecurityTags, removeSemanticAssignment, saveSemanticAssignment, saveSemanticAssignment

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, relinkElementToNewElement, relinkElementToNewElement, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionHandler

public ConnectionHandler(OpenMetadataAPIGenericConverter<B> converter,
                         Class<B> beanClass,
                         String serviceName,
                         String serverName,
                         InvalidParameterHandler invalidParameterHandler,
                         RepositoryHandler repositoryHandler,
                         OMRSRepositoryHelper repositoryHelper,
                         String localServerUserId,
                         OpenMetadataServerSecurityVerifier securityVerifier,
                         List<String> supportedZones,
                         List<String> defaultZones,
                         List<String> publishZones,
                         AuditLog auditLog)

Construct the handler information needed to interact with the repository services

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

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

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve Asset instances from.

defaultZones - list of zones that the access service should set in all new Asset instances.

publishZones - list of zones that the access service sets up in published Asset instances.

auditLog - destination for audit log events.

Method Detail

saveConnection

public String saveConnection(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String anchorGUID,
                             String assetGUID,
                             String assetGUIDParameterName,
                             String assetTypeName,
                             Connection connection,
                             String assetSummary,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Determine if the Connection object is stored in the repository and create it if it is not. If the connection is located, there is no check that the connection values are equal to those in the supplied 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

anchorGUID - unique identifier of the anchor to add to the connection

assetGUID - unique identifier of linked asset (or null)

assetGUIDParameterName - parameter name supplying assetGUID

assetTypeName - type of asset

connection - object to add

assetSummary - description of the asset for the connection

methodName - calling method

Returns:

unique identifier of the connection in the repository.

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createConnection

public String createConnection(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String assetSummary,
                               String qualifiedName,
                               String displayName,
                               String description,
                               Map<String,String> additionalProperties,
                               Map<String,String> securedProperties,
                               Map<String,Object> configurationProperties,
                               String connectorUserId,
                               String clearPassword,
                               String encryptedPassword,
                               String connectorTypeGUID,
                               String connectorTypeGUIDParameterName,
                               String endpointGUID,
                               String endpointGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Creates a new connection, connects it to the asset and returns the unique identifier for it.

Parameters:

userId - userId of user making request

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

assetGUID - the unique identifier for the asset entity (null for stand alone connections)

assetGUIDParameterName - the parameter supplying assetGUID

assetSummary - brief description of the asset for the relationship between the asset and the connection

qualifiedName - unique name

displayName - new value for the display name.

description - new description for the connection.

additionalProperties - additional properties

securedProperties - protected properties

configurationProperties - properties passed to configure underlying technologies

connectorUserId - user identity that the connector should use

clearPassword - password for the userId in clear text

encryptedPassword - encrypted password that the connector needs to decrypt before use

connectorTypeGUID - unique identifier of the connector type to used for this connection

connectorTypeGUIDParameterName - the parameter supplying connectorTypeGUID

endpointGUID - unique identifier of the endpoint to used for this connection

endpointGUIDParameterName - the parameter supplying endpointGUID

methodName - calling method

Returns:

GUID for new connection

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the connection properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createVirtualConnection

public String createVirtualConnection(String userId,
                                      String externalSourceGUID,
                                      String externalSourceName,
                                      String assetGUID,
                                      String assetGUIDParameterName,
                                      String assetSummary,
                                      String qualifiedName,
                                      String displayName,
                                      String description,
                                      Map<String,String> additionalProperties,
                                      Map<String,String> securedProperties,
                                      Map<String,Object> configurationProperties,
                                      String connectorUserId,
                                      String clearPassword,
                                      String encryptedPassword,
                                      String connectorTypeGUID,
                                      String connectorTypeGUIDParameterName,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Creates a new virtual connection and returns the unique identifier for it.

Parameters:

userId - userId of user making request

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

assetGUID - the unique identifier for the asset entity (null for stand alone connections)

assetGUIDParameterName - the parameter supplying assetGUID

assetSummary - brief description of the asset for the relationship between the asset and the connection

qualifiedName - unique name

displayName - new value for the display name.

description - new description for the connection.

additionalProperties - additional properties

securedProperties - protected properties

configurationProperties - properties passed to configure underlying technologies

connectorUserId - user identity that the connector should use

clearPassword - password for the userId in clear text

encryptedPassword - encrypted password that the connector needs to decrypt before use

connectorTypeGUID - unique identifier of the connector type to used for this connection

connectorTypeGUIDParameterName - the parameter supplying connectorTypeGUID

methodName - calling method

Returns:

GUID for new connection

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the connection properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createConnection

public String createConnection(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String assetSummary,
                               String connectionTypeId,
                               String connectionTypeName,
                               String qualifiedName,
                               String displayName,
                               String description,
                               Map<String,String> additionalProperties,
                               Map<String,String> securedProperties,
                               Map<String,Object> configurationProperties,
                               String connectorUserId,
                               String clearPassword,
                               String encryptedPassword,
                               String connectorTypeGUID,
                               String connectorTypeGUIDParameterName,
                               String endpointGUID,
                               String endpointGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Creates a new connection and returns the unique identifier for it.

Parameters:

userId - userId of user making request

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

assetGUID - the unique identifier for the asset entity (null for stand alone connections)

assetGUIDParameterName - the parameter supplying assetGUID

assetSummary - brief description of the asset for the relationship between the asset and the connection

connectionTypeId - type identifier for the connection

connectionTypeName - type name for the connection

qualifiedName - unique name

displayName - new value for the display name.

description - new description for the connection.

additionalProperties - additional properties

securedProperties - protected properties

configurationProperties - properties passed to configure underlying technologies

connectorUserId - user identity that the connector should use

clearPassword - password for the userId in clear text

encryptedPassword - encrypted password that the connector needs to decrypt before use

connectorTypeGUID - unique identifier of the connector type to used for this connection

connectorTypeGUIDParameterName - the parameter supplying connectorTypeGUID

endpointGUID - unique identifier of the endpoint to used for this connection

endpointGUIDParameterName - the parameter supplying endpointGUID

methodName - calling method

Returns:

GUID for new connection

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the connection properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addEmbeddedConnection

public void addEmbeddedConnection(String userId,
                                  String externalSourceGUID,
                                  String externalSourceName,
                                  String virtualConnectionGUID,
                                  String virtualConnectionGUIDParameterName,
                                  int position,
                                  String displayName,
                                  Map<String,Object> arguments,
                                  String embeddedConnectionGUID,
                                  String embeddedConnectionGUIDParameterName,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Link a connection into a virtual connection using the EmbeddedConnection relationship. The properties associated with the EmbeddedConnection relationship are typically used where the connection represents connectors that are part of a dynamic process (such as in an open discovery pipeline).

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

virtualConnectionGUID - unique identifier for the virtual connection

virtualConnectionGUIDParameterName - parameter supplying virtualConnectionGUID

position - position in the virtual connection

displayName - name of the embedded connection

arguments - arguments to use with the embedded connector when created as part of the virtual connector

embeddedConnectionGUID - unique identifier for the embedded connection

embeddedConnectionGUIDParameterName - parameter supplying embeddedConnectionGUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the connection properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

updateConnection

public void updateConnection(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String connectionGUID,
                             String connectionGUIDParameterName,
                             String qualifiedName,
                             String displayName,
                             String description,
                             Map<String,String> additionalProperties,
                             Map<String,String> securedProperties,
                             Map<String,Object> configurationProperties,
                             String connectorUserId,
                             String clearPassword,
                             String encryptedPassword,
                             String typeGUID,
                             String typeName,
                             Map<String,Object> extendedProperties,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Updates the properties of an existing connection.

Parameters:

userId - userId of user making request.

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

connectionGUID - unique identifier for the connection

connectionGUIDParameterName - parameter providing connectionGUID

qualifiedName - unique name

displayName - new value for the display name.

description - new description for the connection.

additionalProperties - additional properties

securedProperties - protected properties

configurationProperties - properties passed to configure underlying technologies

connectorUserId - user identity that the connector should use

clearPassword - password for the userId in clear text

encryptedPassword - encrypted password that the connector needs to decrypt before use

typeGUID - identifier of the type that is a subtype of connection - or null to create standard type

typeName - name of the type that is a subtype of connection - or null to create standard type

extendedProperties - additional properties for the subtype

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem adding the connection properties to the property server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countConnections

public int countConnections(String userId,
                            String assetGUID,
                            String methodName)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Count the number of informal connections attached to a supplied asset.

Parameters:

userId - calling user

assetGUID - identifier for the asset

methodName - calling method

Returns:

count of attached objects

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getConnectionForAsset

public B getConnectionForAsset(String userId,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Retrieve the list of connection objects attached to the requested asset object.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset object

assetGUIDParameterName - parameter name supplying assetGUID

methodName - calling method

Returns:

Connection bean

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getConnectionForAsset

public B getConnectionForAsset(String userId,
                               String assetGUID,
                               String assetGUIDParameterName,
                               List<String> serviceSupportedZones,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Retrieve the list of connection objects attached to the requested asset object.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset object

assetGUIDParameterName - parameter name supplying assetGUID

serviceSupportedZones - list of supported zones for the calling service

methodName - calling method

Returns:

Connection bean

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getConnectionsForAsset

public List<B> getConnectionsForAsset(String userId,
                                      String assetGUID,
                                      String assetGUIDParameterName,
                                      List<String> serviceSupportedZones,
                                      int startingFrom,
                                      int pageSize,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Retrieve the list of connection objects attached to the requested asset object.

Parameters:

userId - calling user

assetGUID - unique identifier of the asset object

assetGUIDParameterName - parameter name supplying assetGUID

serviceSupportedZones - list of supported zones for the calling service

startingFrom - start position for results

pageSize - maximum number of results

methodName - calling method

Returns:

list of Connection bean

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server