Package org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface ConnectorTypeManagerInterface

public interface ConnectorTypeManagerInterface

ConnectorTypeManagerInterface provides methods to define connector types. The ConnectorType describes a specific connector implementation.

Method Summary

Modifier and Type	Method	Description
String	createConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, ConnectorTypeProperties connectorTypeProperties)	Create a new metadata element to represent the root of a connectorType.
String	createConnectorTypeFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a connectorType using an existing metadata element as a template.
List<ConnectorTypeElement>	findConnectorTypes(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of connectorType metadata elements that contain the search string.
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.
void	removeConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String connectorTypeGUID)	Remove the metadata element representing a connectorType.
void	updateConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean isMergeUpdate, String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties)	Update the metadata element representing a connectorType.

Method Details

createConnectorType

String createConnectorType(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 ConnectorTypeProperties connectorTypeProperties)
                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create a new metadata element to represent the root of a connectorType.

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 to store

Returns:

unique identifier of the new metadata element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

createConnectorTypeFromTemplate

String createConnectorTypeFromTemplate(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String templateGUID,
 TemplateProperties templateProperties)
                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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.

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 - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

updateConnectorType

void updateConnectorType(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean isMergeUpdate,
 String connectorTypeGUID,
 ConnectorTypeProperties connectorTypeProperties)
                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update the metadata element representing a connectorType.

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

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

connectorTypeGUID - unique identifier of the metadata element to update

connectorTypeProperties - new properties for this element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

removeConnectorType

void removeConnectorType(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String connectorTypeGUID)
                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

findConnectorTypes

List<ConnectorTypeElement> findConnectorTypes(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getConnectorTypesByName

List<ConnectorTypeElement> getConnectorTypesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

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

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getConnectorTypeByGUID

ConnectorTypeElement getConnectorTypeByGUID(String userId,
 String connectorTypeGUID)
                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the connectorType metadata element with the supplied unique identifier.

Parameters:

userId - calling user

connectorTypeGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)