org.odpi.openmetadata.accessservices.subjectarea.handlers

Class SubjectAreaHandler

java.lang.Object

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

Direct Known Subclasses:

SubjectAreaCategoryHandler, 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 MappersFactory	mappersFactory
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_TYPE_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<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<Line>	getAllLineForEntity(String restAPIName, String userId, String entityGuid, FindRequest findRequest) Get the relationships keyed off an entity guid.
SubjectAreaOMASAPIResponse<Line>	getAllRelationshipsForEntity(String methodName, String userId, String guid, FindRequest findRequest) Get All relationships for entity
List<Line>	getLinesFromRelationships(Collection<Relationship> relationships)
List<Node>	getNodesFromEntityDetails(Collection<EntityDetail> entityDetails)
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

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

Constructor Detail

SubjectAreaHandler

public SubjectAreaHandler(OMRSAPIHelper oMRSAPIHelper)

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

Parameters:

oMRSAPIHelper - omrs API helper

Method Detail

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

Throws:

SubjectAreaCheckedException

PropertyServerException

UserNotAuthorizedException

getAllRelationshipsForEntity

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

Get All relationships for entity

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

getAllLineForEntity

public List<Line> getAllLineForEntity(String restAPIName,
                                      String userId,
                                      String entityGuid,
                                      FindRequest findRequest)
                               throws SubjectAreaCheckedException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Get the relationships keyed off an entity guid.

Parameters:

restAPIName - rest API name

userId - user identity

entityGuid - globally unique identifier

findRequest - FindRequest

Returns:

List<Line>

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

getLinesFromRelationships

public List<Line> getLinesFromRelationships(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