Package org.odpi.openmetadata.accessservices.digitalarchitecture.client

Class ConnectionManager

java.lang.Object

org.odpi.openmetadata.accessservices.digitalarchitecture.client.ConnectionManager

All Implemented Interfaces:

ManageConnections

public class ConnectionManager
extends Object
implements ManageConnections

ConnectionManager provides the API operations to create and maintain connection definitions and their related objects. The client 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.

Constructor Summary

Constructors

Constructor	Description
ConnectionManager(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
ConnectionManager(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
ConnectionManager(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
ConnectionManager(String serverName, String serverPlatformURLRoot, DigitalArchitectureRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
ConnectionManager(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request and an audit log.

Method Summary

Modifier and Type	Method	Description
void	clearAssetConnection(String userId, String assetGUID, String connectionGUID)	Remove a relationship between an asset and its connection.
void	clearConnectorType(String userId, String connectionGUID, String connectorTypeGUID)	Remove a relationship between a connection and a connector type.
void	clearEmbeddedConnection(String userId, String connectionGUID, String embeddedConnectionGUID)	Remove a relationship between a virtual connection and an embedded connection.
void	clearEndpoint(String userId, String connectionGUID, String endpointGUID)	Remove a relationship between a connection and an endpoint.
String	createConnection(String userId, ConnectionProperties connectionProperties)	Create a new metadata element to represent a connection.
String	createConnectionFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a connection using an existing metadata element as a template.
String	createConnectorType(String userId, ConnectorTypeProperties connectorTypeProperties)	Create a new metadata element to represent a connectorType.
String	createConnectorTypeFromTemplate(String userId, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a connectorType using an existing metadata element as a template.
String	createEndpoint(String userId, EndpointProperties endpointProperties)	Create a new metadata element to represent a endpoint.
String	createEndpointFromTemplate(String userId, 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 connection 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 connection 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 connectionGUID)	Remove the metadata element representing a connection.
void	removeConnectorType(String userId, String connectorTypeGUID)	Remove the metadata element representing a connectorType.
void	removeEndpoint(String userId, String endpointGUID)	Remove the metadata element representing a endpoint.
void	setupAssetConnection(String userId, String assetGUID, String assetSummary, String connectionGUID)	Create a relationship between an asset and its connection.
void	setupConnectorType(String userId, String connectionGUID, String connectorTypeGUID)	Create a relationship between a connection and a connector type.
void	setupEmbeddedConnection(String userId, 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 connectionGUID, String endpointGUID)	Create a relationship between a connection and an endpoint.
void	updateConnection(String userId, String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)	Update the metadata element representing a connection.
void	updateConnectorType(String userId, boolean isMergeUpdate, String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties)	Update the metadata element representing a connectorType.
void	updateEndpoint(String userId, boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)	Update the metadata element representing a endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionManager

public ConnectionManager(String serverName,
                         String serverPlatformURLRoot,
                         AuditLog auditLog)
                  throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request and an audit log.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectionManager

public ConnectionManager(String serverName,
                         String serverPlatformURLRoot)
                  throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectionManager

public ConnectionManager(String serverName,
                         String serverPlatformURLRoot,
                         String userId,
                         String password,
                         AuditLog auditLog)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request. There is also an audit log destination.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectionManager

public ConnectionManager(String serverName,
                         String serverPlatformURLRoot,
                         String userId,
                         String password)
                  throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectionManager

public ConnectionManager(String serverName,
                         String serverPlatformURLRoot,
                         DigitalArchitectureRESTClient restClient,
                         int maxPageSize,
                         AuditLog auditLog)
                  throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server (view service or integration service typically).

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

createConnection

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

Create a new metadata element to represent a connection. Classifications can be added later to define the type of connection.

Specified by:

createConnection in interface ManageConnections

Parameters:

userId - calling user

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

public String createConnectionFromTemplate(String userId,
                                           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 connection.

Specified by:

createConnectionFromTemplate in interface ManageConnections

Parameters:

userId - calling user

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

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

Update the metadata element representing a connection.

Specified by:

updateConnection in interface ManageConnections

Parameters:

userId - calling user

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

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

Create a relationship between a connection and a connector type.

Specified by:

setupConnectorType in interface ManageConnections

Parameters:

userId - calling user

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

connectorTypeGUID - unique identifier of the connector type in the external asset 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

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

Remove a relationship between a connection and a connector type.

Specified by:

clearConnectorType in interface ManageConnections

Parameters:

userId - calling user

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

connectorTypeGUID - unique identifier of the connector type in the external asset 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

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

Create a relationship between a connection and an endpoint.

Specified by:

setupEndpoint in interface ManageConnections

Parameters:

userId - calling user

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

endpointGUID - unique identifier of the endpoint in the external asset 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

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

Remove a relationship between a connection and an endpoint.

Specified by:

clearEndpoint in interface ManageConnections

Parameters:

userId - calling user

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

endpointGUID - unique identifier of the endpoint in the external asset 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

public void setupEmbeddedConnection(String userId,
                                    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.

Specified by:

setupEmbeddedConnection in interface ManageConnections

Parameters:

userId - calling user

connectionGUID - unique identifier of the virtual connection in the external asset 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 asset 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

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

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

Specified by:

clearEmbeddedConnection in interface ManageConnections

Parameters:

userId - calling user

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

embeddedConnectionGUID - unique identifier of the embedded connection in the external asset 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

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

Create a relationship between an asset and its connection.

Specified by:

setupAssetConnection in interface ManageConnections

Parameters:

userId - calling user

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

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

Remove a relationship between an asset and its connection.

Specified by:

clearAssetConnection in interface ManageConnections

Parameters:

userId - calling user

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

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

Remove the metadata element representing a connection.

Specified by:

removeConnection in interface ManageConnections

Parameters:

userId - calling user

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

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

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

Specified by:

findConnections in interface ManageConnections

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

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

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

Specified by:

getConnectionsByName in interface ManageConnections

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

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

Retrieve the connection metadata element with the supplied unique identifier.

Specified by:

getConnectionByGUID in interface ManageConnections

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

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

Create a new metadata element to represent a endpoint. Classifications can be added later to define the type of endpoint.

Specified by:

createEndpoint in interface ManageConnections

Parameters:

userId - calling user

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

public String createEndpointFromTemplate(String userId,
                                         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.

Specified by:

createEndpointFromTemplate in interface ManageConnections

Parameters:

userId - calling user

networkAddress - location of the endpoint

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)

updateEndpoint

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

Update the metadata element representing a endpoint.

Specified by:

updateEndpoint in interface ManageConnections

Parameters:

userId - calling user

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

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

Remove the metadata element representing a endpoint.

Specified by:

removeEndpoint in interface ManageConnections

Parameters:

userId - calling user

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

public 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.

Specified by:

findEndpoints in interface ManageConnections

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

public 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.

Specified by:

getEndpointsByName in interface ManageConnections

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

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

Retrieve the endpoint metadata element with the supplied unique identifier.

Specified by:

getEndpointByGUID in interface ManageConnections

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)

createConnectorType

public String createConnectorType(String userId,
                                  ConnectorTypeProperties connectorTypeProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Create a new metadata element to represent a connectorType. Classifications can be added later to define the type of connectorType.

Specified by:

createConnectorType in interface ManageConnections

Parameters:

userId - calling user

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

createConnectorTypeFromTemplate

public String createConnectorTypeFromTemplate(String userId,
                                              String templateGUID,
                                              TemplateProperties templateProperties)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

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

Specified by:

createConnectorTypeFromTemplate in interface ManageConnections

Parameters:

userId - calling user

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)

updateConnectorType

public void updateConnectorType(String userId,
                                boolean isMergeUpdate,
                                String connectorTypeGUID,
                                ConnectorTypeProperties connectorTypeProperties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update the metadata element representing a connectorType.

Specified by:

updateConnectorType in interface ManageConnections

Parameters:

userId - calling user

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

connectorTypeGUID - unique identifier of the metadata element to update

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

removeConnectorType

public void removeConnectorType(String userId,
                                String connectorTypeGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the metadata element representing a connectorType.

Specified by:

removeConnectorType in interface ManageConnections

Parameters:

userId - calling user

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

findConnectorTypes

public 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.

Specified by:

findConnectorTypes in interface ManageConnections

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

public 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.

Specified by:

getConnectorTypesByName in interface ManageConnections

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

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

Retrieve the connectorType metadata element with the supplied unique identifier.

Specified by:

getConnectorTypeByGUID in interface ManageConnections

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)