Package org.odpi.openmetadata.frameworks.openmetadata.connectorcontext

Class SolutionPortClient

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.SolutionPortClient

public class SolutionPortClient
extends ConnectorContextClientBase

SolutionPortClient provides methods to define solution ports and attach them to the solution components that expose them, and to the ports of subcomponents that they delegate to.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

asOfTimeDefault, auditLog, connectorGUID, connectorUserId, egeriaRelease, externalSourceGUID, externalSourceIsHome, externalSourceName, forDuplicateProcessing, forLineage, governanceZonesFilterDefault, limitResultsByStatusDefault, localServerName, localServiceName, maxPageSize, parentContext, propertyHelper, sequencingOrderDefault, sequencingPropertyDefault, useCurrentEffectiveTime

Constructor Summary

Constructors

Constructor	Description
SolutionPortClient(ConnectorContextBase parentContext, String localServerName, String localServiceName, String connectorUserId, String connectorGUID, String externalSourceGUID, String externalSourceName, OpenMetadataClient openMetadataClient, AuditLog auditLog, int maxPageSize)	Constructor for connector context client.

Method Summary

Modifier and Type	Method	Description
String	createSolutionPort(NewElementOptions newElementOptions, Map<String,ClassificationProperties> initialClassifications, SolutionPortProperties properties, RelationshipProperties parentRelationshipProperties)	Create a new solution port.
String	createSolutionPortFromTemplate(TemplateOptions templateOptions, String templateGUID, EntityProperties replacementProperties, Map<String,ClassificationProperties> replacementClassifications, Map<String,String> placeholderProperties, RelationshipProperties parentRelationshipProperties)	Create a new metadata element to represent a solution port using an existing element as a template.
void	deleteSolutionPort(String solutionPortGUID, DeleteOptions deleteOptions)	Delete a solution port.
void	detachSolutionComponentPort(String solutionComponentGUID, String solutionPortGUID, DeleteOptions deleteOptions)	Detach a solution port from the solution component that exposed it.
void	detachSolutionPortDelegation(String alignsToPortGUID, String delegationPortGUID, DeleteOptions deleteOptions)	Detach a solution port from the solution port that it delegated to.
List<OpenMetadataRootElement>	findSolutionPorts(String searchString, SearchOptions searchOptions)	Retrieve the list of solution ports that contain the search string.
OpenMetadataRootElement	getSolutionPortByGUID(String solutionPortGUID, GetOptions getOptions)	Return the properties of a specific solution port.
List<OpenMetadataRootElement>	getSolutionPortsByName(String name, QueryOptions queryOptions)	Returns the list of solution ports with a particular name.
void	linkSolutionComponentPort(String solutionComponentGUID, String solutionPortGUID, MakeAnchorOptions makeAnchorOptions, SolutionComponentPortProperties relationshipProperties)	Attach a solution port to the solution component that exposes it.
void	linkSolutionPortDelegation(String alignsToPortGUID, String delegationPortGUID, MakeAnchorOptions makeAnchorOptions, SolutionPortDelegationProperties relationshipProperties)	Attach a solution port to the solution port that it delegates to.
boolean	updateSolutionPort(String solutionPortGUID, UpdateOptions updateOptions, SolutionPortProperties properties)	Update the properties of a solution port.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.connectorcontext.ConnectorContextClientBase

getAdditionalProperties, getConnectorGUID, getDeleteOptions, getDisplayName, getDisplayName, getDisplayName, getEffectiveTime, getEgeriaRelease, getGetOptions, getMakeAnchorOptions, getMaxPagingSize, getMetadataSourceOptions, getNewElementProperties, getQualifiedName, getQueryOptions, getQueryOptions, getQueryOptions, getQueryOptions, getSearchOptions, getSearchOptions, getSearchOptions, getUpdateOptions, isForDuplicateProcessing, isForLineage, isUseCurrentEffectiveTime, publishElement, setAsOfTimeDefault, setEffectiveTimeDefault, setExternalSource, setExternalSourceIsHome, setForDuplicateProcessing, setForLineage, setGovernanceZonesFilterDefault, setLimitResultsByStatusDefault, setSequencingOrderDefault, setUseCurrentEffectiveTime, withdrawElement

Methods inherited from class java.lang.Object

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

Constructor Details

SolutionPortClient

public SolutionPortClient(ConnectorContextBase parentContext,
 String localServerName,
 String localServiceName,
 String connectorUserId,
 String connectorGUID,
 String externalSourceGUID,
 String externalSourceName,
 OpenMetadataClient openMetadataClient,
 AuditLog auditLog,
 int maxPageSize)

Constructor for connector context client.

Parameters:

parentContext - connector's context

localServerName - local server where this client is running - called the local server

localServiceName - name of this service

connectorUserId - userId to use when issuing open metadata requests

connectorGUID - unique identifier of the connector element that describes this connector in the open metadata store(s)

externalSourceGUID - unique identifier of the software server capability for the source of metadata

externalSourceName - unique name of the software server capability for the source of metadata

openMetadataClient - client to access the open metadata store

auditLog - logging destination

maxPageSize - max number of elements that can be returned on a query

Method Details

createSolutionPort

public String createSolutionPort(NewElementOptions newElementOptions,
 Map<String,ClassificationProperties> initialClassifications,
 SolutionPortProperties properties,
 RelationshipProperties parentRelationshipProperties)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create a new solution port.

Parameters:

newElementOptions - details of the element to create

initialClassifications - map of classification names to classification properties to include in the entity creation request

properties - properties for the new element.

parentRelationshipProperties - properties to include in parent relationship

Returns:

unique identifier of the newly created element

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

createSolutionPortFromTemplate

public String createSolutionPortFromTemplate(TemplateOptions templateOptions,
 String templateGUID,
 EntityProperties replacementProperties,
 Map<String,ClassificationProperties> replacementClassifications,
 Map<String,String> placeholderProperties,
 RelationshipProperties parentRelationshipProperties)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a solution port using an existing element as a template. The template defines additional classifications and relationships that should be added to the new solution port.

Parameters:

templateOptions - details of the element to create

templateGUID - the unique identifier of the existing element to copy

replacementProperties - properties that override the template

replacementClassifications - classifications that override the template

placeholderProperties - property name-to-property value map to replace any placeholder values in the template element - and their anchored elements, which are also copied as part of this operation.

parentRelationshipProperties - properties to include in parent relationship

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateSolutionPort

public boolean updateSolutionPort(String solutionPortGUID,
 UpdateOptions updateOptions,
 SolutionPortProperties properties)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Update the properties of a solution port.

Parameters:

solutionPortGUID - unique identifier of the solution port (returned from create)

updateOptions - provides a structure for the additional options when updating an element.

properties - properties for the element.

Returns:

boolean - true if an update occurred

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

deleteSolutionPort

public void deleteSolutionPort(String solutionPortGUID,
 DeleteOptions deleteOptions)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Delete a solution port.

Parameters:

solutionPortGUID - unique identifier of the element

deleteOptions - options for a delete request

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

getSolutionPortsByName

public List<OpenMetadataRootElement> getSolutionPortsByName(String name,
 QueryOptions queryOptions)
                                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Returns the list of solution ports with a particular name.

Parameters:

name - name of the element to return - match is full text match in qualifiedName, identifier or displayName

queryOptions - multiple options to control the query

Returns:

a list of elements

Throws:

InvalidParameterException - one of the parameters 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.

getSolutionPortByGUID

public OpenMetadataRootElement getSolutionPortByGUID(String solutionPortGUID,
 GetOptions getOptions)
                                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Return the properties of a specific solution port.

Parameters:

solutionPortGUID - unique identifier of the required element

getOptions - multiple options to control the query

Returns:

retrieved properties

Throws:

InvalidParameterException - one of the parameters 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.

findSolutionPorts

public List<OpenMetadataRootElement> findSolutionPorts(String searchString,
 SearchOptions searchOptions)
                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of solution ports that contain the search string.

Parameters:

searchString - string to find in the properties

searchOptions - multiple options to control the query

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

linkSolutionComponentPort

public void linkSolutionComponentPort(String solutionComponentGUID,
 String solutionPortGUID,
 MakeAnchorOptions makeAnchorOptions,
 SolutionComponentPortProperties relationshipProperties)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach a solution port to the solution component that exposes it.

Parameters:

solutionComponentGUID - unique identifier of the solution component

solutionPortGUID - unique identifier of the solution port

makeAnchorOptions - options to control access to open metadata

relationshipProperties - description of the relationship.

Throws:

InvalidParameterException - one of the parameters 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.

detachSolutionComponentPort

public void detachSolutionComponentPort(String solutionComponentGUID,
 String solutionPortGUID,
 DeleteOptions deleteOptions)
                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach a solution port from the solution component that exposed it.

Parameters:

solutionComponentGUID - unique identifier of the solution component

solutionPortGUID - unique identifier of the solution port

deleteOptions - options to control access to open metadata

Throws:

InvalidParameterException - one of the parameters 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.

linkSolutionPortDelegation

public void linkSolutionPortDelegation(String alignsToPortGUID,
 String delegationPortGUID,
 MakeAnchorOptions makeAnchorOptions,
 SolutionPortDelegationProperties relationshipProperties)
                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Attach a solution port to the solution port that it delegates to.

Parameters:

alignsToPortGUID - unique identifier of the solution port that is aligned to

delegationPortGUID - unique identifier of the solution port that delegates

makeAnchorOptions - options to control access to open metadata

relationshipProperties - description of the relationship.

Throws:

InvalidParameterException - one of the parameters 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.

detachSolutionPortDelegation

public void detachSolutionPortDelegation(String alignsToPortGUID,
 String delegationPortGUID,
 DeleteOptions deleteOptions)
                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Detach a solution port from the solution port that it delegated to.

Parameters:

alignsToPortGUID - unique identifier of the solution port that is aligned to

delegationPortGUID - unique identifier of the solution port that delegates

deleteOptions - options to control access to open metadata

Throws:

InvalidParameterException - one of the parameters 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.