com.ibm.commerce.foundation.rest.providers

Class AtomEntityProvider

  • java.lang.Object
    • com.ibm.commerce.foundation.rest.providers.AbstractEntityProvider
      • com.ibm.commerce.foundation.rest.providers.AtomEntityProvider
  • All Implemented Interfaces:
    javax.ws.rs.ext.MessageBodyWriter<java.util.Map>


    @Provider
     @Produces(value="application/atom+xml")
    public class AtomEntityProvider
    extends com.ibm.commerce.foundation.rest.providers.AbstractEntityProvider
    This class formats a provided list of DataAreaTpe Business Object Document Service Data Objects into an Atom Feed with the help of a JSP.
    See Also:
    AbstractEntityProvider
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void writeTo(java.util.Map dataMap, java.lang.Class<?> dataObjectClass, java.lang.reflect.Type dataObjectType, java.lang.annotation.Annotation[] resourceAnnotations, javax.ws.rs.core.MediaType responseMediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object> responseHttpHeaders, java.io.OutputStream responseOutputStream)
      This method uses the helper method AbstractEntityProvider.formatResponseUsingJsp(Map) to format the response using a JSP.
      • Methods inherited from class com.ibm.commerce.foundation.rest.providers.AbstractEntityProvider

        getSize, isWriteable
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AtomEntityProvider

        public AtomEntityProvider()
    • Method Detail

      • writeTo

        public void writeTo(java.util.Map dataMap,
                            java.lang.Class<?> dataObjectClass,
                            java.lang.reflect.Type dataObjectType,
                            java.lang.annotation.Annotation[] resourceAnnotations,
                            javax.ws.rs.core.MediaType responseMediaType,
                            javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object> responseHttpHeaders,
                            java.io.OutputStream responseOutputStream)
                     throws java.io.IOException,
                            javax.ws.rs.WebApplicationException
        This method uses the helper method AbstractEntityProvider.formatResponseUsingJsp(Map) to format the response using a JSP. It gets the byte array returned by formatResponseUsingJsp and passes it to AtomFeed to marshal the response.
        Throws:
        java.io.IOException
        javax.ws.rs.WebApplicationException
        See Also:
        MessageBodyWriter.writeTo(Object, Class, Type, Annotation[], javax.ws.rs.core.MediaType, MultivaluedMap, OutputStream)