de.hybris.platform.webservices

Class AbstractResponseBuilder<RESOURCE,REQUEST,RESPONSE>

java.lang.Object

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

All Implemented Interfaces:

YResponseBuilder

Direct Known Subclasses:

AbstractYResponseBuilder

public abstract class AbstractResponseBuilder<RESOURCE,REQUEST,RESPONSE>
extends java.lang.Object
implements YResponseBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected de.hybris.platform.webservices.AbstractResponseBuilder.Operation	operation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Response	build() Delegates to ResponseBuilder#build() but sets appropriate response entity first.
Response	build(java.lang.Class<?> wrapperType) Same as YResponseBuilder.build() but wraps response entity into an instance of passed class first.
protected abstract RESPONSE	createResponseEntity(RESOURCE resourceEntity, REQUEST requestEntity)
REQUEST	getRequestValue()
AbstractResource	getResource()
RESOURCE	getResourceValue()
RESPONSE	getRespEntity()
ResponseBuilder	getResponse() Returns the wrapped ResponseBuilder which is taken for building a Response
ServiceLocator	getServiceLocator()
protected void	processException(java.lang.String msg, java.lang.Exception exception) Throws a WebApplicationException which interrupts any current processing and gives full control to jersey.
void	processRequest()
void	processRequest(boolean suppressNotFound)
void	setRequestValue(REQUEST requestEntity)
void	setResource(AbstractResource resource)

Methods inherited from class java.lang.Object

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

Field Detail

operation

protected de.hybris.platform.webservices.AbstractResponseBuilder.Operation operation

Constructor Detail

AbstractResponseBuilder

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

AbstractResponseBuilder

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

Method Detail

getResource

public AbstractResource getResource()

setResource

public void setResource(AbstractResource resource)

getServiceLocator

public ServiceLocator getServiceLocator()

getResourceValue

public RESOURCE getResourceValue()

setRequestValue

public void setRequestValue(REQUEST requestEntity)

getRequestValue

public REQUEST getRequestValue()

processRequest

public void processRequest()

processRequest

public void processRequest(boolean suppressNotFound)

createResponseEntity

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

Throws:

java.lang.Exception

getResponse

public ResponseBuilder getResponse()

Returns the wrapped ResponseBuilder which is taken for building a Response

Returns:

ResponseBuilder

processException

protected void processException(java.lang.String msg,
                                java.lang.Exception exception)
                         throws WebApplicationException

Throws a WebApplicationException which interrupts any current processing and gives full control to jersey. But before passed Exception gets evaluated and used to produce nice client output and notify loggers.

Parameters:

msg - a message which shall be given to client as headline

exception - the exception which is taken to produce a short client error message

Throws:

WebApplicationException

build

public Response build()

Description copied from interface: YResponseBuilder

Delegates to ResponseBuilder#build() but sets appropriate response entity first.

Specified by:

build in interface YResponseBuilder

Returns:

Response

build

public Response build(java.lang.Class<?> wrapperType)

Description copied from interface: YResponseBuilder

Same as YResponseBuilder.build() but wraps response entity into an instance of passed class first. Passed class is constructed by taking the first appropriate COnstructor whose parameter type is assignable to entity type.

Specified by:

build in interface YResponseBuilder

Parameters:

wrapperType - type of wrapper class

Returns:

Response

getRespEntity

public RESPONSE getRespEntity()