org.odpi.openmetadata.accessservices.dataengine.server.handlers

Class PortHandler

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.handlers.PortHandler

public class PortHandler
extends Object

PortHandler manages Port objects from the property server. It runs server-side in the DataEngine OMAS and creates port entities with wire relationships through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description
PortHandler(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 and Description
void	addPortSchemaRelationship(String userId, String portGUID, String schemaTypeGUID) Create a PortSchema relationship between a Port and the corresponding SchemaType
String	createPortAliasWithDelegation(String userId, String qualifiedName, String displayName, PortType portType, String delegatesTo) Create the Port Alias entity with a PortDelegation relationship
String	createPortImplementation(String userId, String qualifiedName, String displayName, PortType portType) Create the port implementation

Methods inherited from class java.lang.Object

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

Constructor Detail

PortHandler

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

createPortImplementation

public String createPortImplementation(String userId,
                                       String qualifiedName,
                                       String displayName,
                                       PortType portType)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create the port implementation

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the port

displayName - the display name of the port

portType - the type of the port

Returns:

unique identifier of the port implementation in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addPortSchemaRelationship

public void addPortSchemaRelationship(String userId,
                                      String portGUID,
                                      String schemaTypeGUID)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Create a PortSchema relationship between a Port and the corresponding SchemaType

Parameters:

userId - the name of the calling user

portGUID - the unique identifier of the port

schemaTypeGUID - the unique identifier of the schema type

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createPortAliasWithDelegation

public String createPortAliasWithDelegation(String userId,
                                            String qualifiedName,
                                            String displayName,
                                            PortType portType,
                                            String delegatesTo)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Create the Port Alias entity with a PortDelegation relationship

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the port

displayName - the display name of the port

portType - the type of the port

delegatesTo - the qualified name of the delegated port

Returns:

unique identifier of the port alias in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server