com.broadleafcommerce.rest.api.endpoint.promotionmessage

Class PromotionMessageEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.promotionmessage.PromotionMessageEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.MessageSourceAware

@FrameworkRestController
 @FrameworkMapping(value="/promotion-messages/",
                  produces={"application/json","application/xml"})
public class PromotionMessageEndpoint
extends BaseEndpoint

This class exposes catalog services as RESTful APIs. It is dependent on a JAX-RS implementation such as Jersey. This class must be extended, with appropriate JAX-RS annotations, such as:

javax.ws.rs.@Scope

javax.ws.rs.@Path

javax.ws.rs.@Produces

javax.ws.rs.@Consumes

javax.ws.rs.@Context

etc...

... in the subclass. The subclass must also be a Spring Bean. The subclass can then override the methods, and specify custom inputs and outputs. It will also specify javax.ws.rs.@Path annotations, javax.ws.rs.@Context, javax.ws.rs.@PathParam, javax.ws.rs.@QueryParam, javax.ws.rs.@GET, javax.ws.rs.@POST, etc... Essentially, the subclass will override and extend the methods of this class, add new methods, and control the JAX-RS behavior using annotations according to the JAX-RS specification.

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field and Description
protected PromotionMessageDTOWrapperService	promotionMessageDTOWrapperService

Fields inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

context, messageSource

Constructor Summary

Constructors

Constructor and Description
PromotionMessageEndpoint()

Method Summary

Modifier and Type	Method and Description
Map<String,List<PromotionMessageDTOWrapper>>	findPromotionMessagesForProduct(javax.servlet.http.HttpServletRequest request, Long productId)

Methods inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

getApplicationContext, getMessageSource, setApplicationContext, setMessageSource

Methods inherited from class java.lang.Object

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

Field Detail

promotionMessageDTOWrapperService

protected PromotionMessageDTOWrapperService promotionMessageDTOWrapperService

Constructor Detail

PromotionMessageEndpoint

public PromotionMessageEndpoint()

Method Detail

findPromotionMessagesForProduct

@FrameworkMapping(value="{productId}",
                  method=GET)
public Map<String,List<PromotionMessageDTOWrapper>> findPromotionMessagesForProduct(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                         @PathVariable(value="productId")
                                                                                                                                                         Long productId)