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 VoidResponse 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:
      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.

    • deleteAsset

      public VoidResponse deleteAsset(String serverName, String urlMarker, String assetGUID, DeleteRequestBody 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)

    • 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)