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, DataEngineCommonHandler dataEngineCommonHandler) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
void	addPortDelegationRelationship(String userId, String portGUID, PortType portType, String delegatesToQualifiedName, String externalSourceName) Create a PortDelegation relationship between two ports.
void	addPortSchemaRelationship(String userId, String portGUID, String schemaTypeGUID, String externalSourceName) Create a PortSchema relationship between a Port and the corresponding SchemaType.
String	createPortAlias(String userId, PortAlias portAlias, String externalSourceName) Create the port alias
String	createPortImplementation(String userId, PortImplementation portImplementation, String externalSourceName) Create the port implementation
Optional<EntityDetail>	findPortAliasEntity(String userId, String qualifiedName) Find out if the PortAlias object is already stored in the repository.
Optional<EntityDetail>	findPortEntity(String userId, String qualifiedName) Find out if the Port object is already stored in the repository.
Optional<EntityDetail>	findPortImplementationEntity(String userId, String qualifiedName) Find out if the PortImplementation object is already stored in the repository.
String	findSchemaTypeForPort(String userId, String portGUID) Retrieve the schema type that is linked to the port
void	removePort(String userId, String portGUID, String entityTypeName) Remove the port
void	updatePortAlias(String userId, EntityDetail originalPortEntity, PortAlias portAlias) Update the port alias
void	updatePortImplementation(String userId, EntityDetail originalPortEntity, PortImplementation portImplementation) Update 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,
                   DataEngineCommonHandler dataEngineCommonHandler)

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

dataEngineCommonHandler - provides utilities for manipulating entities

Method Detail

createPortImplementation

public String createPortImplementation(String userId,
                                       PortImplementation portImplementation,
                                       String externalSourceName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create the port implementation

Parameters:

userId - the name of the calling user

portImplementation - the port implementation values

externalSourceName - the unique name of the external source

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

createPortAlias

public String createPortAlias(String userId,
                              PortAlias portAlias,
                              String externalSourceName)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Create the port alias

Parameters:

userId - the name of the calling user

portAlias - the port alias values

externalSourceName - the unique name of the external source

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

updatePortImplementation

public void updatePortImplementation(String userId,
                                     EntityDetail originalPortEntity,
                                     PortImplementation portImplementation)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Update the port implementation

Parameters:

userId - the name of the calling user

originalPortEntity - the created port entity

portImplementation - the port implementation new values

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updatePortAlias

public void updatePortAlias(String userId,
                            EntityDetail originalPortEntity,
                            PortAlias portAlias)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Update the port alias

Parameters:

userId - the name of the calling user

originalPortEntity - the created port entity

portAlias - the port alias new values

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,
                                      String externalSourceName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Create a PortSchema relationship between a Port and the corresponding SchemaType. Verifies that the relationship is not present before creating it

Parameters:

userId - the name of the calling user

portGUID - the unique identifier of the port

schemaTypeGUID - the unique identifier of the schema type

externalSourceName - the unique name of the external source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findSchemaTypeForPort

public String findSchemaTypeForPort(String userId,
                                    String portGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the schema type that is linked to the port

Parameters:

userId - the name of the calling user

portGUID - the unique identifier of the port

Returns:

The unique identifier for the retrieved schema type or null

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addPortDelegationRelationship

public void addPortDelegationRelationship(String userId,
                                          String portGUID,
                                          PortType portType,
                                          String delegatesToQualifiedName,
                                          String externalSourceName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create a PortDelegation relationship between two ports. Verifies that the relationship is not present before creating it

Parameters:

userId - the name of the calling user

portGUID - the unique identifier of the source port

portType - the type of the source port

delegatesToQualifiedName - the unique identifier of the target port

externalSourceName - the unique name of the external source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removePort

public void removePort(String userId,
                       String portGUID,
                       String entityTypeName)
                throws InvalidParameterException,
                       PropertyServerException,
                       UserNotAuthorizedException

Remove the port

Parameters:

userId - the name of the calling user

portGUID - the unique identifier of the port to be removed

entityTypeName - the type name

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findPortImplementationEntity

public Optional<EntityDetail> findPortImplementationEntity(String userId,
                                                           String qualifiedName)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Find out if the PortImplementation object is already stored in the repository. It uses the fully qualified name to retrieve the entity

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process to be searched

Returns:

optional with entity details if found, empty optional if not found

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findPortAliasEntity

public Optional<EntityDetail> findPortAliasEntity(String userId,
                                                  String qualifiedName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Find out if the PortAlias object is already stored in the repository. It uses the fully qualified name to retrieve the entity

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process to be searched

Returns:

optional with entity details if found, empty optional if not found

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findPortEntity

public Optional<EntityDetail> findPortEntity(String userId,
                                             String qualifiedName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Find out if the Port object is already stored in the repository. It uses the fully qualified name to retrieve the entity.

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process to be searched

Returns:

optional with entity details if found, empty optional if not found

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server