de.hybris.platform.webservices

Class HttpPostResponseBuilder<RESOURCE,REQ_RESP>

java.lang.Object

de.hybris.platform.webservices.AbstractResponseBuilder<RESOURCE,REQUEST,RESPONSE>

de.hybris.platform.webservices.AbstractYResponseBuilder<RESOURCE,REQ_RESP,REQ_RESP>

de.hybris.platform.webservices.HttpPostResponseBuilder<RESOURCE,REQ_RESP>

Type Parameters:

RESOURCE - the type of the post resource (not that one of currently executed resource) which shall be exposed to client (model)

All Implemented Interfaces:

YResponseBuilder

Direct Known Subclasses:

PostCartEntryToCartEntries, PostCartToCarts

public class HttpPostResponseBuilder<RESOURCE,REQ_RESP>
extends AbstractYResponseBuilder<RESOURCE,REQ_RESP,REQ_RESP>

Field Summary

Fields inherited from class de.hybris.platform.webservices.AbstractResponseBuilder

operation

Constructor Summary

Constructors

Constructor and Description
HttpPostResponseBuilder()
HttpPostResponseBuilder(AbstractYResource resource)

Method Summary

Modifier and Type	Method and Description
void	afterProcessing(REQ_RESP reqEntity, RESOURCE respEntity, boolean wasNewlyCreated) Delegates to AbstractResource.afterPost(Object, Object, boolean)
void	beforeProcessing(REQ_RESP dto, RESOURCE resrcEntity) Delegates to AbstractResource.beforePost(Object, Object)
void	createOrUpdateResource(REQ_RESP reqEntity, RESOURCE respEntity, boolean mustBeCreated) Delegates to AbstractResource.createOrUpdatePostResource(Object, Object, boolean)
RESOURCE	createResource(REQ_RESP reqEntity) Delegates to AbstractResource.createPostResource(Object)
REQ_RESP	createResponseEntity(RESOURCE postResrcEntity, REQ_RESP reqEntity)
protected <T> T	getParentResourceValue()
RESOURCE	getResourceValue()
RESOURCE	readResource(REQ_RESP dto) Reads and returns the resource value which shall be modified/created by this POST request.

Methods inherited from class de.hybris.platform.webservices.AbstractYResponseBuilder

dtoToModel, getDtoToModelContext, getLocalNodeConfig, getLocalNodeConfig, getModelToDtoContext, getResource, modelToDto, modelToDto, modelToDto, modelToDto, setObjectGraph, setResource

Methods inherited from class de.hybris.platform.webservices.AbstractResponseBuilder

build, build, getRequestValue, getRespEntity, getResponse, getServiceLocator, processException, processRequest, processRequest, setRequestValue

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpPostResponseBuilder

public HttpPostResponseBuilder()

HttpPostResponseBuilder

public HttpPostResponseBuilder(AbstractYResource resource)

Method Detail

getResourceValue

public RESOURCE getResourceValue()

Overrides:

getResourceValue in class AbstractResponseBuilder<RESOURCE,REQ_RESP,REQ_RESP>

createResponseEntity

public final REQ_RESP createResponseEntity(RESOURCE postResrcEntity,
                                           REQ_RESP reqEntity)
                                    throws java.lang.Exception

Specified by:

createResponseEntity in class AbstractYResponseBuilder<RESOURCE,REQ_RESP,REQ_RESP>

Throws:

java.lang.Exception

readResource

public RESOURCE readResource(REQ_RESP dto)
                      throws java.lang.Exception

Reads and returns the resource value which shall be modified/created by this POST request. Generally that value is not identical to that value returned by current addressed resource. POST generally is used for values which are only related in some kind to the addressed resource. (e.g. POST a Address to a /addresses)

This implementation just delegates to AbstractResource.readPostResource(Object)

Throws:

java.lang.Exception

beforeProcessing

public void beforeProcessing(REQ_RESP dto,
                             RESOURCE resrcEntity)

Delegates to AbstractResource.beforePost(Object, Object)

Parameters:

resrcEntity -

dto -

createResource

public RESOURCE createResource(REQ_RESP reqEntity)
                        throws java.lang.Exception

Delegates to AbstractResource.createPostResource(Object)

Parameters:

reqEntity -

Returns:

Throws:

java.lang.Exception

createOrUpdateResource

public void createOrUpdateResource(REQ_RESP reqEntity,
                                   RESOURCE respEntity,
                                   boolean mustBeCreated)
                            throws java.lang.Exception

Delegates to AbstractResource.createOrUpdatePostResource(Object, Object, boolean)

Parameters:

reqEntity - request entity (dto)

respEntity - response entity (model)

mustBeCreated - whether response entity must be newly created (false when only an updated is needed)

Throws:

java.lang.Exception

afterProcessing

public void afterProcessing(REQ_RESP reqEntity,
                            RESOURCE respEntity,
                            boolean wasNewlyCreated)

Delegates to AbstractResource.afterPost(Object, Object, boolean)

Parameters:

reqEntity - request entity (dto)

respEntity - response entity (model)

wasNewlyCreated - true when response entity was newly created (otherwise updated only)

getParentResourceValue

protected <T> T getParentResourceValue()