Package org.odpi.openmetadata.accessservices.datamanager.server

Class ConnectionRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.server.ConnectionRESTServices
public class ConnectionRESTServices extends Object
ConnectionRESTServices is the server-side implementation of the Data Manager OMAS's support for connections, connector types and endpoints. It matches the ConnectionManagerClient.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectionRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between an asset and its connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between a connection and a connector type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between a virtual connection and an embedded connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between a connection and an endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnection(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
    Create a new metadata element to represent a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectionFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.datamanager.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a connection using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpoint(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
    Create a new metadata element to represent a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpointFromTemplate(String serverName, String userId, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.datamanager.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a endpoint using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse
    findConnections(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connection metadata elements that contain the search string.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse
    findConnectorTypes(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connector type metadata elements that contain the search string.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse
    findEndpoints(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements that contain the search string.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionResponse
    getConnectionByGUID(String serverName, String userId, String guid)
    Retrieve the connection metadata element with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse
    getConnectionsByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connection metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeResponse
    getConnectorTypeByGUID(String serverName, String userId, String guid)
    Retrieve the connector type metadata element with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse
    getConnectorTypesByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connector type metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointResponse
    getEndpointByGUID(String serverName, String userId, String guid)
    Retrieve the endpoint metadata element with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse
    getEndpointsByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeConnection(String serverName, String userId, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata element representing a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeEndpoint(String serverName, String userId, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata element representing a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.AssetConnectionRequestBody requestBody)
    Create a relationship between an asset and its connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Create a relationship between a connection and a connector type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.EmbeddedConnectionRequestBody requestBody)
    Create a relationship between a virtual connection and an embedded connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Create a relationship between a connection and an endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
    Update the metadata element representing a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
    Update the metadata element representing a endpoint.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConnectionRESTServices

      public ConnectionRESTServices()
      Default constructor

  • Method Details

    • createConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnection(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
      Create a new metadata element to represent a connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createConnectionFromTemplate

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectionFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.datamanager.rest.TemplateRequestBody requestBody)
      Create a new metadata element to represent a connection using an existing metadata element as a template.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
      Update the metadata element representing a connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with the existing properties of overlay them?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Create a relationship between a connection and a connector type.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the connection in the external data manager
      connectorTypeGUID - unique identifier of the connector type in the external data manager
      requestBody - data manager identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a relationship between a connection and a connector type.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the connection in the external data manager
      connectorTypeGUID - unique identifier of the connector type in the external data manager
      requestBody - data manager identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Create a relationship between a connection and an endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the connection in the external data manager
      endpointGUID - unique identifier of the endpoint in the external data manager
      requestBody - data manager identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a relationship between a connection and an endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the connection in the external data manager
      endpointGUID - unique identifier of the endpoint in the external data manager
      requestBody - data manager identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupEmbeddedConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.EmbeddedConnectionRequestBody requestBody)
      Create a relationship between a virtual connection and an embedded connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the virtual connection in the external data manager
      embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
      requestBody - data manager identifiers and properties for the embedded connection
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearEmbeddedConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a relationship between a virtual connection and an embedded connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the virtual connection in the external data manager
      embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
      requestBody - data manager identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • setupAssetConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.AssetConnectionRequestBody requestBody)
      Create a relationship between an asset and its connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      requestBody - data manager identifiers and asset summary
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • clearAssetConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a relationship between an asset and its connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      requestBody - data manager identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeConnection(String serverName, String userId, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findConnections

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse findConnections(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of connection metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getConnectionsByName

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse getConnectionsByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of connection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getConnectionByGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionResponse getConnectionByGUID(String serverName, String userId, String guid)
      Retrieve the connection metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpoint(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
      Create a new metadata element to represent a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - properties about the endpoint
      Returns:
      unique identifier of the new endpoint or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createEndpointFromTemplate

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpointFromTemplate(String serverName, String userId, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.datamanager.rest.TemplateRequestBody requestBody)
      Create a new metadata element to represent a endpoint using an existing metadata element as a template.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      networkAddress - location of the endpoint
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new endpoint or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
      Update the metadata element representing a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      endpointGUID - unique identifier of the metadata element to update
      isMergeUpdate - are unspecified properties unchanged (true) or removed?
      requestBody - new properties for the metadata element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeEndpoint(String serverName, String userId, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      endpointGUID - unique identifier of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findEndpoints

      public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse findEndpoints(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getEndpointsByName

      public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse getEndpointsByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getEndpointByGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointResponse getEndpointByGUID(String serverName, String userId, String guid)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findConnectorTypes

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse findConnectorTypes(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getConnectorTypesByName

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse getConnectorTypesByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getConnectorTypeByGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeResponse getConnectorTypeByGUID(String serverName, String userId, String guid)
      Retrieve the connector type metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)