org.odpi.openmetadata.commonservices.generichandlers

Class ConnectorTypeHandler<B>

java.lang.Object

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

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

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

public class ConnectorTypeHandler<B>
extends ReferenceableHandler<B>

ConnectorTypeHandler manages ConnectorType objects. These describe the information necessary to construct a connector. They are used by connection objects to describe the connector provider for the connector. ConnectorTypeHandler runs server-side in the OMAG Server Platform and retrieves ConnectorType 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

ConnectorTypeHandler(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
int	countConnectorTypes(String userId, String elementGUID, String methodName) Count the number of informal connectorTypes attached to a supplied entity.
String	createConnectorType(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String connectorProviderClassName, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String,String> additionalProperties, String methodName) Creates a new connectorType and returns the unique identifier for it.
String	getConnectorTypeForConnection(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String connectorProviderClassName, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String,String> additionalProperties, String methodName) Retrieves the connector type for the qualified name and if found, returns its unique identifier.
String	saveConnectorType(String userId, String externalSourceGUID, String externalSourceName, ConnectorType connectorType, String methodName) Verify that the ConnectorType object is stored in the repository and create it if it is not.
void	updateConnectorType(String userId, String externalSourceGUID, String externalSourceName, String connectorTypeGUID, String connectorTypeGUIDParameterName, String qualifiedName, String displayName, String description, String connectorProviderClassName, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String,String> additionalProperties, String methodName) Updates the properties of an existing connectorType.

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

ConnectorTypeHandler

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

saveConnectorType

public String saveConnectorType(String userId,
                                String externalSourceGUID,
                                String externalSourceName,
                                ConnectorType connectorType,
                                String methodName)
                         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

methodName - calling method

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

createConnectorType

public String createConnectorType(String userId,
                                  String externalSourceGUID,
                                  String externalSourceName,
                                  String anchorGUID,
                                  String qualifiedName,
                                  String displayName,
                                  String description,
                                  String connectorProviderClassName,
                                  List<String> recognizedAdditionalProperties,
                                  List<String> recognizedSecuredProperties,
                                  List<String> recognizedConfigurationProperties,
                                  Map<String,String> additionalProperties,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Creates a new connectorType 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

anchorGUID - unique identifier of the anchor entity (or null if free-standing)

qualifiedName - unique name of the connectorType

displayName - human memorable name for the connectorType - does not need to be unique

description - (optional) description of the connectorType. Setting a description, particularly in a public connectorType makes the connectorType more valuable to other users and can act as an embryonic glossary term

connectorProviderClassName - class name of the connector provider.

recognizedAdditionalProperties - property name for additionalProperties in a linked Connection object.

recognizedSecuredProperties - property name for securedProperties in a linked Connection object.

recognizedConfigurationProperties - property name for configurationProperties in a linked Connection object.

additionalProperties - name value pairs for values that are not formally defined in the type system

methodName - calling method

Returns:

GUID for new connectorType

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getConnectorTypeForConnection

public String getConnectorTypeForConnection(String userId,
                                            String externalSourceGUID,
                                            String externalSourceName,
                                            String anchorGUID,
                                            String qualifiedName,
                                            String displayName,
                                            String description,
                                            String connectorProviderClassName,
                                            List<String> recognizedAdditionalProperties,
                                            List<String> recognizedSecuredProperties,
                                            List<String> recognizedConfigurationProperties,
                                            Map<String,String> additionalProperties,
                                            String methodName)
                                     throws InvalidParameterException,
                                            PropertyServerException,
                                            UserNotAuthorizedException

Retrieves the connector type for the qualified name and if found, returns its unique identifier. Otherwise, it creates a new connectorType 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

anchorGUID - unique identifier for the anchor of this connector type (or null if free standing)

qualifiedName - unique name of the connectorType

displayName - human memorable name for the connectorType - does not need to be unique

description - (optional) description of the connectorType. Setting a description, particularly in a public connectorType makes the connectorType more valuable to other users and can act as an embryonic glossary term

connectorProviderClassName - class name of the connector provider.

recognizedAdditionalProperties - property name for additionalProperties in a linked Connection object.

recognizedSecuredProperties - property name for securedProperties in a linked Connection object.

recognizedConfigurationProperties - property name for configurationProperties in a linked Connection object.

additionalProperties - name value pairs for values that are not formally defined in the type system

methodName - calling method

Returns:

GUID for new connectorType

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

updateConnectorType

public void updateConnectorType(String userId,
                                String externalSourceGUID,
                                String externalSourceName,
                                String connectorTypeGUID,
                                String connectorTypeGUIDParameterName,
                                String qualifiedName,
                                String displayName,
                                String description,
                                String connectorProviderClassName,
                                List<String> recognizedAdditionalProperties,
                                List<String> recognizedSecuredProperties,
                                List<String> recognizedConfigurationProperties,
                                Map<String,String> additionalProperties,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Updates the properties of an existing connectorType.

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

connectorTypeGUID - unique identifier for the connectorType

connectorTypeGUIDParameterName - parameter providing connectorTypeGUID

qualifiedName - unique name of the connectorType

displayName - human memorable name for the connectorType - does not need to be unique

description - (optional) description of the connectorType. Setting a description, particularly in a public connectorType makes the connectorType more valuable to other users and can act as an embryonic glossary term

connectorProviderClassName - class name of the connector provider.

recognizedAdditionalProperties - property name for additionalProperties in a linked Connection object.

recognizedSecuredProperties - property name for securedProperties in a linked Connection object.

recognizedConfigurationProperties - property name for configurationProperties in a linked Connection object.

additionalProperties - name value pairs for values that are not formally defined in the type system

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

countConnectorTypes

public int countConnectorTypes(String userId,
                               String elementGUID,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Count the number of informal connectorTypes attached to a supplied entity.

Parameters:

userId - calling user

elementGUID - identifier for the entity that the object is attached to

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