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

Class EndpointHandler

java.lang.Object

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

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

public class EndpointHandler
extends RootHandler

EndpointHandler manages the Endpoint entity found within a connection object. The Endpoint entity describes the network location of a specific asset. It may belong to multiple connections as well as being part of a SoftWareServer definition. 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
EndpointHandler(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
Endpoint	getEndpoint(String userId, String endpointGUID)	Retrieve the requested endpoint object.
List<Endpoint>	getEndpointsByNetworkAddress(String userId, String networkAddress, int startFrom, int pageSize, String methodName)	Retrieve the list of endpoint objects that have the supplied network address.
void	removeEndpoint(String userId, String externalSourceGUID, String externalSourceName, String endpointGUID)	Remove the requested Endpoint if it is no longer connected to any other connection or server definition.
String	saveEndpoint(String userId, String externalSourceGUID, String externalSourceName, Endpoint endpoint)	Verify that the Endpoint 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

EndpointHandler

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

saveEndpoint

public String saveEndpoint(String userId,
                           String externalSourceGUID,
                           String externalSourceName,
                           Endpoint endpoint)
                    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

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

removeEndpoint

public void removeEndpoint(String userId,
                           String externalSourceGUID,
                           String externalSourceName,
                           String endpointGUID)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Remove the requested Endpoint 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

endpointGUID - 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

getEndpoint

public Endpoint getEndpoint(String userId,
                            String endpointGUID)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Retrieve the requested endpoint object.

Parameters:

userId - calling user

endpointGUID - unique identifier of the endpoint object.

Returns:

Endpoint bean

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getEndpointsByNetworkAddress

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

Retrieve the list of endpoint objects that have the supplied network address.

Parameters:

userId - calling user

networkAddress - address to query on

startFrom - place to start in query

pageSize - number of results to return

methodName - calling method

Returns:

list of matching Endpoint beans

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server