de.hybris.platform.webservices

Class AbstractYResponseBuilder<RESOURCE,REQUEST,RESPONSE>

java.lang.Object

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

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

Type Parameters:

RESOURCE - type of resource value which the response is generated for

All Implemented Interfaces:

YResponseBuilder

Direct Known Subclasses:

AbstractCommand, HttpDeleteResponseBuilder, HttpGetResponseBuilder, HttpPostResponseBuilder, HttpPutResponseBuilder

public abstract class AbstractYResponseBuilder<RESOURCE,REQUEST,RESPONSE>
extends AbstractResponseBuilder<RESOURCE,REQUEST,RESPONSE>

Abstract base implementation for YResponseBuilder

Field Summary

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

operation

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractYResponseBuilder(de.hybris.platform.webservices.AbstractResponseBuilder.Operation operation)
protected	AbstractYResponseBuilder(AbstractYResource resource, de.hybris.platform.webservices.AbstractResponseBuilder.Operation operation)

Method Summary

Modifier and Type	Method and Description
protected abstract RESPONSE	createResponseEntity(RESOURCE resourceEntity, REQUEST requestEntity)
protected <MODEL> MODEL	dtoToModel(java.lang.Object dto, MODEL model) Transforms a DTO into a model.
YObjectGraphContext	getDtoToModelContext()
DefaultNodeMapping	getLocalNodeConfig(java.lang.Class nodeType) Returns a DefaultNodeMapping instance which can be freely customized and is only valid for transformations within this resource.
DefaultNodeMapping	getLocalNodeConfig(java.lang.Class nodeType, int distance) Returns a DefaultNodeMapping instance which can be freely customized and is only valid for transformations within this resource.
YObjectGraphContext	getModelToDtoContext()
AbstractYResource	getResource()
<T2> T2	modelToDto(java.lang.Object source)
<T2> T2	modelToDto(java.lang.Object source, int depth)
<T2> T2	modelToDto(java.lang.Object source, java.lang.Object target)
<T2> T2	modelToDto(java.lang.Object source, java.lang.Object target, int depth) Transforms a model into a DTO.
void	setObjectGraph(YObjectGraphTransformer objectGraph)
void	setResource(AbstractResource resource)

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

build, build, getRequestValue, getResourceValue, 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

AbstractYResponseBuilder

protected AbstractYResponseBuilder(de.hybris.platform.webservices.AbstractResponseBuilder.Operation operation)

AbstractYResponseBuilder

protected AbstractYResponseBuilder(AbstractYResource resource,
                                   de.hybris.platform.webservices.AbstractResponseBuilder.Operation operation)

Method Detail

setResource

public void setResource(AbstractResource resource)

Overrides:

setResource in class AbstractResponseBuilder<RESOURCE,REQUEST,RESPONSE>

getResource

public AbstractYResource getResource()

Overrides:

getResource in class AbstractResponseBuilder<RESOURCE,REQUEST,RESPONSE>

setObjectGraph

public void setObjectGraph(YObjectGraphTransformer objectGraph)

createResponseEntity

protected abstract RESPONSE createResponseEntity(RESOURCE resourceEntity,
                                                 REQUEST requestEntity)
                                          throws java.lang.Exception

Specified by:

createResponseEntity in class AbstractResponseBuilder<RESOURCE,REQUEST,RESPONSE>

Throws:

java.lang.Exception

modelToDto

public <T2> T2 modelToDto(java.lang.Object source)

modelToDto

public <T2> T2 modelToDto(java.lang.Object source,
                          java.lang.Object target)

modelToDto

public <T2> T2 modelToDto(java.lang.Object source,
                          int depth)

modelToDto

public <T2> T2 modelToDto(java.lang.Object source,
                          java.lang.Object target,
                          int depth)

Transforms a model into a DTO.

Type Parameters:

T2 -

Parameters:

source -

target -

depth -

dtoToModel

protected <MODEL> MODEL dtoToModel(java.lang.Object dto,
                                   MODEL model)

Transforms a DTO into a model. Transforming includes any convert/create/merge operation which is needed.

e.g. if passed model is null, an appropriate one gets created, if passed model is not null, dto gets merged into that model.

Type Parameters:

MODEL - type of result model

Parameters:

dto - the DTO which has to be transformed into a model

model - the target model or 'null'

getDtoToModelContext

public YObjectGraphContext getDtoToModelContext()

getModelToDtoContext

public YObjectGraphContext getModelToDtoContext()

getLocalNodeConfig

public DefaultNodeMapping getLocalNodeConfig(java.lang.Class nodeType)

Returns a DefaultNodeMapping instance which can be freely customized and is only valid for transformations within this resource.

Parameters:

nodeType - type of node

getLocalNodeConfig

public DefaultNodeMapping getLocalNodeConfig(java.lang.Class nodeType,
                                             int distance)

Returns a DefaultNodeMapping instance which can be freely customized and is only valid for transformations within this resource.

Parameters:

nodeType - type of node

distance - distance which this node is positioned (same node types can be used in different distances and with different configurations)