Package org.odpi.openmetadata.accessservices.datamanager.client

Class ConnectionManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.client.ConnectionManagerClient

All Implemented Interfaces:

ConnectionManagerInterface

public class ConnectionManagerClient
extends Object
implements ConnectionManagerInterface

ConnectionManagerClient supports the APIs to maintain connections and their related objects.

Constructor Summary

Constructors

Constructor	Description
ConnectionManagerClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
ConnectionManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
ConnectionManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
ConnectionManagerClient(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server.
ConnectionManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

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 a 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 an 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 metadata elements that contain the search string.
List<ConnectorTypeElement>	findConnectorTypes(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of connector type 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 metadata element with the supplied unique identifier.
List<ConnectionElement>	getConnectionsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of metadata elements with a matching qualified or display name.
ConnectorTypeElement	getConnectorTypeByGUID(String userId, String connectorTypeGUID)	Retrieve the connector type metadata element with the supplied unique identifier.
List<ConnectorTypeElement>	getConnectorTypesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of connector type metadata elements with a matching qualified name, display name or connector provider class 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionManagerClient

public ConnectionManagerClient(String serverName,
                               String serverPlatformURLRoot,
                               AuditLog auditLog)
                        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

auditLog - logging destination

Throws:

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

ConnectionManagerClient

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

ConnectionManagerClient

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

ConnectionManagerClient

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

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.

ConnectionManagerClient

public ConnectionManagerClient(String serverName,
                               String serverPlatformURLRoot,
                               DataManagerRESTClient restClient,
                               int maxPageSize,
                               AuditLog auditLog)
                        throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

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,
                               String dataManagerGUID,
                               String dataManagerName,
                               ConnectionProperties connectionProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a new metadata element to represent a connection.

Specified by:

createConnection in interface ConnectionManagerInterface

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 about the connection to store

Returns:

unique identifier of the new 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)

createConnectionFromTemplate

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

Specified by:

createConnectionFromTemplate in interface ConnectionManagerInterface

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

updateConnection

public 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. It is possible to use the subtype property classes or set up specialized properties in extended properties.

Specified by:

updateConnection in interface ConnectionManagerInterface

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

setupConnectorType

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

Specified by:

setupConnectorType in interface ConnectionManagerInterface

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

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

Specified by:

clearConnectorType in interface ConnectionManagerInterface

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

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

Specified by:

setupEndpoint in interface ConnectionManagerInterface

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

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

Specified by:

clearEndpoint in interface ConnectionManagerInterface

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

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

Specified by:

setupEmbeddedConnection in interface ConnectionManagerInterface

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

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

Specified by:

clearEmbeddedConnection in interface ConnectionManagerInterface

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

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

Specified by:

setupAssetConnection in interface ConnectionManagerInterface

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

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

Specified by:

clearAssetConnection in interface ConnectionManagerInterface

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

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

Remove the metadata element representing a connection.

Specified by:

removeConnection in interface ConnectionManagerInterface

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

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

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

Specified by:

findConnections in interface ConnectionManagerInterface

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 metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getConnectionsByName in interface ConnectionManagerInterface

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 metadata element with the supplied unique identifier.

Specified by:

getConnectionByGUID in interface ConnectionManagerInterface

Parameters:

userId - calling user

connectionGUID - unique identifier of the requested metadata element

Returns:

requested 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,
                             String dataManagerGUID,
                             String dataManagerName,
                             EndpointProperties endpointProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create a new metadata element to represent an endpoint

Specified by:

createEndpoint in interface ConnectionManagerInterface

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 about the endpoint to store

Returns:

unique identifier of the new endpoint

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

Specified by:

createEndpointFromTemplate in interface ConnectionManagerInterface

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 endpoint

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,
                           String dataManagerGUID,
                           String dataManagerName,
                           boolean isMergeUpdate,
                           String endpointGUID,
                           EndpointProperties endpointProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Update the metadata element representing a endpoint. It is possible to use the subtype property classes or set up specialized properties in extended properties.

Specified by:

updateEndpoint in interface ConnectionManagerInterface

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 update

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

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

removeEndpoint

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

Remove the metadata element representing a endpoint.

Specified by:

removeEndpoint in interface ConnectionManagerInterface

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

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 ConnectionManagerInterface

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 ConnectionManagerInterface

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 ConnectionManagerInterface

Parameters:

userId - calling user

endpointGUID - unique identifier of the requested metadata element

Returns:

requested 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

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

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

Specified by:

findConnectorTypes in interface ConnectionManagerInterface

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 connector type metadata elements with a matching qualified name, display name or connector provider class name. There are no wildcards supported on this request.

Specified by:

getConnectorTypesByName in interface ConnectionManagerInterface

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 connector type metadata element with the supplied unique identifier.

Specified by:

getConnectorTypeByGUID in interface ConnectionManagerInterface

Parameters:

userId - calling user

connectorTypeGUID - unique identifier of the requested metadata element

Returns:

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