Package org.odpi.openmetadata.accessservices.digitalarchitecture.server

Class ConnectionRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.digitalarchitecture.server.ConnectionRESTServices
public class ConnectionRESTServices extends Object
ConnectionRESTServices provides the ability to manage connection information.

  • 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.NullRequestBody 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.NullRequestBody 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.NullRequestBody 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.NullRequestBody 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.frameworks.openmetadata.properties.connections.ConnectionProperties 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.digitalarchitecture.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent a connection using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectorType(String serverName, String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.ConnectorTypeProperties connectorTypeProperties)
    Create a new metadata element to represent a connectorType.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.digitalarchitecture.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent a connectorType using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpoint(String serverName, String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties)
    Create a new metadata element to represent an endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpointFromTemplate(String serverName, String userId, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.digitalarchitecture.properties.TemplateProperties templateProperties)
    Create a new metadata element to represent an 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 connectorType 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 connectionGUID)
    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 connectorTypeGUID)
    Retrieve the connectorType 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 connectorType metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointResponse
    getEndpointByGUID(String serverName, String userId, String endpointGUID)
    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.NullRequestBody requestBody)
    Remove the metadata element representing a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeConnectorType(String serverName, String userId, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the metadata element representing a connectorType.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeEndpoint(String serverName, String userId, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody 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.StringRequestBody 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.NullRequestBody 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.NullRequestBody 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.frameworks.openmetadata.properties.connections.ConnectionProperties requestBody)
    Update the metadata element representing a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.ConnectorTypeProperties connectorTypeProperties)
    Update the metadata element representing a connectorType.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties)
    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.frameworks.openmetadata.properties.connections.ConnectionProperties requestBody)
      Create a new metadata element to represent a connection.
      Parameters:
      serverName - name of calling server
      userId - calling user
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • createConnectionFromTemplate

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectionFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.digitalarchitecture.properties.TemplateProperties templateProperties)
      Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new connection.
      Parameters:
      serverName - name of calling server
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • updateConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.ConnectionProperties requestBody)
      Update the metadata element representing a connection.
      Parameters:
      serverName - name of calling server
      userId - calling user
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      connectionGUID - unique identifier of the metadata element to update
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • setupConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody 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.NullRequestBody 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.NullRequestBody 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.NullRequestBody 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.NullRequestBody 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.StringRequestBody 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.NullRequestBody 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.NullRequestBody requestBody)
      Remove the metadata element representing a connection.
      Parameters:
      serverName - name of calling server
      userId - calling user
      connectionGUID - unique identifier of the metadata element to remove
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • 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 calling server
      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 make this request or PropertyServerException the repository is not available or not working properly.

    • 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 calling server
      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 make this request or PropertyServerException the repository is not available or not working properly.

    • getConnectionByGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionResponse getConnectionByGUID(String serverName, String userId, String connectionGUID)
      Retrieve the connection metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of calling server
      userId - calling user
      connectionGUID - 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 make this request or PropertyServerException the repository is not available or not working properly.

    • createEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpoint(String serverName, String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties)
      Create a new metadata element to represent an endpoint. Classifications can be added later to define the type of endpoint.
      Parameters:
      serverName - name of calling server
      userId - calling user
      endpointProperties - properties to store
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • createEndpointFromTemplate

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpointFromTemplate(String serverName, String userId, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.digitalarchitecture.properties.TemplateProperties templateProperties)
      Create a new metadata element to represent an endpoint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new endpoint.
      Parameters:
      serverName - name of calling server
      userId - calling user
      networkAddress - location of the endpoint in the network
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • updateEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties endpointProperties)
      Update the metadata element representing a endpoint.
      Parameters:
      serverName - name of calling server
      userId - calling user
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      endpointGUID - unique identifier of the metadata element to update
      endpointProperties - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • removeEndpoint

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeEndpoint(String serverName, String userId, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Remove the metadata element representing a endpoint.
      Parameters:
      serverName - name of calling server
      userId - calling user
      endpointGUID - unique identifier of the metadata element to remove
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • 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 calling server
      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 make this request or PropertyServerException the repository is not available or not working properly.

    • 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 calling server
      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 make this request or PropertyServerException the repository is not available or not working properly.

    • getEndpointByGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointResponse getEndpointByGUID(String serverName, String userId, String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of calling server
      userId - calling user
      endpointGUID - 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 make this request or PropertyServerException the repository is not available or not working properly.

    • createConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectorType(String serverName, String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.ConnectorTypeProperties connectorTypeProperties)
      Create a new metadata element to represent a connectorType. Classifications can be added later to define the type of connectorType.
      Parameters:
      serverName - name of calling server
      userId - calling user
      connectorTypeProperties - properties to store
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • createConnectorTypeFromTemplate

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.digitalarchitecture.properties.TemplateProperties templateProperties)
      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:
      serverName - name of calling server
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • updateConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.connections.ConnectorTypeProperties connectorTypeProperties)
      Update the metadata element representing a connectorType.
      Parameters:
      serverName - name of calling server
      userId - calling user
      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
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • removeConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeConnectorType(String serverName, String userId, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Remove the metadata element representing a connectorType.
      Parameters:
      serverName - name of calling server
      userId - calling user
      connectorTypeGUID - unique identifier of the metadata element to remove
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

    • 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 connectorType metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of calling server
      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 make this request or PropertyServerException the repository is not available or not working properly.

    • 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 connectorType metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of calling server
      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 make this request or PropertyServerException the repository is not available or not working properly.

    • getConnectorTypeByGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeResponse getConnectorTypeByGUID(String serverName, String userId, String connectorTypeGUID)
      Retrieve the connectorType metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of calling server
      userId - calling user
      connectorTypeGUID - 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 make this request or PropertyServerException the repository is not available or not working properly.