org.odpi.openmetadata.accessservices.subjectarea.handlers

Class SubjectAreaHandler

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler

Direct Known Subclasses:

SubjectAreaCategoryHandler, SubjectAreaConfigHandler, SubjectAreaGlossaryHandler, SubjectAreaGraphHandler, SubjectAreaProjectHandler, SubjectAreaRelationshipHandler, SubjectAreaTermHandler

public abstract class SubjectAreaHandler
extends Object

SubjectAreaProjectHandler manages Project objects from the property server. It runs server-side in the subject Area OMAS and retrieves entities and relationships through the OMRSRepositoryConnector.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CATEGORY_ANCHOR_RELATIONSHIP_NAME
protected static String	CATEGORY_HIERARCHY_LINK_RELATIONSHIP_NAME
protected static String	CATEGORY_TYPE_NAME
protected static String	GLOSSARY_TYPE_NAME
protected InvalidParameterHandler	invalidParameterHandler
protected MappersFactory	mappersFactory
protected int	maxPageSize
protected OMRSAPIHelper	oMRSAPIHelper
protected static String	PROJECT_SCOPE_RELATIONSHIP_NAME
protected static String	PROJECT_TYPE_NAME
protected static String	TERM_ANCHOR_RELATIONSHIP_NAME
protected static String	TERM_CATEGORIZATION_RELATIONSHIP_NAME
protected static String	TERM_TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
SubjectAreaHandler(OMRSAPIHelper oMRSAPIHelper, int maxPageSize) Construct the Subject Area Project Handler needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	categoryMatchSearchCriteria(Category category, String searchCriteria) return whether the Category matches the search criteria
protected void	checkReadOnly(String methodName, Node node, String operation) Check whether the node is readonly and throw and exception if it is
protected void	checkRelationshipReadOnly(String methodName, Relationship relationship, String operation) Check whether the relationship is readonly and throw and exception if it is
<R extends InstanceHeader,T extends OmasObject> List<T>	convertOmrsToOmas(Collection<R> list, Class<? extends Mapper> mapperInterface)
protected <T extends Node> List<T>	findEntities(String userId, String typeEntityName, FindRequest findRequest, Class<? extends INodeMapper<T>> mapperClass, String methodName)
List<Relationship>	getAllRelationshipForEntity(String restAPIName, String userId, String entityGuid, FindRequest findRequest) Get the relationships keyed off an entity guid.
SubjectAreaOMASAPIResponse<Relationship>	getAllRelationshipsForEntity(String methodName, String userId, String guid, FindRequest findRequest) Get All relationships for Node
int	getMaxPageSize()
List<Node>	getNodesFromEntityDetails(Collection<EntityDetail> entityDetails)
<T extends Node> SubjectAreaOMASAPIResponse<T>	getRelatedNodesForEnd1(String methodName, String userId, String guid, String relationshipTypeName, Class<? extends INodeMapper<T>> mapperClass, Integer startingFrom, Integer pageSize) Get the related nodes from end 1 of a given type of relationship
<T extends Node> SubjectAreaOMASAPIResponse<T>	getRelatedNodesForEnd2(String methodName, String userId, String guid, String relationshipTypeName, Class<? extends INodeMapper<T>> mapperClass, Integer startingFrom, Integer pageSize) Get the related nodes from end 2 of a given type of relationship
List<Relationship>	getRelationshipsFromRelationships(Collection<Relationship> relationships)
protected void	setUniqueQualifiedNameIfBlank(Node node) Set unique qualifiedName into the supplied Node.
protected boolean	termMatchSearchCriteria(Term term, String searchCriteria) return whether the Term matches the search criteria
protected String	validateGlossarySummaryDuringCreation(String userId, String methodName, GlossarySummary suppliedGlossary) This method validated for creation.

Methods inherited from class java.lang.Object

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

Field Detail

GLOSSARY_TYPE_NAME

protected static final String GLOSSARY_TYPE_NAME

See Also:

Constant Field Values

CATEGORY_TYPE_NAME

protected static final String CATEGORY_TYPE_NAME

See Also:

Constant Field Values

TERM_TYPE_NAME

protected static final String TERM_TYPE_NAME

See Also:

Constant Field Values

PROJECT_TYPE_NAME

protected static final String PROJECT_TYPE_NAME

See Also:

Constant Field Values

TERM_ANCHOR_RELATIONSHIP_NAME

protected static final String TERM_ANCHOR_RELATIONSHIP_NAME

See Also:

Constant Field Values

TERM_CATEGORIZATION_RELATIONSHIP_NAME

protected static final String TERM_CATEGORIZATION_RELATIONSHIP_NAME

See Also:

Constant Field Values

PROJECT_SCOPE_RELATIONSHIP_NAME

protected static final String PROJECT_SCOPE_RELATIONSHIP_NAME

See Also:

Constant Field Values

CATEGORY_ANCHOR_RELATIONSHIP_NAME

protected static final String CATEGORY_ANCHOR_RELATIONSHIP_NAME

See Also:

Constant Field Values

CATEGORY_HIERARCHY_LINK_RELATIONSHIP_NAME

protected static final String CATEGORY_HIERARCHY_LINK_RELATIONSHIP_NAME

See Also:

Constant Field Values

mappersFactory

protected final MappersFactory mappersFactory

oMRSAPIHelper

protected final OMRSAPIHelper oMRSAPIHelper

maxPageSize

protected final int maxPageSize

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

Constructor Detail

SubjectAreaHandler

public SubjectAreaHandler(OMRSAPIHelper oMRSAPIHelper,
                          int maxPageSize)

Construct the Subject Area Project Handler needed to operate within a single server instance.

Parameters:

oMRSAPIHelper - omrs API helper

maxPageSize - maximum page size

Method Detail

getMaxPageSize

public int getMaxPageSize()

findEntities

protected <T extends Node> List<T> findEntities(String userId,
                                                String typeEntityName,
                                                FindRequest findRequest,
                                                Class<? extends INodeMapper<T>> mapperClass,
                                                String methodName)
                                         throws SubjectAreaCheckedException,
                                                PropertyServerException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException

Throws:

SubjectAreaCheckedException

PropertyServerException

UserNotAuthorizedException

InvalidParameterException

getRelatedNodesForEnd1

public <T extends Node> SubjectAreaOMASAPIResponse<T> getRelatedNodesForEnd1(String methodName,
                                                                             String userId,
                                                                             String guid,
                                                                             String relationshipTypeName,
                                                                             Class<? extends INodeMapper<T>> mapperClass,
                                                                             Integer startingFrom,
                                                                             Integer pageSize)

Get the related nodes from end 1 of a given type of relationship

Parameters:

methodName - name of the method being called.

userId - unique identifier for requesting user, under which the request is performed

guid - guid

relationshipTypeName - relationship type name

mapperClass - mapper class used to get the type name of the Node to return

startingFrom - retrieve items starting from this location

pageSize - maximum size of the returned items

Returns:

response containing the the related Nodes if there are any

getRelatedNodesForEnd2

public <T extends Node> SubjectAreaOMASAPIResponse<T> getRelatedNodesForEnd2(String methodName,
                                                                             String userId,
                                                                             String guid,
                                                                             String relationshipTypeName,
                                                                             Class<? extends INodeMapper<T>> mapperClass,
                                                                             Integer startingFrom,
                                                                             Integer pageSize)

Get the related nodes from end 2 of a given type of relationship

Parameters:

methodName - name of the method being called.

userId - unique identifier for requesting user, under which the request is performed

guid - guid

relationshipTypeName - relationship type name

mapperClass - mapper class used to get the type name of the Node to return

startingFrom - retrieve items starting from this location

pageSize - maximum size of the returned items

Returns:

response containing the the related Nodes if there are any

getAllRelationshipsForEntity

public SubjectAreaOMASAPIResponse<Relationship> getAllRelationshipsForEntity(String methodName,
                                                                             String userId,
                                                                             String guid,
                                                                             FindRequest findRequest)

Get All relationships for Node

Parameters:

methodName - name of the method being called.

userId - unique identifier for requesting user, under which the request is performed

guid - guid

findRequest - FindRequest

Returns:

the relationships associated with the requested guid

getAllRelationshipForEntity

public List<Relationship> getAllRelationshipForEntity(String restAPIName,
                                                      String userId,
                                                      String entityGuid,
                                                      FindRequest findRequest)
                                               throws SubjectAreaCheckedException,
                                                      PropertyServerException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException

Get the relationships keyed off an entity guid.

Parameters:

restAPIName - rest API name

userId - user identity

entityGuid - globally unique identifier

findRequest - FindRequest

Returns:

List<Relationship>

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

SubjectAreaCheckedException - standard exception Subject Area OMAS services

InvalidParameterException

getRelationshipsFromRelationships

public List<Relationship> getRelationshipsFromRelationships(Collection<Relationship> relationships)

getNodesFromEntityDetails

public List<Node> getNodesFromEntityDetails(Collection<EntityDetail> entityDetails)

convertOmrsToOmas

public <R extends InstanceHeader,T extends OmasObject> List<T> convertOmrsToOmas(Collection<R> list,
                                                                                 Class<? extends Mapper> mapperInterface)

validateGlossarySummaryDuringCreation

protected String validateGlossarySummaryDuringCreation(String userId,
                                                       String methodName,
                                                       GlossarySummary suppliedGlossary)
                                                throws UserNotAuthorizedException,
                                                       PropertyServerException,
                                                       InvalidParameterException,
                                                       SubjectAreaCheckedException

This method validated for creation.

Parameters:

userId - userId under which the request is performed

methodName - method making the call

suppliedGlossary - glossary to validate against.

Returns:

SubjectAreaOMASAPIResponse this response is of type ResponseCategory.Category.Glossary if successful, otherwise there is an error response.

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

SubjectAreaCheckedException - standard exception Subject Area OMAS services

setUniqueQualifiedNameIfBlank

protected void setUniqueQualifiedNameIfBlank(Node node)

Set unique qualifiedName into the supplied Node. The qualified name needs to be unique and is supplied on an addnEtity omrs call. Prior to the add, we do not know the guid of the entity. We do not want to add an entity, then immediately update it; as these changes to entity identity would be propagated across the cohort. So we set the qualified name by concatinating the supplied seed, an @ symbol and a newly generated UUID. The assumption is that this method is supplied a node that contains a name.

Parameters:

node - Node to set the unique qualified name into

categoryMatchSearchCriteria

protected boolean categoryMatchSearchCriteria(Category category,
                                              String searchCriteria)

return whether the Category matches the search criteria

Parameters:

category - category to use for match

searchCriteria - criteria to use for match

Returns:

boolean indicating whether the category matches the search criteria

termMatchSearchCriteria

protected boolean termMatchSearchCriteria(Term term,
                                          String searchCriteria)

return whether the Term matches the search criteria

Parameters:

term - term to use for match

searchCriteria - criteria to use for match

Returns:

boolean indicating whether the term matches the search criteria

checkReadOnly

protected void checkReadOnly(String methodName,
                             Node node,
                             String operation)
                      throws PropertyServerException

Check whether the node is readonly and throw and exception if it is

Parameters:

methodName - calling methodName

node - node to check

operation - operation being attempted

Throws:

PropertyServerException - exception thrown when the node is readonly

checkRelationshipReadOnly

protected void checkRelationshipReadOnly(String methodName,
                                         Relationship relationship,
                                         String operation)
                                  throws PropertyServerException

Check whether the relationship is readonly and throw and exception if it is

Parameters:

methodName - calling methodName

relationship - relationship to check

operation - operation being attempted

Throws:

PropertyServerException - exception thrown when the relationship is readonly