Package org.odpi.openmetadata.accessservices.governanceprogram.client

Class RightsManager

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

org.odpi.openmetadata.accessservices.governanceprogram.client.RightsManager

All Implemented Interfaces:

RelatedElementsManagementInterface, RightsManagementInterface

public class RightsManager
extends GovernanceProgramBaseClient
implements RightsManagementInterface

RightsManager is the java client for managing license types and the licensing of elements.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

nullRequestBody

Constructor Summary

Constructors

Constructor	Description
RightsManager(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
RightsManager(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
RightsManager(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
RightsManager(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
RightsManager(String serverName, String serverPlatformURLRoot, GovernanceProgramRESTClient restClient, int maxPageSize)	Create a new client that uses the supplied rest client.

Method Summary

Modifier and Type	Method	Description
String	createLicenseType(String userId, LicenseTypeProperties properties, GovernanceDefinitionStatus initialStatus)	Create a description of the license type.
void	deleteLicenseType(String userId, String licenseTypeGUID)	Delete the properties of the license type.
List<RelatedElement>	getLicensedElements(String userId, String licenseGUID, int startFrom, int pageSize)	Return information about the elements linked to a license.
List<LicenseElement>	getLicenses(String userId, String elementGUID, int startFrom, int pageSize)	Return information about the licenses linked to an element.
LicenseTypeElement	getLicenseTypeByDocId(String userId, String documentIdentifier)	Retrieve the license type by its assigned unique document identifier.
List<LicenseTypeElement>	getLicenseTypeByDomainId(String userId, int domainIdentifier, int startFrom, int pageSize)	Retrieve all the license type definitions for a specific governance domain.
LicenseTypeElement	getLicenseTypeByGUID(String userId, String licenseTypeGUID)	Retrieve the license type by the unique identifier assigned by this service when it was created.
List<LicenseTypeElement>	getLicenseTypesByTitle(String userId, String title, int startFrom, int pageSize)	Retrieve all the license types for a particular title.
String	licenseElement(String userId, String elementGUID, String licenseTypeGUID, LicenseProperties properties)	Link an element to a license type and include details of the license in the relationship properties.
void	setLicenseTypeStatus(String userId, String licenseTypeGUID, GovernanceDefinitionStatus newStatus)	Update the status of a license type
void	unlicenseElement(String userId, String licenseGUID)	Remove the license for an element.
void	updateLicense(String userId, String licenseGUID, boolean isMergeUpdate, LicenseProperties properties)	Update the properties of a license.
void	updateLicenseType(String userId, String licenseTypeGUID, boolean isMergeUpdate, LicenseTypeProperties properties)	Update the properties of the license type.

Methods inherited from class org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

clearAssignmentScope, clearGovernanceDefinitionScope, clearGovernanceResponsibilityAssignment, clearGovernedBy, clearMoreInformation, clearResource, clearStakeholder, getAssignedActors, getAssignedScopes, getDescriptiveElements, getGovernanceDefinitionScopes, getGovernanceDefinitionsForElement, getGovernedElements, getMoreInformation, getResourceList, getResponsibleRoles, getRoleResponsibilities, getScopedGovernanceDefinitions, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, removeReferenceable, setupAssignmentScope, setupGovernanceDefinitionScope, setupGovernanceResponsibilityAssignment, setupGovernedBy, setupMoreInformation, setupResource, setupStakeholder, updateGovernanceDefinitionStatus, updateRelationship

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RightsManager

public RightsManager(String serverName,
                     String serverPlatformURLRoot)
              throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - bad input parameters

RightsManager

public RightsManager(String serverName,
                     String serverPlatformURLRoot,
                     String userId,
                     String password)
              throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - bad input parameters

RightsManager

public RightsManager(String serverName,
                     String serverPlatformURLRoot,
                     int maxPageSize,
                     AuditLog auditLog)
              throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - bad input parameters

RightsManager

public RightsManager(String serverName,
                     String serverPlatformURLRoot,
                     String userId,
                     String password,
                     int maxPageSize,
                     AuditLog auditLog)
              throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - bad input parameters

RightsManager

public RightsManager(String serverName,
                     String serverPlatformURLRoot,
                     GovernanceProgramRESTClient restClient,
                     int maxPageSize)
              throws InvalidParameterException

Create a new client that uses the supplied rest client. This is typically used when called from another OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - internal client for rest calls

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - bad input parameters

Method Detail

createLicenseType

public String createLicenseType(String userId,
                                LicenseTypeProperties properties,
                                GovernanceDefinitionStatus initialStatus)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create a description of the license type.

Specified by:

createLicenseType in interface RightsManagementInterface

Parameters:

userId - calling user

properties - license properties

initialStatus - what is the initial status for the license type definition - default value is DRAFT

Returns:

unique identifier of new definition

Throws:

InvalidParameterException - documentIdentifier or userId is null; documentIdentifier is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateLicenseType

public void updateLicenseType(String userId,
                              String licenseTypeGUID,
                              boolean isMergeUpdate,
                              LicenseTypeProperties properties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Update the properties of the license type.

Specified by:

updateLicenseType in interface RightsManagementInterface

Parameters:

userId - calling user

licenseTypeGUID - identifier of the governance definition to change

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - license properties

Throws:

InvalidParameterException - guid, documentIdentifier or userId is null; documentIdentifier is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setLicenseTypeStatus

public void setLicenseTypeStatus(String userId,
                                 String licenseTypeGUID,
                                 GovernanceDefinitionStatus newStatus)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Update the status of a license type

Specified by:

setLicenseTypeStatus in interface RightsManagementInterface

Parameters:

userId - calling user

licenseTypeGUID - identifier of the governance definition to change

newStatus - new status

Throws:

InvalidParameterException - guid, documentIdentifier or userId is null; documentIdentifier is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteLicenseType

public void deleteLicenseType(String userId,
                              String licenseTypeGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Delete the properties of the license type.

Specified by:

deleteLicenseType in interface RightsManagementInterface

Parameters:

userId - calling user

licenseTypeGUID - identifier of the governance definition to delete

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypeByGUID

public LicenseTypeElement getLicenseTypeByGUID(String userId,
                                               String licenseTypeGUID)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Retrieve the license type by the unique identifier assigned by this service when it was created.

Specified by:

getLicenseTypeByGUID in interface RightsManagementInterface

Parameters:

userId - calling user

licenseTypeGUID - identifier of the governance definition to retrieve

Returns:

properties of the license type

Throws:

InvalidParameterException - guid or userId is null; guid is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypeByDocId

public LicenseTypeElement getLicenseTypeByDocId(String userId,
                                                String documentIdentifier)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Retrieve the license type by its assigned unique document identifier.

Specified by:

getLicenseTypeByDocId in interface RightsManagementInterface

Parameters:

userId - calling user

documentIdentifier - identifier to search for

Returns:

properties of the matching license type

Throws:

InvalidParameterException - documentIdentifier or userId is null; documentIdentifier is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypesByTitle

public List<LicenseTypeElement> getLicenseTypesByTitle(String userId,
                                                       String title,
                                                       int startFrom,
                                                       int pageSize)
                                                throws UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       PropertyServerException

Retrieve all the license types for a particular title. The title can include regEx wildcards.

Specified by:

getLicenseTypesByTitle in interface RightsManagementInterface

Parameters:

userId - calling user

title - short description of the role

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

list of matching roles (null if no matching elements)

Throws:

InvalidParameterException - title or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypeByDomainId

public List<LicenseTypeElement> getLicenseTypeByDomainId(String userId,
                                                         int domainIdentifier,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve all the license type definitions for a specific governance domain.

Specified by:

getLicenseTypeByDomainId in interface RightsManagementInterface

Parameters:

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

Throws:

InvalidParameterException - domainIdentifier or userId is null; domainIdentifier is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

licenseElement

public String licenseElement(String userId,
                             String elementGUID,
                             String licenseTypeGUID,
                             LicenseProperties properties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Link an element to a license type and include details of the license in the relationship properties.

Specified by:

licenseElement in interface RightsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element being certified

licenseTypeGUID - unique identifier for the license type

properties - the properties of the license

Returns:

unique identifier of the new relationship

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateLicense

public void updateLicense(String userId,
                          String licenseGUID,
                          boolean isMergeUpdate,
                          LicenseProperties properties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the properties of a license.

Specified by:

updateLicense in interface RightsManagementInterface

Parameters:

userId - calling user

licenseGUID - unique identifier for the license relationship

isMergeUpdate - should the supplied properties overlay the existing properties or replace them

properties - the properties of the license

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlicenseElement

public void unlicenseElement(String userId,
                             String licenseGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the license for an element.

Specified by:

unlicenseElement in interface RightsManagementInterface

Parameters:

userId - calling user

licenseGUID - unique identifier for the license relationship

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicensedElements

public List<RelatedElement> getLicensedElements(String userId,
                                                String licenseGUID,
                                                int startFrom,
                                                int pageSize)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Return information about the elements linked to a license.

Specified by:

getLicensedElements in interface RightsManagementInterface

Parameters:

userId - calling user

licenseGUID - unique identifier for the license

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenses

public List<LicenseElement> getLicenses(String userId,
                                        String elementGUID,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return information about the licenses linked to an element.

Specified by:

getLicenses in interface RightsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier for the license

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem