Package org.odpi.openmetadata.viewservices.assetmaker.server

Class AssetMakerRESTServices

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

  • Constructor Details

    • AssetMakerRESTServices

      public AssetMakerRESTServices()
      Default constructor

  • Method Details

    • createAsset

      public GUIDResponse createAsset(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create an asset.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the asset.
      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.

    • createAssetFromTemplate

      public GUIDResponse createAssetFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent an asset 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)

    • updateAsset

      public BooleanResponse updateAsset(String serverName, String urlMarker, String assetGUID, UpdateElementRequestBody requestBody)
      Update the properties of an asset.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean 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.

    • deleteAsset

      public VoidResponse deleteAsset(String serverName, String urlMarker, String assetGUID, DeleteElementRequestBody requestBody)
      Delete an asset.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - 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.

    • getAssetsByName

      public OpenMetadataRootElementsResponse getAssetsByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of asset 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)

    • getProcessesByCategory

      public OpenMetadataRootElementsResponse getProcessesByCategory(String serverName, String urlMarker, ActivityStatusFilterRequestBody requestBody)
      Retrieve the processes that match the category name and status.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getAssetByGUID

      public OpenMetadataRootElementResponse getAssetByGUID(String serverName, String urlMarker, String assetGUID, GetRequestBody requestBody)
      Retrieve the list of asset metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      assetGUID - 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)

    • findAssets

      public OpenMetadataRootElementsResponse findAssets(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of asset 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)

    • findProcesses

      public OpenMetadataRootElementsResponse findProcesses(String serverName, String urlMarker, ActivityStatusSearchString requestBody)
      Retrieve the processes that match the search string.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • deployITAsset

      public VoidResponse deployITAsset(String serverName, String urlMarker, String assetGUID, String destinationGUID, NewRelationshipRequestBody requestBody)
      Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the asset
      destinationGUID - unique identifier of the destination asset
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      void 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)

    • unDeployITAsset

      public VoidResponse unDeployITAsset(String serverName, String urlMarker, String assetGUID, String destinationGUID, DeleteRelationshipRequestBody requestBody)
      Remove a DeployedOn relationship.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the asset
      destinationGUID - unique identifier of the destination asset
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      void 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)

    • linkSoftwareCapability

      public VoidResponse linkSoftwareCapability(String serverName, String urlMarker, String assetGUID, String capabilityGUID, NewRelationshipRequestBody requestBody)
      Create a relationship that links a software capability to an infrastructure asset like a software server.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the data set
      capabilityGUID - unique identifier of the data asset supplying the data
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      void 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)

    • detachSoftwareCapability

      public VoidResponse detachSoftwareCapability(String serverName, String urlMarker, String assetGUID, String capabilityGUID, DeleteRelationshipRequestBody requestBody)
      Remove a relationship that links a software capability to an infrastructure asset like a software server.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the data set
      capabilityGUID - unique identifier of the data asset supplying the data
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      void 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)

    • linkDataSetContent

      public VoidResponse linkDataSetContent(String serverName, String urlMarker, String dataSetGUID, String dataContentAssetGUID, NewRelationshipRequestBody requestBody)
      Attach a data set to another asset (typically a data store) that is supplying the data.
      Parameters:
      serverName - name of the server to route the request to
      dataSetGUID - unique identifier of the data set
      dataContentAssetGUID - unique identifier of the data asset supplying the data
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      void 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)

    • detachDataSetContent

      public VoidResponse detachDataSetContent(String serverName, String urlMarker, String dataSetGUID, String dataContentAssetGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data set from another asset that was supplying the data and is no more.
      Parameters:
      serverName - name of the server to route the request to
      dataSetGUID - unique identifier of the data set
      dataContentAssetGUID - unique identifier of the data asset supplying the data
      urlMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      void 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)

    • createAction

      public GUIDResponse createAction(String serverName, String urlMarker, ActionRequestBody requestBody)
      Create a new action and link it to the supplied role and targets (if applicable).
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - properties of the to do action
      Returns:
      unique identifier of the to do or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • addActionTarget

      public GUIDResponse addActionTarget(String serverName, String urlMarker, String actionGUID, String metadataElementGUID, NewRelationshipRequestBody requestBody)
      Add an element to an action's workload.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      actionGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • updateActionTargetProperties

      public VoidResponse updateActionTargetProperties(String serverName, String urlMarker, String actionTargetGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties associated with an Action Target.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      actionTargetGUID - unique identifier of the action target relationship
      requestBody - properties to change
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionTarget

      public OpenMetadataRelationshipResponse getActionTarget(String serverName, String urlMarker, String relationshipGUID, GetRequestBody requestBody)
      Retrieve a specific action target associated with an action.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      relationshipGUID - unique identifier of the relationship.
      requestBody - describes ho the results should be returned
      Returns:
      details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getActionTargets

      public OpenMetadataRootElementsResponse getActionTargets(String serverName, String urlMarker, String integrationConnectorGUID, ResultsRequestBody requestBody)
      Retrieve the details of the metadata elements identified as action targets with an action.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - describes how results are to be returned
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getActionsForActionTarget

      public OpenMetadataRootElementsResponse getActionsForActionTarget(String serverName, String urlMarker, String elementGUID, ActivityStatusRequestBody requestBody)
      Retrieve the actions that are chained off of an action target element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element to start with
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsForSponsor

      public OpenMetadataRootElementsResponse getActionsForSponsor(String serverName, String urlMarker, String elementGUID, ActivityStatusRequestBody requestBody)
      Retrieve the actions that are chained off of a sponsoring element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element to start with
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getAssignedActions

      public OpenMetadataRootElementsResponse getAssignedActions(String serverName, String urlMarker, String actorGUID, ActivityStatusRequestBody requestBody)
      Retrieve the "Actions" for a particular actor.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      actorGUID - unique identifier of the role
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • addCatalogTarget

      public GUIDResponse addCatalogTarget(String serverName, String urlMarker, String integrationConnectorGUID, String metadataElementGUID, NewRelationshipRequestBody requestBody)
      Add a catalog target to an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • updateCatalogTarget

      public VoidResponse updateCatalogTarget(String serverName, String urlMarker, String relationshipGUID, UpdateRelationshipRequestBody requestBody)
      Update a catalog target for an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      relationshipGUID - unique identifier of the relationship.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • getCatalogTarget

      public OpenMetadataRelationshipResponse getCatalogTarget(String serverName, String urlMarker, String relationshipGUID, GetRequestBody requestBody)
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      relationshipGUID - unique identifier of the relationship.
      requestBody - describes ho the results should be returned
      Returns:
      details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getCatalogTargets

      public OpenMetadataRootElementsResponse getCatalogTargets(String serverName, String urlMarker, String integrationConnectorGUID, ResultsRequestBody requestBody)
      Retrieve the details of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - describes how results are to be returned
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      public VoidResponse removeCatalogTarget(String serverName, String urlMarker, String relationshipGUID, DeleteRelationshipRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      relationshipGUID - unique identifier of the integration connector.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      public VoidResponse removeCatalogTarget(String serverName, String urlMarker, String integrationConnectorGUID, String elementGUID, DeleteRelationshipRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration connector.
      elementGUID - unique identifier of the target element.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.