de.hybris.platform.webservices

Class AbstractResource<RESOURCE>

java.lang.Object

de.hybris.platform.webservices.AbstractResource<RESOURCE>

All Implemented Interfaces:

CrudActionNotifable<RESOURCE>, RestResource<RESOURCE>

Direct Known Subclasses:

AbstractYResource, ChangePasswordResource, LoginResource, MediaContentResource, PriceResource, RetrievePasswordResource

public abstract class AbstractResource<RESOURCE>
extends java.lang.Object
implements RestResource<RESOURCE>, CrudActionNotifable<RESOURCE>

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpHeaders	httpHeaders The HTTP header information.
protected Providers	providers
protected Request	request
protected ResourceContext	resourceCtx The resource context is used for obtaining a new instance of a sub- resource.
protected SecurityContext	securityCtx The SecurityContext.
protected ServiceLocator	serviceLocator serviceLocator: a locator for available services
protected UriInfo	uriInfo The URI request context.

Constructor Summary

Constructors

Constructor and Description
AbstractResource()

Method Summary

Modifier and Type	Method and Description
protected void	afterDelete(RESOURCE deadEntity)
protected void	afterPost(java.lang.Object reqEntity, java.lang.Object resrcEntity, boolean isNewlyCreated) HTTP-POST-listener which gets invoked after POST processing is finished.
protected void	afterPut(java.lang.Object reqEntity, RESOURCE resrcEntity, boolean isNewlyCreated)
protected void	beforeDelete(RESOURCE respEntity)
protected void	beforePost(java.lang.Object reqEntity, java.lang.Object resrcEntity) HTTP-POST-listener which gets invoked before POST processing starts.
protected void	beforePut(java.lang.Object reqEntity, RESOURCE resrcEntity)
protected YResponseBuilder	createDeleteResponse() Creates and returns a default YResponseBuilder for a HTTP DELETE.
protected YResponseBuilder	createGetResponse() Creates and returns a default YResponseBuilder for a HTTP GET.
protected void	createOrUpdatePostResource(java.lang.Object reqEntity, java.lang.Object resrcEntity, boolean mustBeCreated) HTTP-POST-hook method for updating (create/update) the POST resource value Invoked by HttpPostResponseBuilder.createOrUpdateResource(Object, Object, boolean).
protected void	createOrUpdateResource(java.lang.Object reqEntity, RESOURCE resrcEntity, boolean mustBeCreated)
protected <T> T	createPostResource(java.lang.Object reqEntity) HTTP-POST-hook method for creating the POST resource value.
protected YResponseBuilder	createPostResponse(java.lang.Object dto) Creates and returns a default YResponseBuilder for a HTTP POST.
protected YResponseBuilder	createPutResponse(java.lang.Object dto)
protected YResponseBuilder	createPutResponse(java.lang.Object dto, boolean strict) Generic PUT.
protected RESOURCE	createResource(java.lang.Object reqEntity)
protected void	deleteResource(RESOURCE respEntity)
protected EventActionFactory	getEventActionFactory()
PagingStrategy	getPagingStrategy()
AbstractResource	getParentResource() Returns the RestResource which was executed as parent of current resource.
CommandHandler	getPostCommandHandler()
CommandHandler	getPutCommandHandler()
Request	getRequest()
java.lang.String	getResourceId()
RESOURCE	getResourceValue()
protected ResponseBuilder	getResponse()
SecurityContext	getSecurityContext()
SecurityStrategy	getSecurityStrategy()
ServiceLocator	getServiceLocator() Returns a ServiceLocator for all available services.
UriInfo	getUriInfo() Returns the UriInfo for current http-request.
protected boolean	isAccessGranted() Security check for requested resource.
boolean	isAccessGrantedExternal()
void	notifyAfterDelete() Deprecated. since ages - ConfigureNotificationRequestProcessor instead.
void	notifyAfterGet() Deprecated. since ages - ConfigureNotificationRequestProcessor instead.
void	notifyAfterPost() Deprecated. since ages - ConfigureNotificationRequestProcessorinstead.
void	notifyAfterPut() Deprecated. since ages - ConfigureNotificationRequestProcessor instead.
void	notifyBeforeDelete() Deprecated. since ages - ConfigureNotificationRequestProcessor instead.
void	notifyBeforeGet() Deprecated. since ages - ConfigureNotificationRequestProcessor instead.
void	notifyBeforePost() Deprecated. since ages - ConfigureNotificationRequestProcessor instead.
void	notifyBeforePut() Deprecated. since ages - ConfigureNotificationRequestProcessor instead.
protected boolean	processDtoId(java.lang.Object dto, java.lang.String expPropValueLiteral, boolean strict) Internal helper method.
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.
protected <T> T	readPostResource(java.lang.Object reqEntity) HTTP-POST-hook method for reading the POST resource value.
protected abstract RESOURCE	readResource(java.lang.String resourceId)
void	setCachingStrategy(AbstractCachingStrategy<RESOURCE> cachingStrategy) Deprecated. since 4.2.2, configure RequestProcessor instead
void	setDeleteMethod(java.lang.String className)
void	setEventActionFactory(EventActionFactory eventActionFactory)
void	setGetMethod(java.lang.String className)
void	setPagingStrategy(PagingStrategy pagingStrategy)
void	setParentResource(AbstractResource parentResource)
void	setPostCommandHandler(CommandHandler postCommandHandler)
void	setPostMethod(java.lang.String className)
void	setPutCommandHandler(CommandHandler putCommandHandler)
void	setPutMethod(java.lang.String className)
void	setRequestProcessChain(ConfigurableRequestProcessChain<RESOURCE> requestProcessChain)
void	setResourceId(java.lang.String resourceId) Sets the ID for this resource.
void	setResourceValue(RESOURCE resourceValue) Sets the value/entity for this resource.
void	setSecurityStrategy(SecurityStrategy securityStrategy)
void	setServiceLocator(ServiceLocator serviceLocator)

Methods inherited from class java.lang.Object

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

Field Detail

resourceCtx

protected ResourceContext resourceCtx

The resource context is used for obtaining a new instance of a sub- resource.

securityCtx

protected SecurityContext securityCtx

The SecurityContext.

uriInfo

protected UriInfo uriInfo

The URI request context.

httpHeaders

protected HttpHeaders httpHeaders

The HTTP header information.

providers

protected Providers providers

request

protected Request request

serviceLocator

protected ServiceLocator serviceLocator

serviceLocator: a locator for available services

Constructor Detail

AbstractResource

public AbstractResource()

Method Detail

getSecurityContext

public SecurityContext getSecurityContext()

Specified by:

getSecurityContext in interface RestResource<RESOURCE>

getRequest

public Request getRequest()

Specified by:

getRequest in interface RestResource<RESOURCE>

getParentResource

public AbstractResource getParentResource()

Returns the RestResource which was executed as parent of current resource.

Returns:

setParentResource

public void setParentResource(AbstractResource parentResource)

Parameters:

parentResource - the parentResource to set

setPostCommandHandler

public void setPostCommandHandler(CommandHandler postCommandHandler)

Parameters:

postCommandHandler - the postCommandHandler to set

getPostCommandHandler

public CommandHandler getPostCommandHandler()

Returns:

the postCommandHandler

setPutCommandHandler

public void setPutCommandHandler(CommandHandler putCommandHandler)

Parameters:

putCommandHandler - the putCommandHandler to set

getPutCommandHandler

public CommandHandler getPutCommandHandler()

Specified by:

getPutCommandHandler in interface RestResource<RESOURCE>

setCachingStrategy

@Deprecated
public void setCachingStrategy(AbstractCachingStrategy<RESOURCE> cachingStrategy)

Deprecated. since 4.2.2, configure RequestProcessor instead

getSecurityStrategy

public SecurityStrategy getSecurityStrategy()

setSecurityStrategy

public void setSecurityStrategy(SecurityStrategy securityStrategy)

setPagingStrategy

public void setPagingStrategy(PagingStrategy pagingStrategy)

Parameters:

pagingStrategy - the pagingStrategy to set

getPagingStrategy

public PagingStrategy getPagingStrategy()

Returns:

the pagingStrategy

setResourceId

public void setResourceId(java.lang.String resourceId)

Sets the ID for this resource.

Parameters:

resourceId - the resourceId to set

getResourceId

public java.lang.String getResourceId()

getServiceLocator

public ServiceLocator getServiceLocator()

Description copied from interface: RestResource

Returns a ServiceLocator for all available services.

Specified by:

getServiceLocator in interface RestResource<RESOURCE>

Returns:

ServiceLocator

setServiceLocator

public void setServiceLocator(ServiceLocator serviceLocator)

setEventActionFactory

public void setEventActionFactory(EventActionFactory eventActionFactory)

getEventActionFactory

protected EventActionFactory getEventActionFactory()

getResponse

protected ResponseBuilder getResponse()

isAccessGranted

protected boolean isAccessGranted()

Security check for requested resource.

Returns:

the response

isAccessGrantedExternal

public boolean isAccessGrantedExternal()

setGetMethod

public void setGetMethod(java.lang.String className)
                  throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

setPutMethod

public void setPutMethod(java.lang.String className)
                  throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

setPostMethod

public void setPostMethod(java.lang.String className)
                   throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

setDeleteMethod

public void setDeleteMethod(java.lang.String className)
                     throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

createGetResponse

protected final YResponseBuilder createGetResponse()

Creates and returns a default YResponseBuilder for a HTTP GET. In addition, method checks whether the requested user can perform the HTTP GET operation.

Returns:

YResponseBuilder

createDeleteResponse

protected YResponseBuilder createDeleteResponse()

Creates and returns a default YResponseBuilder for a HTTP DELETE. In addition, method checks whether the requested user can perform the HTTP DELETE operation.

Returns:

YResponseBuilder

createPostResponse

protected YResponseBuilder createPostResponse(java.lang.Object dto)

Creates and returns a default YResponseBuilder for a HTTP POST. In addition, method checks whether the requested user can perform the HTTP POST operation.

Returns:

YResponseBuilder

createPutResponse

protected YResponseBuilder createPutResponse(java.lang.Object dto)

createPutResponse

protected YResponseBuilder createPutResponse(java.lang.Object dto,
                                             boolean strict)

Generic PUT.

Merges passed DTO into value of this resource and sets that value as response entity. Id property parameter indicates the name of the property whose value must correspond with this resource id. If value of id-property is null, resource id gets injected. If value is not null and doesn't equals resource-id value than, depending on whether strict is enabled, a BAD_REQUEST is returned. In addition, method checks whether the requested user can perform the HTTP PUT operation.

Parameters:

dto -

strict -

Returns:

Response

getUriInfo

public UriInfo getUriInfo()

Description copied from interface: RestResource

Returns the UriInfo for current http-request.

Specified by:

getUriInfo in interface RestResource<RESOURCE>

Returns:

UriInfo

processDtoId

protected boolean processDtoId(java.lang.Object dto,
                               java.lang.String expPropValueLiteral,
                               boolean strict)

Internal helper method.

Compares resource id with value of passed dto property for equality. If property value is null, dto property gets set resource id. If property value is not null then, based on 'strict' parameter an error response is created.

Parameters:

dto - dto to validate

Returns:

true when DTO is valid for this resource

setResourceValue

public void setResourceValue(RESOURCE resourceValue)

Sets the value/entity for this resource.

This is the value, which gets applied current CRUD operation.

Parameters:

resourceValue -

getResourceValue

public RESOURCE getResourceValue()

Specified by:

getResourceValue in interface RestResource<RESOURCE>

readResource

protected abstract RESOURCE readResource(java.lang.String resourceId)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

beforeDelete

protected void beforeDelete(RESOURCE respEntity)

deleteResource

protected void deleteResource(RESOURCE respEntity)

afterDelete

protected void afterDelete(RESOURCE deadEntity)

beforePut

protected void beforePut(java.lang.Object reqEntity,
                         RESOURCE resrcEntity)

createResource

protected RESOURCE createResource(java.lang.Object reqEntity)

createOrUpdateResource

protected void createOrUpdateResource(java.lang.Object reqEntity,
                                      RESOURCE resrcEntity,
                                      boolean mustBeCreated)
                               throws java.lang.Exception

Throws:

java.lang.Exception

afterPut

protected void afterPut(java.lang.Object reqEntity,
                        RESOURCE resrcEntity,
                        boolean isNewlyCreated)

readPostResource

protected <T> T readPostResource(java.lang.Object reqEntity)

HTTP-POST-hook method for reading the POST resource value.

Gets invoked by of HttpPostResponseBuilder.readResource(Object).

Type Parameters:

T - type of response entity

Parameters:

reqEntity - the passed request entity

Returns:

response entity

beforePost

protected void beforePost(java.lang.Object reqEntity,
                          java.lang.Object resrcEntity)

HTTP-POST-listener which gets invoked before POST processing starts.

Invoked by HttpPostResponseBuilder.beforeProcessing(Object, Object)

Parameters:

reqEntity - request entity (dto)

resrcEntity - response entity (model)

createPostResource

protected <T> T createPostResource(java.lang.Object reqEntity)

HTTP-POST-hook method for creating the POST resource value.

Invoked by HttpPostResponseBuilder.createResource(Object). Method gets called before request entity is merged into response entity.

Type Parameters:

T - type of response entity

Parameters:

reqEntity - request entity (dto)

Returns:

created response entity (model)

createOrUpdatePostResource

protected void createOrUpdatePostResource(java.lang.Object reqEntity,
                                          java.lang.Object resrcEntity,
                                          boolean mustBeCreated)
                                   throws java.lang.Exception

HTTP-POST-hook method for updating (create/update) the POST resource value

Invoked by HttpPostResponseBuilder.createOrUpdateResource(Object, Object, boolean). Method gets called after request entity is merged into response entity.

Parameters:

reqEntity - request entity (dto)

resrcEntity - resource entity (model)

mustBeCreated - true when response entity must be newly created (updated only otherwise)

Throws:

java.lang.Exception - is allowed to throw any kind of exception

afterPost

protected void afterPost(java.lang.Object reqEntity,
                         java.lang.Object resrcEntity,
                         boolean isNewlyCreated)

HTTP-POST-listener which gets invoked after POST processing is finished.

Parameters:

reqEntity - request entity (dto)

resrcEntity - resource entity (model)

isNewlyCreated - true when response entity was newly created (false when only updated)

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

notifyAfterGet

@Deprecated
public void notifyAfterGet()

Deprecated. since ages - ConfigureNotificationRequestProcessor instead.

Specified by:

notifyAfterGet in interface CrudActionNotifable<RESOURCE>

notifyAfterPut

@Deprecated
public void notifyAfterPut()

Deprecated. since ages - ConfigureNotificationRequestProcessor instead.

Specified by:

notifyAfterPut in interface CrudActionNotifable<RESOURCE>

notifyAfterPost

@Deprecated
public void notifyAfterPost()

Deprecated. since ages - ConfigureNotificationRequestProcessorinstead.

Specified by:

notifyAfterPost in interface CrudActionNotifable<RESOURCE>

notifyAfterDelete

@Deprecated
public void notifyAfterDelete()

Deprecated. since ages - ConfigureNotificationRequestProcessor instead.

Specified by:

notifyAfterDelete in interface CrudActionNotifable<RESOURCE>

notifyBeforeGet

@Deprecated
public void notifyBeforeGet()

Deprecated. since ages - ConfigureNotificationRequestProcessor instead.

Specified by:

notifyBeforeGet in interface CrudActionNotifable<RESOURCE>

notifyBeforeDelete

@Deprecated
public void notifyBeforeDelete()

Deprecated. since ages - ConfigureNotificationRequestProcessor instead.

Specified by:

notifyBeforeDelete in interface CrudActionNotifable<RESOURCE>

notifyBeforePost

@Deprecated
public void notifyBeforePost()

Deprecated. since ages - ConfigureNotificationRequestProcessor instead.

Specified by:

notifyBeforePost in interface CrudActionNotifable<RESOURCE>

notifyBeforePut

@Deprecated
public void notifyBeforePut()

Deprecated. since ages - ConfigureNotificationRequestProcessor instead.

Specified by:

notifyBeforePut in interface CrudActionNotifable<RESOURCE>

setRequestProcessChain

public void setRequestProcessChain(ConfigurableRequestProcessChain<RESOURCE> requestProcessChain)