com.sdl.odata.processor.write

Class WriteMethodHandler

java.lang.Object

com.sdl.odata.processor.write.WriteMethodHandler

Direct Known Subclasses:

ActionPostMethodHandler, DeleteMethodHandler, PatchMethodHandler, PostMethodHandler, PutMethodHandler

public abstract class WriteMethodHandler
extends Object

This is abstract method handler for write operation which is PUT, POST, PATCH and DELETE.

Constructor Summary

Constructors

Constructor and Description
WriteMethodHandler(ODataRequestContext requestContext, DataSourceFactory dataSourceFactory)

Method Summary

Modifier and Type	Method and Description
protected DataSource	getDataSource(String entityType)
DataSourceFactory	getDataSourceFactory()
EntityDataModel	getEntityDataModel()
ODataRequestContext	getODataRequestContext()
ODataUri	getoDataUri()
ODataRequest	getRequest()
protected Map<String,String>	getResponseHeaders(Object entity) Get the response headers when the response is to include an entity in its body.
protected TargetType	getTargetType()
abstract ProcessorResult	handleWrite(Object entity)
protected boolean	isMinimalReturnPreferred() Check whether the return-minimal is preferred by the HTTP client by inspecting the 'HTTP-Prefer' header.
protected void	validateKeys(Object entity, EntityType type) Performs the validation of keys.
protected void	validateProperties(Object entity, EntityDataModel edm) Checks if all non-nullable properties of an entity are non-empty.
protected void	validateTargetType(Object entity) Validates the target type.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteMethodHandler

public WriteMethodHandler(ODataRequestContext requestContext,
                          DataSourceFactory dataSourceFactory)

Method Detail

handleWrite

public abstract ProcessorResult handleWrite(Object entity)
                                     throws ODataException

Throws:

ODataException

getTargetType

protected TargetType getTargetType()
                            throws ODataTargetTypeException

Throws:

ODataTargetTypeException

getDataSource

protected DataSource getDataSource(String entityType)
                            throws ODataDataSourceException

Throws:

ODataDataSourceException

isMinimalReturnPreferred

protected boolean isMinimalReturnPreferred()

Check whether the return-minimal is preferred by the HTTP client by inspecting the 'HTTP-Prefer' header.

Returns:

true if the return-minimal is preferred.

getResponseHeaders

protected Map<String,String> getResponseHeaders(Object entity)
                                         throws ODataEdmException

Get the response headers when the response is to include an entity in its body.

Parameters:

entity - The entity that will be included in the body of the response.

Returns:

The response headers.

Throws:

ODataEdmException - In case it is not possible to build the headers.

validateKeys

protected void validateKeys(Object entity,
                            EntityType type)
                     throws ODataClientException,
                            ODataProcessorException

Performs the validation of keys. The key(s) in the 'OData URI' should match the existing key(s) in the passed entity.

Parameters:

entity - The passed entity.

type - The entity type of the passed entity.

Throws:

ODataClientException

ODataProcessorException

validateTargetType

protected void validateTargetType(Object entity)
                           throws ODataProcessorException,
                                  ODataTargetTypeException

Validates the target type.

Parameters:

entity - an entity

Throws:

ODataProcessorException

ODataTargetTypeException

validateProperties

protected void validateProperties(Object entity,
                                  EntityDataModel edm)
                           throws ODataException

Checks if all non-nullable properties of an entity are non-empty.

Parameters:

entity - The entity to check.

Throws:

ODataBadRequestException - If any of the non-nullable properties of the entity are empty.

ODataException

getRequest

public ODataRequest getRequest()

getEntityDataModel

public EntityDataModel getEntityDataModel()

getODataRequestContext

public ODataRequestContext getODataRequestContext()

getoDataUri

public ODataUri getoDataUri()

getDataSourceFactory

public DataSourceFactory getDataSourceFactory()