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

Class ConnectorTypeManagerClient

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.client.ConnectorTypeManagerClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.itinfrastructure.api.ConnectorTypeManagerInterface
public class ConnectorTypeManagerClient extends Object implements org.odpi.openmetadata.accessservices.itinfrastructure.api.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, org.odpi.openmetadata.frameworks.auditlog.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, org.odpi.openmetadata.frameworks.auditlog.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, org.odpi.openmetadata.accessservices.itinfrastructure.properties.ConnectorTypeProperties connectorTypeProperties)
    Create a new metadata element to represent an connectorType
    String
    createConnectorTypeFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent an connectorType using an existing metadata element as a template.
    List<org.odpi.openmetadata.accessservices.itinfrastructure.metadataelements.ConnectorTypeElement>
    findConnectorTypes(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of connector type metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.itinfrastructure.metadataelements.ConnectorTypeElement
    getConnectorTypeByGUID(String userId, String connectorTypeGUID)
    Retrieve the connector type metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.itinfrastructure.metadataelements.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, org.odpi.openmetadata.accessservices.itinfrastructure.properties.ConnectorTypeProperties connectorTypeProperties)
    Update the metadata element representing an connectorType.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConnectorTypeManagerClient

      public ConnectorTypeManagerClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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 services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • ConnectorTypeManagerClient

      public ConnectorTypeManagerClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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 services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.ffdc.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 services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.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, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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 services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.ffdc.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 services
      restClient - client that issues the REST API calls
      maxPageSize - maximum number of results supported by this server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • createConnectorType

      public String createConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, org.odpi.openmetadata.accessservices.itinfrastructure.properties.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 an connectorType
      Specified by:
      createConnectorType in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.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:
      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

      public String createConnectorTypeFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.properties.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 an connectorType using an existing metadata element as a template.
      Specified by:
      createConnectorTypeFromTemplate in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.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:
      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

      public void updateConnectorType(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean isMergeUpdate, String connectorTypeGUID, org.odpi.openmetadata.accessservices.itinfrastructure.properties.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 an connectorType. It is possible to use the subtype property classes or set up specialized properties in extended properties.
      Specified by:
      updateConnectorType in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.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:
      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

      public 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 an connectorType.
      Specified by:
      removeConnectorType in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.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:
      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

      public List<org.odpi.openmetadata.accessservices.itinfrastructure.metadataelements.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 connector type metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findConnectorTypes in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.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:
      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

      public List<org.odpi.openmetadata.accessservices.itinfrastructure.metadataelements.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 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 org.odpi.openmetadata.accessservices.itinfrastructure.api.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:
      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

      public org.odpi.openmetadata.accessservices.itinfrastructure.metadataelements.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 connector type metadata element with the supplied unique identifier.
      Specified by:
      getConnectorTypeByGUID in interface org.odpi.openmetadata.accessservices.itinfrastructure.api.ConnectorTypeManagerInterface
      Parameters:
      userId - calling user
      connectorTypeGUID - unique identifier of the requested metadata element
      Returns:
      requested 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)