com.sdl.odata.processor.write.util

Class WriteMethodUtil

java.lang.Object

com.sdl.odata.processor.write.util.WriteMethodUtil

public final class WriteMethodUtil
extends Object

Utilization class for providing useful methods for Write Method Handlers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RETURN_MINIMAL The key/value pair specifying that the return-minimal is preferred by the client.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

RETURN_MINIMAL

public static final String RETURN_MINIMAL

The key/value pair specifying that the return-minimal is preferred by the client.

See Also:

Constant Field Values

Method Detail

getTargetType

public static TargetType getTargetType(ODataRequest request,
                                       EntityDataModel entityDataModel,
                                       ODataUri oDataUri)
                                throws ODataTargetTypeException

Throws:

ODataTargetTypeException

getDataSource

public static DataSource getDataSource(ODataRequestContext requestContext,
                                       String entityType,
                                       DataSourceFactory dataSourceFactory)
                                throws ODataDataSourceException

Throws:

ODataDataSourceException

isMinimalReturnPreferred

public static boolean isMinimalReturnPreferred(ODataRequest request)

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

public static Map<String,String> getResponseHeaders(Object entity,
                                                    ODataUri oDataUri,
                                                    EntityDataModel entityDataModel)
                                             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

public static void validateKeys(Object entity,
                                EntityType type,
                                ODataUri oDataUri,
                                EntityDataModel entityDataModel)
                         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

public static void validateTargetType(Object entity,
                                      ODataRequest request,
                                      EntityDataModel entityDataModel,
                                      ODataUri oDataUri)
                               throws ODataProcessorException,
                                      ODataTargetTypeException

Validates the target type.

Parameters:

entity - an entity

Throws:

ODataProcessorException

ODataTargetTypeException

validateProperties

public static 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