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 InvalidParameterHandler	invalidParameterHandler
protected OMRSAPIHelper	oMRSAPIHelper
protected RepositoryHandler	repositoryHandler
protected OMRSRepositoryHelper	repositoryHelper
protected String	serverName
protected String	serviceName

Constructor Summary

Constructors

Constructor and Description
SubjectAreaHandler()
SubjectAreaHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, RepositoryHandler repositoryHandler, OMRSAPIHelper oMRSAPIHelper, RepositoryErrorHandler errorHandler) Construct the Subject Area Project Handler needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
protected SubjectAreaOMASAPIResponse	getRelationshipsFromGuid(String restAPIName, String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get relationships
protected abstract SubjectAreaOMASAPIResponse	getResponse(SubjectAreaOMASAPIResponse response) Take an entityDetail response and map it to the appropriate Project orientated response
protected SubjectAreaOMASAPIResponse	validateGlossarySummaryDuringCreation(SubjectAreaGlossaryHandler glossaryHandler, 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

serviceName

protected String serviceName

serverName

protected String serverName

repositoryHandler

protected RepositoryHandler repositoryHandler

repositoryHelper

protected OMRSRepositoryHelper repositoryHelper

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

oMRSAPIHelper

protected OMRSAPIHelper oMRSAPIHelper

Constructor Detail

SubjectAreaHandler

public SubjectAreaHandler()

SubjectAreaHandler

public SubjectAreaHandler(String serviceName,
                          String serverName,
                          InvalidParameterHandler invalidParameterHandler,
                          OMRSRepositoryHelper repositoryHelper,
                          RepositoryHandler repositoryHandler,
                          OMRSAPIHelper oMRSAPIHelper,
                          RepositoryErrorHandler errorHandler)

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

Parameters:

serviceName - name of the consuming service

serverName - name of this server instance

invalidParameterHandler - handler for invalid parameters

repositoryHelper - helper used by the converters

repositoryHandler - handler for calling the repository services

errorHandler - handler for repository service errors

Method Detail

getResponse

protected abstract SubjectAreaOMASAPIResponse getResponse(SubjectAreaOMASAPIResponse response)

Take an entityDetail response and map it to the appropriate Project orientated response

Parameters:

response - entityDetailResponse

Returns:

Project response containing the appropriate Project object.

getRelationshipsFromGuid

protected SubjectAreaOMASAPIResponse getRelationshipsFromGuid(String restAPIName,
                                                              String userId,
                                                              String guid,
                                                              Date asOfTime,
                                                              Integer offset,
                                                              Integer pageSize,
                                                              SequencingOrder sequencingOrder,
                                                              String sequencingProperty)

Get relationships

Parameters:

restAPIName - ret API name

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

guid - guid of the term to get

asOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.

offset - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request. 0 means there is not limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

Returns:

the relationships associated with the requested guid when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised.
• ClassificationException Error processing a classification.
• StatusNotSupportedException A status value is not supported.

validateGlossarySummaryDuringCreation

protected SubjectAreaOMASAPIResponse validateGlossarySummaryDuringCreation(SubjectAreaGlossaryHandler glossaryHandler,
                                                                           String userId,
                                                                           String methodName,
                                                                           GlossarySummary suppliedGlossary)

This method validated for creation.

Parameters:

glossaryHandler - glossary handler

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.