org.odpi.openmetadata.commonservices.generichandlers

Class SubjectAreaHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.SubjectAreaHandler<B>

public class SubjectAreaHandler<B>
extends OpenMetadataAPIGenericHandler<B>

SubjectAreaHandler provides the exchange of metadata about subject areas between the repository and the OMAS.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor and Description

SubjectAreaHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the subject area handler with information needed to work with B objects.

Method Summary

Modifier and Type	Method and Description
String	createSubjectArea(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String displayName, String description, String usage, String scope, int domainIdentifier, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName) Create a definition of a subject area.
B	getSubjectArea(String userId, String qualifiedName, String qualifiedNameParameter, String methodName) Return information about a specific subject area.
List<String>	getSubjectAreaChildrenGUIDs(String userId, String subjectAreaGUID, String subjectAreaGUIDParameter, String methodName) Return information about a specific subject area's child (nested) subjectAreas.
String	getSubjectAreaParentGUID(String userId, String subjectAreaGUID, String subjectAreaGUIDParameter, String methodName) Return information about a specific subject area's parent.
List<B>	getSubjectAreas(String userId, int startFrom, int pageSize, String methodName) Return information about the defined subject areas.
List<B>	getSubjectAreasByDomain(String userId, int domainIdentifier, int startFrom, int pageSize, String methodName) Return information about the defined subject areas for a specific domain.
void	updateSubjectArea(String userId, String externalSourceGUID, String externalSourceName, String subjectAreaGUID, String subjectAreaGUIDParameterName, String qualifiedName, String displayName, String description, String criteria, String scope, int domainIdentifier, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, boolean isMergeUpdate, String methodName) Create a definition of a subject area.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaHandler

public SubjectAreaHandler(OpenMetadataAPIGenericConverter<B> converter,
                          Class<B> beanClass,
                          String serviceName,
                          String serverName,
                          InvalidParameterHandler invalidParameterHandler,
                          RepositoryHandler repositoryHandler,
                          OMRSRepositoryHelper repositoryHelper,
                          String localServerUserId,
                          OpenMetadataServerSecurityVerifier securityVerifier,
                          List<String> supportedZones,
                          List<String> defaultZones,
                          List<String> publishZones,
                          AuditLog auditLog)

Construct the subject area handler with information needed to work with B objects.

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of subjectAreas that the access service is allowed to serve B instances from.

defaultZones - list of subjectAreas that the access service should set in all new B instances.

publishZones - list of subjectAreas that the access service sets up in published B instances.

auditLog - destination for audit log events.

Method Detail

createSubjectArea

public String createSubjectArea(String userId,
                                String externalSourceGUID,
                                String externalSourceName,
                                String qualifiedName,
                                String displayName,
                                String description,
                                String usage,
                                String scope,
                                int domainIdentifier,
                                Map<String,String> additionalProperties,
                                String suppliedTypeName,
                                Map<String,Object> extendedProperties,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create a definition of a subject area. The qualified name of these subject areas can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition the qualified names of subjectAreas can be added to Asset definitions to indicate which subjectArea(s) they belong to.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

qualifiedName - unique name for the subjectArea - used in other configuration

displayName - short display name for the subjectArea

description - description of the subject area

usage - the usage for inclusion in a subject area

scope - scope of the organization that this some applies to

domainIdentifier - the identifier of the governance domain where the subjectArea is managed

additionalProperties - additional properties for a subject area

suppliedTypeName - name of sub type - or null for SubjectAreaDefinition

extendedProperties - properties for a subject area subtype

methodName - calling method

Returns:

unique identifier of the new subjectArea

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateSubjectArea

public void updateSubjectArea(String userId,
                              String externalSourceGUID,
                              String externalSourceName,
                              String subjectAreaGUID,
                              String subjectAreaGUIDParameterName,
                              String qualifiedName,
                              String displayName,
                              String description,
                              String criteria,
                              String scope,
                              int domainIdentifier,
                              Map<String,String> additionalProperties,
                              String suppliedTypeName,
                              Map<String,Object> extendedProperties,
                              boolean isMergeUpdate,
                              String methodName)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Create a definition of a subject area. The qualified name of these subject areas can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition the qualified names of subjectAreas can be added to Asset definitions to indicate which subjectArea(s) they belong to.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

subjectAreaGUID - unique identifier of subject area

subjectAreaGUIDParameterName - parameter name for subjectAreaGUID

qualifiedName - unique name for the subjectArea - used in other configuration

displayName - short display name for the subjectArea

description - description of the subject area

criteria - the criteria for inclusion in a subject area

scope - scope of the organization that this some applies to

domainIdentifier - the identifier of the governance domain where the subjectArea is managed

additionalProperties - additional properties for a subject area

suppliedTypeName - subtype name

extendedProperties - properties for a subject area subtype

isMergeUpdate - should the supplied properties be merged with the existing one or replace them

methodName - calling method

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectArea

public B getSubjectArea(String userId,
                        String qualifiedName,
                        String qualifiedNameParameter,
                        String methodName)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Return information about a specific subject area.

Parameters:

userId - calling user

qualifiedName - unique name for the subjectArea

qualifiedNameParameter - name of parameter supplying the qualifiedName

methodName - calling method

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreaParentGUID

public String getSubjectAreaParentGUID(String userId,
                                       String subjectAreaGUID,
                                       String subjectAreaGUIDParameter,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Return information about a specific subject area's parent.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier for the subjectArea

subjectAreaGUIDParameter - name of parameter supplying the subjectAreaGUID

methodName - calling method

Returns:

unique identifier of the parent subject area

Throws:

InvalidParameterException - subjectAreaGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreaChildrenGUIDs

public List<String> getSubjectAreaChildrenGUIDs(String userId,
                                                String subjectAreaGUID,
                                                String subjectAreaGUIDParameter,
                                                String methodName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Return information about a specific subject area's child (nested) subjectAreas.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier for the subjectArea

subjectAreaGUIDParameter - name of parameter supplying the subjectAreaGUID

methodName - calling method

Returns:

list of unique identifier of the parent subject area

Throws:

InvalidParameterException - subjectAreaGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreas

public List<B> getSubjectAreas(String userId,
                               int startFrom,
                               int pageSize,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Return information about the defined subject areas.

Parameters:

userId - calling user

startFrom - position in the list (used when there are so many reports that paging is needed

pageSize - maximum number of elements to return an this call

methodName - calling method

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreasByDomain

public List<B> getSubjectAreasByDomain(String userId,
                                       int domainIdentifier,
                                       int startFrom,
                                       int pageSize,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Return information about the defined subject areas for a specific domain.

Parameters:

userId - calling user

domainIdentifier - identifier of domain - 0 is for all domains

startFrom - position in the list (used when there are so many reports that paging is needed

pageSize - maximum number of elements to return an this call

methodName - calling method

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem