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

Class SubjectAreaRESTServicesInstance

java.lang.Object

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

Direct Known Subclasses:

SubjectAreaCategoryRESTServices, SubjectAreaConfigRESTServices, 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

Constructor Summary

Constructors

Constructor and Description
SubjectAreaRESTServicesInstance() Default constructor

Method Summary

Modifier and Type	Method and Description
protected <L extends Line> SubjectAreaOMASAPIResponse<L>	createLine(String serverName, String restAPIName, String userId, Class<? extends ILineMapper<L>> clazz, L line) Create a Line (relationship), which is a link between two Nodes.
<L extends Line> SubjectAreaOMASAPIResponse<L>	deleteLine(String serverName, String restAPIName, String userId, Class<? extends ILineMapper<L>> clazz, String guid, Boolean isPurge) Delete a Line (relationship)
protected FindRequest	getFindRequest(String searchCriteria, Date asOfTime, Integer startingFrom, Integer pageSize, String sequencingOrderName, String sequencingProperty, Integer handlerMaxPageSize)
protected <L extends Line> SubjectAreaOMASAPIResponse<L>	getLine(String serverName, String restAPIName, String userId, Class<? extends ILineMapper<L>> clazz, String guid) Get a Line (relationship)
protected <T> SubjectAreaOMASAPIResponse<T>	getResponseForException(Exception exception, AuditLog auditLog, String className, String restAPIName) Get the appropriate response from the supplied Exception
protected <L extends Line> SubjectAreaOMASAPIResponse<L>	restoreLine(String serverName, String restAPIName, String userId, Class<? extends ILineMapper<L>> clazz, String guid) Restore a Line (relationship).
protected <L extends Line> SubjectAreaOMASAPIResponse<L>	updateLine(String serverName, String restAPIName, String userId, String guid, Class<? extends ILineMapper<L>> clazz, L 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

instanceHandler

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

Constructor Detail

SubjectAreaRESTServicesInstance

public SubjectAreaRESTServicesInstance()

Default constructor

Method Detail

createLine

protected <L extends Line> SubjectAreaOMASAPIResponse<L> createLine(String serverName,
                                                                    String restAPIName,
                                                                    String userId,
                                                                    Class<? extends ILineMapper<L>> clazz,
                                                                    L line)

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

Type Parameters:

L - Line type of object for response

Parameters:

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

restAPIName - name of the rest API

userId - userId under which the request is performed

clazz - mapper Class

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 <L extends Line> SubjectAreaOMASAPIResponse<L> getLine(String serverName,
                                                                 String restAPIName,
                                                                 String userId,
                                                                 Class<? extends ILineMapper<L>> clazz,
                                                                 String guid)

Get a Line (relationship)

Type Parameters:

L - Line type of object for response

Parameters:

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

restAPIName - name of the rest API

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

clazz - mapper Class

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 <L extends Line> SubjectAreaOMASAPIResponse<L> updateLine(String serverName,
                                                                    String restAPIName,
                                                                    String userId,
                                                                    String guid,
                                                                    Class<? extends ILineMapper<L>> clazz,
                                                                    L line,
                                                                    boolean isReplace)

Update a relationship.

Type Parameters:

L - Line type of object for response

Parameters:

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

restAPIName - rest api name

userId - userId under which the request is performed

guid - unique identifier of the Line

clazz - mapper Class

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 <L extends Line> SubjectAreaOMASAPIResponse<L> deleteLine(String serverName,
                                                                 String restAPIName,
                                                                 String userId,
                                                                 Class<? extends ILineMapper<L>> clazz,
                                                                 String guid,
                                                                 Boolean isPurge)

Delete a Line (relationship)

Type Parameters:

L - Line type of object for response

Parameters:

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

restAPIName - rest API name

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

clazz - mapper Class

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.
• EntityNotPurgedException a hard delete was issued but the relationship was not purged

restoreLine

protected <L extends Line> SubjectAreaOMASAPIResponse<L> restoreLine(String serverName,
                                                                     String restAPIName,
                                                                     String userId,
                                                                     Class<? extends ILineMapper<L>> clazz,
                                                                     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.

Type Parameters:

L - Line type of object for response

Parameters:

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

restAPIName - name of the rest API

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

clazz - mapper Class

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.
• EntityNotPurgedException a hard delete was issued but the relationship was not purged

getFindRequest

protected FindRequest getFindRequest(String searchCriteria,
                                     Date asOfTime,
                                     Integer startingFrom,
                                     Integer pageSize,
                                     String sequencingOrderName,
                                     String sequencingProperty,
                                     Integer handlerMaxPageSize)

getResponseForException

protected <T> SubjectAreaOMASAPIResponse<T> getResponseForException(Exception exception,
                                                                    AuditLog auditLog,
                                                                    String className,
                                                                    String restAPIName)

Get the appropriate response from the supplied Exception

Parameters:

exception - - supplied exception

auditLog - - auditlog (may be null if unable to initialize)

className - - calling class's Name

restAPIName - - calling method's name

Returns:

response corresponding to the exception.