Package org.odpi.openmetadata.accessservices.itinfrastructure.client

Class ConnectorTypeManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.itinfrastructure.client.ConnectorTypeManagerClient

All Implemented Interfaces:

ConnectorTypeManagerInterface

public class ConnectorTypeManagerClient
extends Object
implements ConnectorTypeManagerInterface

ConnectorTypeManagerClient supports the APIs to maintain connector types .

Constructor Summary

Constructors

Constructor	Description
ConnectorTypeManagerClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
ConnectorTypeManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
ConnectorTypeManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
ConnectorTypeManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.
ConnectorTypeManagerClient(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
String	createConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, ConnectorTypeProperties connectorTypeProperties)	Create a new metadata element to represent an connectorType
String	createConnectorTypeFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent an connectorType using an existing metadata element as a template.
List<ConnectorTypeElement>	findConnectorTypes(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of connector type metadata elements that contain the search string.
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.
void	removeConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String connectorTypeGUID)	Remove the metadata element representing an connectorType.
void	updateConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean isMergeUpdate, String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties)	Update the metadata element representing an connectorType.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorTypeManagerClient

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

ConnectorTypeManagerClient

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

ConnectorTypeManagerClient

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

ConnectorTypeManagerClient

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

ConnectorTypeManagerClient

public ConnectorTypeManagerClient(String serverName,
                                  String serverPlatformURLRoot,
                                  ITInfrastructureRESTClient restClient,
                                  int maxPageSize)
                           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

Throws:

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

Method Detail

createConnectorType

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

Create a new metadata element to represent an connectorType

Specified by:

createConnectorType in interface ConnectorTypeManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

connectorTypeProperties - properties about the connector type to store

Returns:

unique identifier of the new connectorType

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 infrastructureManagerGUID,
                                              String infrastructureManagerName,
                                              String templateGUID,
                                              TemplateProperties templateProperties)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Create a new metadata element to represent an connectorType using an existing metadata element as a template.

Specified by:

createConnectorTypeFromTemplate in interface ConnectorTypeManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

templateGUID - unique identifier of the metadata element to copy

templateProperties - descriptive properties that override the template

Returns:

unique identifier of the new connectorType

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,
                                String infrastructureManagerGUID,
                                String infrastructureManagerName,
                                boolean isMergeUpdate,
                                String connectorTypeGUID,
                                ConnectorTypeProperties connectorTypeProperties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

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

Specified by:

updateConnectorType in interface ConnectorTypeManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

connectorTypeGUID - unique identifier of the metadata element to update

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

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

removeConnectorType

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

Remove the metadata element representing an connectorType.

Specified by:

removeConnectorType in interface ConnectorTypeManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

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 connector type metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findConnectorTypes in interface ConnectorTypeManagerInterface

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 ConnectorTypeManagerInterface

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 ConnectorTypeManagerInterface

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)