org.odpi.openmetadata.accessservices.subjectarea.server.services

Class SubjectAreaRESTServicesInstance

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance

Direct Known Subclasses:

SubjectAreaCategoryRESTServices, SubjectAreaGlossaryRESTServices, SubjectAreaGraphRESTServices, SubjectAreaProjectRESTServices, SubjectAreaRelationshipRESTServices, SubjectAreaTermRESTServices

public class SubjectAreaRESTServicesInstance
extends Object

SubjectAreaRESTServicesInstance caches references to OMRS objects for a specific server. It is also responsible for registering itself in the instance map.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaInstanceHandler	instanceHandler
protected OMRSAPIHelper	oMRSAPIHelper

Constructor Summary

Constructors

Constructor and Description
SubjectAreaRESTServicesInstance() Default constructor

Method Summary

Modifier and Type	Method and Description
protected SubjectAreaOMASAPIResponse	createLine(String serverName, String restAPIName, String userId, String className, Line line) Create a Line (relationship), which is a link between two Nodes.
SubjectAreaOMASAPIResponse	deleteLine(String serverName, String restAPIName, String userId, String className, String guid, Boolean isPurge) Delete a Line (relationship)
protected SubjectAreaOMASAPIResponse	getLine(String serverName, String restAPIName, String userId, String className, String guid) Get a Line (relationship)
SubjectAreaOMASAPIResponse	getRelationshipsFromGuid(String serverName, String restAPIName, String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty)
protected SubjectAreaOMASAPIResponse	initializeAPI(String serverName, String userId, Date from, Date to, String restAPIName) Each API call needs to run in the requested tenant - indicated by the serverName and validate the userid.
protected SubjectAreaOMASAPIResponse	initializeAPI(String serverName, String userId, String restAPIName) Each API call needs to run in the requested tenant - indicated by the serverName and validate the userid.
protected SubjectAreaOMASAPIResponse	restoreLine(String serverName, String restAPIName, String userId, String className, String guid) Restore a Line (relationship).
void	setOMRSAPIHelper(OMRSAPIHelper oMRSAPIHelper)
protected SubjectAreaOMASAPIResponse	updateLine(String serverName, String restAPIName, String userId, String className, Line line, boolean isReplace) Update a relationship.

Methods inherited from class java.lang.Object

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

Field Detail

oMRSAPIHelper

protected OMRSAPIHelper oMRSAPIHelper

instanceHandler

protected static org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaInstanceHandler instanceHandler

Constructor Detail

SubjectAreaRESTServicesInstance

public SubjectAreaRESTServicesInstance()

Default constructor

Method Detail

initializeAPI

protected SubjectAreaOMASAPIResponse initializeAPI(String serverName,
                                                   String userId,
                                                   String restAPIName)

Each API call needs to run in the requested tenant - indicated by the serverName and validate the userid.

Parameters:

serverName - server name used to create the instance

userId - userid under which the request will be made

restAPIName - rest API name for logging

Returns:

null if successful or the response containing the error

initializeAPI

protected SubjectAreaOMASAPIResponse initializeAPI(String serverName,
                                                   String userId,
                                                   Date from,
                                                   Date to,
                                                   String restAPIName)

Each API call needs to run in the requested tenant - indicated by the serverName and validate the userid.

Parameters:

serverName - server name used to create the instance

userId - userid under which the request will be made

from - effective from date

to - effective to Date

restAPIName - rest API name for logging

Returns:

null if successful or the response containing the error

setOMRSAPIHelper

public void setOMRSAPIHelper(OMRSAPIHelper oMRSAPIHelper)

getRelationshipsFromGuid

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

createLine

protected SubjectAreaOMASAPIResponse createLine(String serverName,
                                                String restAPIName,
                                                String userId,
                                                String className,
                                                Line line)

Create a Line (relationship), which is a link between two Nodes.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

line - line to create

Returns:

response, when successful contains the created line 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.
• FunctionNotSupportedException Function is not supported.

getLine

protected SubjectAreaOMASAPIResponse getLine(String serverName,
                                             String restAPIName,
                                             String userId,
                                             String className,
                                             String guid)

Get a Line (relationship)

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

guid - guid of the relationship to get

Returns:

response which when successful contains the relationship 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

updateLine

protected SubjectAreaOMASAPIResponse updateLine(String serverName,
                                                String restAPIName,
                                                String userId,
                                                String className,
                                                Line line,
                                                boolean isReplace)

Update a relationship.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

line - the relationship to update

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the updated Line 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.
• FunctionNotSupportedException Function not supported.

deleteLine

public SubjectAreaOMASAPIResponse deleteLine(String serverName,
                                             String restAPIName,
                                             String userId,
                                             String className,
                                             String guid,
                                             Boolean isPurge)

Delete a Line (relationship)

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

guid - guid of the HAS A relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete, the response contains the deleted relationship when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported.
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
• EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
• GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreLine

protected SubjectAreaOMASAPIResponse restoreLine(String serverName,
                                                 String restAPIName,
                                                 String userId,
                                                 String className,
                                                 String guid)

Restore a Line (relationship). Restore allows the deleted relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

guid - guid of the relationship to restore

Returns:

response which when successful contains the restored relationship when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported.
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
• EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
• GUIDNotPurgedException a hard delete was issued but the relationship was not purged