Package 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 Details

  • Constructor Details

    • PromotionMessageEndpoint

      public PromotionMessageEndpoint()

  • Method Details

    • findPromotionMessagesForProduct

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