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

Class SubjectAreaManager

java.lang.Object

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

org.odpi.openmetadata.accessservices.governanceprogram.client.SubjectAreaManager

All Implemented Interfaces:

RelatedElementsManagementInterface, SubjectAreasInterface

public class SubjectAreaManager
extends GovernanceProgramBaseClient
implements SubjectAreasInterface

The SubjectAreasInterface is used by the governance team to define the subject area for topic related governance definitions.

Field Summary

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

nullRequestBody

Constructor Summary

Constructors

Constructor	Description
SubjectAreaManager(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
SubjectAreaManager(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
SubjectAreaManager(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
SubjectAreaManager(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.
SubjectAreaManager(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
void	addSubjectAreaMemberClassification(String userId, String elementGUID, SubjectAreaClassificationProperties properties)	Add a subject area classification to a referenceable element.
String	createSubjectArea(String userId, SubjectAreaProperties properties)	Create a definition of a subject area.
void	deleteSubjectArea(String userId, String subjectAreaGUID)	Remove the definition of a subject area.
void	deleteSubjectAreaMemberClassification(String userId, String elementGUID)	Remove a subject area classification from a referenceable.
List<ElementStub>	getMembersOfSubjectArea(String userId, String subjectAreaName, int startFrom, int pageSize)	Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
SubjectAreaElement	getSubjectAreaByGUID(String userId, String subjectAreaGUID)	Return information about a specific subject area.
SubjectAreaElement	getSubjectAreaByName(String userId, String qualifiedName)	Return information about a specific subject area.
SubjectAreaDefinition	getSubjectAreaDefinitionByGUID(String userId, String subjectAreaGUID)	Return information about a specific subject area and its linked governance definitions.
List<SubjectAreaElement>	getSubjectAreasForDomain(String userId, int domainIdentifier, int startFrom, int pageSize)	Return information about the defined subject areas.
void	linkSubjectAreasInHierarchy(String userId, String parentSubjectAreaGUID, String childSubjectAreaGUID)	Link two related subject areas together as part of a hierarchy.
void	unlinkSubjectAreasInHierarchy(String userId, String parentSubjectAreaGUID, String childSubjectAreaGUID)	Remove the link between two subject areas in the subject area hierarchy.
void	updateSubjectArea(String userId, String subjectAreaGUID, boolean isMergeUpdate, SubjectAreaProperties properties)	Update the definition of a subject area.

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 Details

SubjectAreaManager

public SubjectAreaManager(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 services

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

SubjectAreaManager

public SubjectAreaManager(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 services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

SubjectAreaManager

public SubjectAreaManager(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 services

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

SubjectAreaManager

public SubjectAreaManager(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 services

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 - there is a problem creating the client-side components to issue any REST API calls.

SubjectAreaManager

public SubjectAreaManager(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 services

restClient - internal client for rest calls

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - bad input parameters

Method Details

createSubjectArea

public String createSubjectArea(String userId,
 SubjectAreaProperties properties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a definition of a subject area.

Specified by:

createSubjectArea in interface SubjectAreasInterface

Parameters:

userId - calling user

properties - properties for a subject area

Returns:

unique identifier of subject area

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateSubjectArea

public void updateSubjectArea(String userId,
 String subjectAreaGUID,
 boolean isMergeUpdate,
 SubjectAreaProperties properties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the definition of a subject area.

Specified by:

updateSubjectArea in interface SubjectAreasInterface

Parameters:

userId - calling user

subjectAreaGUID - unique identifier of subject area

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

properties - properties to change

Throws:

InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteSubjectArea

public void deleteSubjectArea(String userId,
 String subjectAreaGUID)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the definition of a subject area.

Specified by:

deleteSubjectArea in interface SubjectAreasInterface

Parameters:

userId - calling user

subjectAreaGUID - unique identifier of subject area

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkSubjectAreasInHierarchy

public void linkSubjectAreasInHierarchy(String userId,
 String parentSubjectAreaGUID,
 String childSubjectAreaGUID)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Link two related subject areas together as part of a hierarchy. A subject area can only have one parent but many child subject areas.

Specified by:

linkSubjectAreasInHierarchy in interface SubjectAreasInterface

Parameters:

userId - calling user

parentSubjectAreaGUID - unique identifier of the parent subject area

childSubjectAreaGUID - unique identifier of the child subject area

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkSubjectAreasInHierarchy

public void unlinkSubjectAreasInHierarchy(String userId,
 String parentSubjectAreaGUID,
 String childSubjectAreaGUID)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between two subject areas in the subject area hierarchy.

Specified by:

unlinkSubjectAreasInHierarchy in interface SubjectAreasInterface

Parameters:

userId - calling user

parentSubjectAreaGUID - unique identifier of the parent subject area

childSubjectAreaGUID - unique identifier of the child subject area

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreaByGUID

public SubjectAreaElement getSubjectAreaByGUID(String userId,
 String subjectAreaGUID)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific subject area.

Specified by:

getSubjectAreaByGUID in interface SubjectAreasInterface

Parameters:

userId - calling user

subjectAreaGUID - unique identifier for the subject area

Returns:

properties of the subject area

Throws:

InvalidParameterException - subjectAreaGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreaByName

public SubjectAreaElement getSubjectAreaByName(String userId,
 String qualifiedName)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific subject area.

Specified by:

getSubjectAreaByName in interface SubjectAreasInterface

Parameters:

userId - calling user

qualifiedName - unique name for the subject area

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreasForDomain

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

Return information about the defined subject areas.

Specified by:

getSubjectAreasForDomain in interface SubjectAreasInterface

Parameters:

userId - calling user

domainIdentifier - identifier for the desired governance domain - zero for all

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

getSubjectAreaDefinitionByGUID

public SubjectAreaDefinition getSubjectAreaDefinitionByGUID(String userId,
 String subjectAreaGUID)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about a specific subject area and its linked governance definitions.

Specified by:

getSubjectAreaDefinitionByGUID in interface SubjectAreasInterface

Parameters:

userId - calling user

subjectAreaGUID - unique identifier for the subject area

Returns:

properties of the subject area

Throws:

InvalidParameterException - subjectAreaGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSubjectAreaMemberClassification

public void addSubjectAreaMemberClassification(String userId,
 String elementGUID,
 SubjectAreaClassificationProperties properties)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a subject area classification to a referenceable element.

Specified by:

addSubjectAreaMemberClassification in interface SubjectAreasInterface

Parameters:

userId - calling user

elementGUID - unique identifier for the element

properties - identifier for a subject area

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteSubjectAreaMemberClassification

public void deleteSubjectAreaMemberClassification(String userId,
 String elementGUID)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a subject area classification from a referenceable.

Specified by:

deleteSubjectAreaMemberClassification in interface SubjectAreasInterface

Parameters:

userId - calling user

elementGUID - unique identifier for the element

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getMembersOfSubjectArea

public List<ElementStub> getMembersOfSubjectArea(String userId,
 String subjectAreaName,
 int startFrom,
 int pageSize)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

Specified by:

getMembersOfSubjectArea in interface SubjectAreasInterface

Parameters:

userId - calling user

subjectAreaName - unique identifier for the subject area

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the subject area members

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem