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

Class ConnectionMakerResource

java.lang.Object
org.odpi.openmetadata.viewservices.connectionmaker.server.spring.ConnectionMakerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}") public class ConnectionMakerResource extends Object
The ConnectionMakerResource provides part of the server-side implementation of the Connection Maker OMVS. =

  • Constructor Details

    • ConnectionMakerResource

      public ConnectionMakerResource()
      Default constructor

  • Method Details

    • createConnection

      @PostMapping(path="/connections") public GUIDResponse createConnection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/connections/from-template") public GUIDResponse createConnectionFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/connections/{connectionGUID}/update") public VoidResponse updateConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connections/{connectionGUID}/connector-types/{connectorTypeGUID}/attach") public VoidResponse linkConnectionConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @PathVariable String connectorTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connections/{connectionGUID}/connector-types/{connectorTypeGUID}/detach") public VoidResponse detachConnectionConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @PathVariable String connectorTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connections/{connectionGUID}/endpoints/{endpointGUID}/attach") public VoidResponse linkConnectionEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @PathVariable String endpointGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connections/{connectionGUID}/endpoints/{endpointGUID}/detach") public VoidResponse detachConnectionEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @PathVariable String endpointGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connections/{connectionGUID}/embedded-connections/{embeddedConnectionGUID}/attach") public VoidResponse linkEmbeddedConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @PathVariable String embeddedConnectionGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connections/{connectionGUID}/embedded-connections/{embeddedConnectionGUID}/detach") public VoidResponse detachEmbeddedConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @PathVariable String embeddedConnectionGUID, @RequestBody(required=false) 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

      @PostMapping(path="/assets/{assetGUID}/connections/{connectionGUID}/attach") public VoidResponse linkAssetToConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String connectionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an asset to a 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

      @PostMapping(path="/assets/{assetGUID}/connections/{connectionGUID}/detach") public VoidResponse detachAssetFromConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String connectionGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach an asset from a connection.
      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

      @PostMapping(path="/assets/{assetGUID}/endpoints/{endpointGUID}/attach") public VoidResponse linkEndpointToITAsset(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String endpointGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an endpoint to an infrastructure asset.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - 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

      @PostMapping(path="/assets/{assetGUID}/connections/{endpointGUID}/detach") public VoidResponse detachEndpointFromITAsset(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String endpointGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Detach an endpoint from an infrastructure asset.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - 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

      @PostMapping(path="/connections/{connectionGUID}/delete") public VoidResponse deleteConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Delete a connection.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      connectionGUID - unique identifier of the element to delete* @param 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

      @PostMapping(path="/connections/by-name") public OpenMetadataRootElementsResponse getConnectionsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of connections with a particular name.
      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)

    • findConnections

      @PostMapping(path="/connections/by-search-string") public OpenMetadataRootElementsResponse findConnections(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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
      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

      @PostMapping(path="/connections/{connectionGUID}/retrieve") public OpenMetadataRootElementResponse getConnectionByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific connection.
      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)

    • createConnectorType

      @PostMapping(path="/connector-types") public GUIDResponse createConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/connector-types/from-template") public GUIDResponse createConnectorTypeFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/connector-types/{connectorTypeGUID}/update") public VoidResponse updateConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectorTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connector-types/{connectorTypeGUID}/delete") public VoidResponse deleteConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectorTypeGUID, @RequestBody(required=false) 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

      @PostMapping(path="/connector-types/by-name") public OpenMetadataRootElementsResponse getConnectorTypesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of connectorTypes with a particular name.
      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)

    • findConnectorTypes

      @PostMapping(path="/connector-types/by-search-string") public OpenMetadataRootElementsResponse findConnectorTypes(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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)

    • getConnectorTypeByGUID

      @PostMapping(path="/connector-types/{connectorTypeGUID}/retrieve") public OpenMetadataRootElementResponse getConnectorTypeByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectorTypeGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific connectorType.
      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)

    • createEndpoint

      @PostMapping(path="/endpoints") public GUIDResponse createEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/endpoints/from-template") public GUIDResponse createEndpointFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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

      @PostMapping(path="/endpoints/{endpointGUID}/update") public VoidResponse updateEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @RequestBody(required=false) 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

      @PostMapping(path="/endpoints/{endpointGUID}/delete") public VoidResponse deleteEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @RequestBody(required=false) 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

      @PostMapping(path="/endpoints/by-name") public OpenMetadataRootElementsResponse getEndpointsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of endpoints with a particular name.
      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)

    • getEndpointsByNetworkAddress

      @PostMapping(path="/endpoints/by-network-address") public OpenMetadataRootElementsResponse getEndpointsByNetworkAddress(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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)

    • getEndpointsForInfrastructure

      @PostMapping(path="/assets/{infrastructureGUID}/endpoints/retrieve") public OpenMetadataRootElementsResponse getEndpointsForInfrastructure(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String infrastructureGUID, @RequestBody(required=false) 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 - 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

      @PostMapping(path="/endpoints/by-search-string") public OpenMetadataRootElementsResponse findEndpoints(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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)

    • getEndpointByGUID

      @PostMapping(path="/endpoints/{endpointGUID}/retrieve") public OpenMetadataRootElementResponse getEndpointByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific endpoint.
      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)