Package org.odpi.openmetadata.viewservices.connectionmaker.server

Class ConnectionMakerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.connectionmaker.server.ConnectionMakerRESTServices
public class ConnectionMakerRESTServices extends TokenController
The ConnectionMakerRESTServices provides the server-side implementation of the Connection Maker Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • ConnectionMakerRESTServices

      public ConnectionMakerRESTServices()
      Default constructor

  • Method Details

    • createConnection

      public GUIDResponse createConnection(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create a connection.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the connection.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createConnectionFromTemplate

      public GUIDResponse createConnectionFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      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 element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateConnection

      public VoidResponse updateConnection(String serverName, String urlMarker, String connectionGUID, UpdateElementRequestBody requestBody)
      Update the properties of a connection.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the connection (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkConnectionConnectorType

      public VoidResponse linkConnectionConnectorType(String serverName, String urlMarker, String connectionGUID, String connectorTypeGUID, NewRelationshipRequestBody requestBody)
      Create a ConnectionConnectorType relationship between a connection and a connector type.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the connection
      connectorTypeGUID - unique identifier of the connector type
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachConnectionConnectorType

      public VoidResponse detachConnectionConnectorType(String serverName, String urlMarker, String connectionGUID, String connectorTypeGUID, DeleteRequestBody requestBody)
      Remove the ConnectionConnectorType relationship between a connection and a connector type.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the connection
      connectorTypeGUID - unique identifier of the connector type
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkConnectionEndpoint

      public VoidResponse linkConnectionEndpoint(String serverName, String urlMarker, String connectionGUID, String endpointGUID, NewRelationshipRequestBody requestBody)
      Create a ConnectToEndpoint relationship between a connection and an endpoint.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the connection
      endpointGUID - unique identifier of the endpoint
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachConnectionEndpoint

      public VoidResponse detachConnectionEndpoint(String serverName, String urlMarker, String connectionGUID, String endpointGUID, DeleteRequestBody requestBody)
      Remove the ConnectToEndpoint relationship between a connection and an endpoint.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the connection
      endpointGUID - unique identifier of the endpoint
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkEmbeddedConnection

      public VoidResponse linkEmbeddedConnection(String serverName, String urlMarker, String connectionGUID, String embeddedConnectionGUID, NewRelationshipRequestBody requestBody)
      Create an EmbeddedConnection relationship between a virtual connection and an embedded connection.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the virtual connection
      embeddedConnectionGUID - unique identifier of the embedded connection
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachEmbeddedConnection

      public VoidResponse detachEmbeddedConnection(String serverName, String urlMarker, String connectionGUID, String embeddedConnectionGUID, DeleteRequestBody requestBody)
      Remove an EmbeddedConnection relationship between a virtual connection and an embedded connection.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the virtual connection
      embeddedConnectionGUID - unique identifier of the embedded connection
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkAssetToConnection

      public VoidResponse linkAssetToConnection(String serverName, String urlMarker, String assetGUID, String connectionGUID, NewRelationshipRequestBody requestBody)
      Create an AssetConnection relationship between an asset and its connection.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachAssetFromConnection

      public VoidResponse detachAssetFromConnection(String serverName, String urlMarker, String assetGUID, String connectionGUID, DeleteRequestBody requestBody)
      Detach an asset from one of its connections.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkEndpointToITAsset

      public VoidResponse linkEndpointToITAsset(String serverName, String urlMarker, String itAssetGUID, String endpointGUID, NewRelationshipRequestBody requestBody)
      Attach an endpoint to an infrastructure asset.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      itAssetGUID - unique identifier of the infrastructure asset
      endpointGUID - unique identifier of the endpoint
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachEndpointFromITAsset

      public VoidResponse detachEndpointFromITAsset(String serverName, String urlMarker, String itAssetGUID, String endpointGUID, DeleteRequestBody requestBody)
      Detach an endpoint from an infrastructure asset.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      itAssetGUID - unique identifier of the infrastructure asset
      endpointGUID - unique identifier of the endpoint
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteConnection

      public VoidResponse deleteConnection(String serverName, String urlMarker, String connectionGUID, DeleteRequestBody requestBody)
      Delete a connection.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getConnectionsByName

      public OpenMetadataRootElementsResponse getConnectionsByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of connection metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getConnectionByGUID

      public OpenMetadataRootElementResponse getConnectionByGUID(String serverName, String urlMarker, String connectionGUID, GetRequestBody requestBody)
      Retrieve the list of connection metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findConnections

      public OpenMetadataRootElementsResponse findConnections(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of connection metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createConnectorType

      public GUIDResponse createConnectorType(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create a connectorType.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the connectorType.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createConnectorTypeFromTemplate

      public GUIDResponse createConnectorTypeFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      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 element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateConnectorType

      public VoidResponse updateConnectorType(String serverName, String urlMarker, String connectorTypeGUID, UpdateElementRequestBody requestBody)
      Update the properties of a connectorType.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      connectorTypeGUID - unique identifier of the connectorType (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteConnectorType

      public VoidResponse deleteConnectorType(String serverName, String urlMarker, String connectorTypeGUID, DeleteRequestBody requestBody)
      Delete a connectorType.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectorTypeGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getConnectorTypesByName

      public OpenMetadataRootElementsResponse getConnectorTypesByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of connectorType metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getConnectorTypeByGUID

      public OpenMetadataRootElementResponse getConnectorTypeByGUID(String serverName, String urlMarker, String connectorTypeGUID, GetRequestBody requestBody)
      Retrieve the list of connectorType metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      connectorTypeGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findConnectorTypes

      public OpenMetadataRootElementsResponse findConnectorTypes(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of connectorType metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createEndpoint

      public GUIDResponse createEndpoint(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create an endpoint.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the endpoint.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createEndpointFromTemplate

      public GUIDResponse createEndpointFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      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 element.
      Parameters:
      serverName - calling user
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateEndpoint

      public VoidResponse updateEndpoint(String serverName, String urlMarker, String endpointGUID, UpdateElementRequestBody requestBody)
      Update the properties of an endpoint.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      endpointGUID - unique identifier of the endpoint (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteEndpoint

      public VoidResponse deleteEndpoint(String serverName, String urlMarker, String endpointGUID, DeleteRequestBody requestBody)
      Delete a endpoint.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      endpointGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getEndpointsByName

      public OpenMetadataRootElementsResponse getEndpointsByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of endpoint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getEndpointsForInfrastructure

      public OpenMetadataRootElementsResponse getEndpointsForInfrastructure(String serverName, String urlMarker, String infrastructureGUID, ResultsRequestBody requestBody)
      Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      infrastructureGUID - element to search for
      requestBody - time parameters
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getEndpointsByNetworkAddress

      public OpenMetadataRootElementsResponse getEndpointsByNetworkAddress(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of endpoint metadata elements with a matching networkAddress. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getEndpointByGUID

      public OpenMetadataRootElementResponse getEndpointByGUID(String serverName, String urlMarker, String endpointGUID, GetRequestBody requestBody)
      Retrieve the list of endpoint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      endpointGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findEndpoints

      public OpenMetadataRootElementsResponse findEndpoints(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of endpoint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)