Package org.odpi.openmetadata.accessservices.datamanager.api

Interface ConnectionManagerInterface

public interface ConnectionManagerInterface

ManageConnections provides methods to define connections and their supporting objects The interface supports the following types of objects

• Connections - the connections used to create connector instances that can access the connection.
• ConnectorTypes - description of a specific that can be used to access the connection.
• ConnectorCategories - the network information needed to access the connection.
• Endpoints - the network information needed to access the connection.

Method Summary

Modifier and Type	Method	Description
void	clearAssetConnection(String userId, String dataManagerGUID, String dataManagerName, String assetGUID, String connectionGUID)	Remove a relationship between an asset and its connection.
void	clearConnectorType(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID, String connectorTypeGUID)	Remove a relationship between a connection and a connector type.
void	clearEmbeddedConnection(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID, String embeddedConnectionGUID)	Remove a relationship between a virtual connection and an embedded connection.
void	clearEndpoint(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID, String endpointGUID)	Remove a relationship between a connection and an endpoint.
String	createConnection(String userId, String dataManagerGUID, String dataManagerName, ConnectionProperties connectionProperties)	Create a new metadata element to represent the connection.
String	createConnectionFromTemplate(String userId, String dataManagerGUID, String dataManagerName, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a connection using an existing metadata element as a template.
String	createEndpoint(String userId, String dataManagerGUID, String dataManagerName, EndpointProperties endpointProperties)	Create a new metadata element to represent the endpoint.
String	createEndpointFromTemplate(String userId, String dataManagerGUID, String dataManagerName, String networkAddress, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a endpoint using an existing metadata element as a template.
List<ConnectionElement>	findConnections(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of asset metadata elements that contain the search string.
List<ConnectorTypeElement>	findConnectorTypes(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of connectorType metadata elements that contain the search string.
List<EndpointElement>	findEndpoints(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of endpoint metadata elements that contain the search string.
ConnectionElement	getConnectionByGUID(String userId, String connectionGUID)	Retrieve the connection metadata element with the supplied unique identifier.
List<ConnectionElement>	getConnectionsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of asset metadata elements with a matching qualified or display name.
ConnectorTypeElement	getConnectorTypeByGUID(String userId, String connectorTypeGUID)	Retrieve the connectorType metadata element with the supplied unique identifier.
List<ConnectorTypeElement>	getConnectorTypesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of connectorType metadata elements with a matching qualified or display name.
EndpointElement	getEndpointByGUID(String userId, String endpointGUID)	Retrieve the endpoint metadata element with the supplied unique identifier.
List<EndpointElement>	getEndpointsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of endpoint metadata elements with a matching qualified or display name.
void	removeConnection(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID)	Remove the metadata element representing a connection.
void	removeEndpoint(String userId, String dataManagerGUID, String dataManagerName, String endpointGUID)	Remove the metadata element representing a endpoint.
void	setupAssetConnection(String userId, String dataManagerGUID, String dataManagerName, String assetGUID, String assetSummary, String connectionGUID)	Create a relationship between an asset and its connection.
void	setupConnectorType(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID, String connectorTypeGUID)	Create a relationship between a connection and a connector type.
void	setupEmbeddedConnection(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID)	Create a relationship between a virtual connection and an embedded connection.
void	setupEndpoint(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID, String endpointGUID)	Create a relationship between a connection and an endpoint.
void	updateConnection(String userId, String dataManagerGUID, String dataManagerName, String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)	Update the metadata element representing a connection.
void	updateEndpoint(String userId, String dataManagerGUID, String dataManagerName, boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)	Update the metadata element representing a endpoint.

Method Detail

createConnection

String createConnection(String userId,
                        String dataManagerGUID,
                        String dataManagerName,
                        ConnectionProperties connectionProperties)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Create a new metadata element to represent the connection.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionProperties - properties to store

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)

createConnectionFromTemplate

String createConnectionFromTemplate(String userId,
                                    String dataManagerGUID,
                                    String dataManagerName,
                                    String templateGUID,
                                    TemplateProperties templateProperties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

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

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

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)

updateConnection

void updateConnection(String userId,
                      String dataManagerGUID,
                      String dataManagerName,
                      String connectionGUID,
                      boolean isMergeUpdate,
                      ConnectionProperties connectionProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the metadata element representing a connection.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

connectionProperties - new properties for this 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)

setupConnectorType

void setupConnectorType(String userId,
                        String dataManagerGUID,
                        String dataManagerName,
                        String connectionGUID,
                        String connectorTypeGUID)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Create a relationship between a connection and a connector type.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the connection in the external data manager

connectorTypeGUID - unique identifier of the connector type in the external data manager

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)

clearConnectorType

void clearConnectorType(String userId,
                        String dataManagerGUID,
                        String dataManagerName,
                        String connectionGUID,
                        String connectorTypeGUID)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Remove a relationship between a connection and a connector type.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the connection in the external data manager

connectorTypeGUID - unique identifier of the connector type in the external data manager

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)

setupEndpoint

void setupEndpoint(String userId,
                   String dataManagerGUID,
                   String dataManagerName,
                   String connectionGUID,
                   String endpointGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException

Create a relationship between a connection and an endpoint.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the connection in the external data manager

endpointGUID - unique identifier of the endpoint in the external data manager

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)

clearEndpoint

void clearEndpoint(String userId,
                   String dataManagerGUID,
                   String dataManagerName,
                   String connectionGUID,
                   String endpointGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException

Remove a relationship between a connection and an endpoint.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the connection in the external data manager

endpointGUID - unique identifier of the endpoint in the external data manager

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)

setupEmbeddedConnection

void setupEmbeddedConnection(String userId,
                             String dataManagerGUID,
                             String dataManagerName,
                             String connectionGUID,
                             int position,
                             String displayName,
                             Map<String,Object> arguments,
                             String embeddedConnectionGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create a relationship between a virtual connection and an embedded connection.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the virtual connection in the external data manager

position - which order should this connection be processed

arguments - What additional properties should be passed to the embedded connector via the configuration properties

displayName - what does this connector signify?

embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager

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)

clearEmbeddedConnection

void clearEmbeddedConnection(String userId,
                             String dataManagerGUID,
                             String dataManagerName,
                             String connectionGUID,
                             String embeddedConnectionGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove a relationship between a virtual connection and an embedded connection.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the virtual connection in the external data manager

embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager

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)

setupAssetConnection

void setupAssetConnection(String userId,
                          String dataManagerGUID,
                          String dataManagerName,
                          String assetGUID,
                          String assetSummary,
                          String connectionGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Create a relationship between an asset and its connection.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the asset

assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.

connectionGUID - unique identifier of the connection

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)

clearAssetConnection

void clearAssetConnection(String userId,
                          String dataManagerGUID,
                          String dataManagerName,
                          String assetGUID,
                          String connectionGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Remove a relationship between an asset and its connection.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

assetGUID - unique identifier of the asset

connectionGUID - unique identifier of the connection

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)

removeConnection

void removeConnection(String userId,
                      String dataManagerGUID,
                      String dataManagerName,
                      String connectionGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Remove the metadata element representing a connection. This will delete all anchored elements such as comments.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

connectionGUID - unique identifier of the metadata element to remove

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)

findConnections

List<ConnectionElement> findConnections(String userId,
                                        String searchString,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

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)

getConnectionsByName

List<ConnectionElement> getConnectionsByName(String userId,
                                             String name,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

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)

getConnectionByGUID

ConnectionElement getConnectionByGUID(String userId,
                                      String connectionGUID)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve the connection metadata element with the supplied unique identifier.

Parameters:

userId - calling user

connectionGUID - unique identifier of the requested metadata element

Returns:

matching 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)

createEndpoint

String createEndpoint(String userId,
                      String dataManagerGUID,
                      String dataManagerName,
                      EndpointProperties endpointProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Create a new metadata element to represent the endpoint.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

endpointProperties - properties to store

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)

createEndpointFromTemplate

String createEndpointFromTemplate(String userId,
                                  String dataManagerGUID,
                                  String dataManagerName,
                                  String networkAddress,
                                  String templateGUID,
                                  TemplateProperties templateProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

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

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

networkAddress - location of the endpoint

templateGUID - unique identifier of the metadata element to copy

templateProperties - descriptive properties that override the template

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)

updateEndpoint

void updateEndpoint(String userId,
                    String dataManagerGUID,
                    String dataManagerName,
                    boolean isMergeUpdate,
                    String endpointGUID,
                    EndpointProperties endpointProperties)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

Update the metadata element representing a endpoint.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

endpointGUID - unique identifier of the metadata element to update

endpointProperties - new properties for this 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)

removeEndpoint

void removeEndpoint(String userId,
                    String dataManagerGUID,
                    String dataManagerName,
                    String endpointGUID)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException

Remove the metadata element representing a endpoint. This will delete the endpoint and all categories and terms.

Parameters:

userId - calling user

dataManagerGUID - unique identifier of software server capability representing the caller

dataManagerName - unique name of software server capability representing the caller

endpointGUID - unique identifier of the metadata element to remove

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)

findEndpoints

List<EndpointElement> findEndpoints(String userId,
                                    String searchString,
                                    int startFrom,
                                    int pageSize)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

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)

getEndpointsByName

List<EndpointElement> getEndpointsByName(String userId,
                                         String name,
                                         int startFrom,
                                         int pageSize)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

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)

getEndpointByGUID

EndpointElement getEndpointByGUID(String userId,
                                  String endpointGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Retrieve the endpoint metadata element with the supplied unique identifier.

Parameters:

userId - calling user

endpointGUID - unique identifier of the requested metadata element

Returns:

matching 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)

findConnectorTypes

List<ConnectorTypeElement> findConnectorTypes(String userId,
                                              String searchString,
                                              int startFrom,
                                              int pageSize)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the list of connectorType metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

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)

getConnectorTypesByName

List<ConnectorTypeElement> getConnectorTypesByName(String userId,
                                                   String name,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the list of connectorType metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

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)

getConnectorTypeByGUID

ConnectorTypeElement getConnectorTypeByGUID(String userId,
                                            String connectorTypeGUID)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve the connectorType metadata element with the supplied unique identifier.

Parameters:

userId - calling user

connectorTypeGUID - unique identifier of the requested metadata element

Returns:

matching 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)