org.odpi.openmetadata.commonservices.generichandlers

Class EndpointHandler<B>

java.lang.Object

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

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

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

public class EndpointHandler<B>
extends ReferenceableHandler<B>

EndpointHandler manages Endpoint 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. EndpointHandler runs server-side in the OMAG Server Platform and retrieves Endpoint 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

EndpointHandler(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	countEndpoints(String userId, String elementGUID, String methodName) Count the number of informal endpoints attached to a supplied entity.
String	createEndpoint(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String networkAddress, String protocol, String encryptionMethod, Map<String,String> additionalProperties, String methodName) Creates a new endpoint and returns the unique identifier for it.
String	getEndpointForConnection(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String networkAddress, String protocol, String encryptionMethod, Map<String,String> additionalProperties, String methodName) Retrieves an endpoint based on network address.
List<B>	getEndpointsByNetworkAddress(String userId, String networkAddress, String networkAddressParameterName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Return the list of endpoints exactly matching the supplied network address.
String	saveEndpoint(String userId, String externalSourceGUID, String externalSourceName, Endpoint endpoint, String methodName) Verify that the Endpoint object is stored in the repository and create it if it is not.
void	updateEndpoint(String userId, String externalSourceGUID, String externalSourceName, String endpointGUID, String endpointGUIDParameterName, String qualifiedName, String displayName, String description, String networkAddress, String protocol, String encryptionMethod, Map<String,String> additionalProperties, String methodName) Updates the properties of an existing endpoint.

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

EndpointHandler

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

saveEndpoint

public String saveEndpoint(String userId,
                           String externalSourceGUID,
                           String externalSourceName,
                           Endpoint endpoint,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

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

endpoint - object to add

methodName - calling method

Returns:

unique identifier of the endpoint in the repository.

Throws:

InvalidParameterException - the endpoint bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createEndpoint

public String createEndpoint(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String anchorGUID,
                             String qualifiedName,
                             String displayName,
                             String description,
                             String networkAddress,
                             String protocol,
                             String encryptionMethod,
                             Map<String,String> additionalProperties,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Creates a new endpoint 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 - the unique identifier for the anchor entity (null for unanchored endpoints)

qualifiedName - unique name of the endpoint

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

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

networkAddress - the network address (typically the URL but this depends on the protocol)

protocol - the name of the protocol to use to connect to the endpoint

encryptionMethod - encryption method to use when passing data to this endpoint

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

methodName - calling method

Returns:

GUID for new endpoint

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

getEndpointForConnection

public String getEndpointForConnection(String userId,
                                       String externalSourceGUID,
                                       String externalSourceName,
                                       String anchorGUID,
                                       String qualifiedName,
                                       String displayName,
                                       String description,
                                       String networkAddress,
                                       String protocol,
                                       String encryptionMethod,
                                       Map<String,String> additionalProperties,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Retrieves an endpoint based on network address. Returns it if found. If not creates a new endpoint 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 - the unique identifier for the anchor entity (null for unanchored endpoints)

qualifiedName - unique name of the endpoint

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

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

networkAddress - the network address (typically the URL but this depends on the protocol)

protocol - the name of the protocol to use to connect to the endpoint

encryptionMethod - encryption method to use when passing data to this endpoint

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

methodName - calling method

Returns:

GUID for endpoint

Throws:

InvalidParameterException - one of the parameters is null or invalid.

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

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

updateEndpoint

public void updateEndpoint(String userId,
                           String externalSourceGUID,
                           String externalSourceName,
                           String endpointGUID,
                           String endpointGUIDParameterName,
                           String qualifiedName,
                           String displayName,
                           String description,
                           String networkAddress,
                           String protocol,
                           String encryptionMethod,
                           Map<String,String> additionalProperties,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Updates the properties of an existing endpoint.

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

endpointGUID - unique identifier for the endpoint

endpointGUIDParameterName - parameter providing endpointGUID

qualifiedName - unique name of the endpoint

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

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

networkAddress - the network address (typically the URL but this depends on the protocol)

protocol - the name of the protocol to use to connect to the endpoint

encryptionMethod - encryption method to use when passing data to this endpoint

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 endpoint properties to the property server.

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

countEndpoints

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

Count the number of informal endpoints 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

getEndpointsByNetworkAddress

public List<B> getEndpointsByNetworkAddress(String userId,
                                            String networkAddress,
                                            String networkAddressParameterName,
                                            List<String> serviceSupportedZones,
                                            int startFrom,
                                            int pageSize,
                                            String methodName)
                                     throws InvalidParameterException,
                                            PropertyServerException,
                                            UserNotAuthorizedException

Return the list of endpoints exactly matching the supplied network address.

Parameters:

userId - the the calling user

networkAddress - network address of endpoint

networkAddressParameterName - parameter providing endpoint

serviceSupportedZones - list of supported zones for this service

startFrom - index of the list ot start from (0 for start)

pageSize - maximum number of elements to return

methodName - calling method

Returns:

endpoint list

Throws:

InvalidParameterException - the userId is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

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