Package org.odpi.openmetadata.accessservices.governanceprogram.server

Class LicenseRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.server.LicenseRESTServices
public class LicenseRESTServices extends Object
LicenseRESTServices is the java client for managing license types and the license of elements.

  • Constructor Details

    • LicenseRESTServices

      public LicenseRESTServices()
      Default constructor

  • Method Details

    • createLicenseType

      public GUIDResponse createLicenseType(String serverName, String userId, GovernanceDefinitionRequestBody requestBody)
      Create a description of the license type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - license properties and initial status
      Returns:
      unique identifier of new definition or InvalidParameterException documentIdentifier or userId is null; documentIdentifier is not unique PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • updateLicenseType

      public VoidResponse updateLicenseType(String serverName, String userId, String licenseTypeGUID, boolean isMergeUpdate, GovernanceDefinitionRequestBody requestBody)
      Update the properties of the license type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      licenseTypeGUID - identifier of the governance definition to change
      isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
      requestBody - license properties
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • deleteLicenseType

      public VoidResponse deleteLicenseType(String serverName, String userId, String licenseTypeGUID, ExternalSourceRequestBody requestBody)
      Delete the properties of the license type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      licenseTypeGUID - identifier of the governance definition to delete
      requestBody - external source request body
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicenseTypeByGUID

      public LicenseTypeResponse getLicenseTypeByGUID(String serverName, String userId, String licenseTypeGUID)
      Retrieve the license type by the unique identifier assigned by this service when it was created.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      licenseTypeGUID - identifier of the governance definition to retrieve
      Returns:
      properties of the license type or InvalidParameterException guid or userId is null; guid is not recognized PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicenseTypeByDocId

      public LicenseTypeResponse getLicenseTypeByDocId(String serverName, String userId, String documentIdentifier)
      Retrieve the license type by its assigned unique document identifier.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      documentIdentifier - identifier to search for
      Returns:
      properties of the matching license type or InvalidParameterException documentIdentifier or userId is null; documentIdentifier is not recognized PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicenseTypesByTitle

      public LicenseTypesResponse getLicenseTypesByTitle(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)
      Retrieve all the license types for a particular title. The title can include regEx wildcards.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - short description of the license
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      list of matching license types (null if no matching elements) or InvalidParameterException title or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicenseTypeByDomainId

      public LicenseTypesResponse getLicenseTypeByDomainId(String serverName, String userId, int domainIdentifier, int startFrom, int pageSize)
      Retrieve all the license type definitions for a specific governance domain.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      domainIdentifier - identifier to search for
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      properties of the matching license type definitions or InvalidParameterException domainIdentifier or userId is null; domainIdentifier is not recognized PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • licenseElement

      public GUIDResponse licenseElement(String serverName, String userId, String elementGUID, String licenseTypeGUID, RelationshipRequestBody requestBody)
      Link an element to a license type and include details of the license in the relationship properties.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier of the element being licensed
      licenseTypeGUID - unique identifier for the license type
      requestBody - the properties of the license
      Returns:
      guid or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • updateLicense

      public VoidResponse updateLicense(String serverName, String userId, String licenseGUID, boolean isMergeUpdate, RelationshipRequestBody requestBody)
      Update the properties of a license. Remember to include the licenseId in the properties if the element has multiple licenses for the same license type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      licenseGUID - unique identifier for the license type
      isMergeUpdate - should the supplied properties overlay the existing properties or replace them
      requestBody - the properties of the license
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • unlicenseElement

      public VoidResponse unlicenseElement(String serverName, String userId, String licenseGUID, RelationshipRequestBody requestBody)
      Remove the license for an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      licenseGUID - unique identifier for the license type
      requestBody - external source information.
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicensedElements

      public RelatedElementsResponse getLicensedElements(String serverName, String userId, String licenseTypeGUID, int startFrom, int pageSize)
      Return information about the elements linked to a license.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      licenseTypeGUID - unique identifier for the license
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicenses

      public RelatedElementsResponse getLicenses(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
      Return information about the licenses linked to an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier for the license
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem