Source code: com/aendvari/hermes/broker/http/HttpMessageBrokerContext.java

   /*
    * HttpMessageBrokerContext.java
    *
    * Copyright (c) 2001, 2002 Aendvari, Ltd. All Rights Reserved.
    *
    * See the file LICENSE for terms of use.
    *
    */
   
  package com.aendvari.hermes.broker.http;
  
  import javax.servlet.*;
  import javax.servlet.http.*;
  
  import com.aendvari.hermes.broker.MessageBrokerContext;
  
  import com.aendvari.common.properties.Properties;
  
  /**
   * <p>Extends {@link MessageBrokerContext} to include HTTP/Servlet specific information.</p>
   *
   * <p>This class also provides an interface for accessing HTTP/Servlet information from
   * a {@link MessageBrokerContext MessageBrokerContext's} properties.</p>
   *
   * @author  Trevor Milne
   *
   */
  
  public class HttpMessageBrokerContext extends MessageBrokerContext
  {
    /* Constants. */
  
  
    /** Various property constants. */
    public interface Property
    {
      /** The <code>HttpServletRequest</code> property. */
      public static String Request    = "servlet/request";
  
      /** The <code>HttpServletResponse</code> property. */
      public static String Response    = "servlet/response";
  
      /** The <code>HttpSession</code> property. */
      public static String Session    = "servlet/session";
  
      /** The <code>ServletConfig</code> property. */
      public static String ServletConfig  = "servlet/config";
    }
  
  
    /* Constructors. */
  
  
    /**
     * Constructs a <code>HttpMessageBrokerContext</code>.
     *
     */
  
    public HttpMessageBrokerContext()
    {
      super();
    }
  
  
    /* Accessors. */
  
  
    /* Request. */
  
    /**
     * Sets the request of this context.
     *
     * @param    setRequest          The <code>HttpServletRequest</code> for this context.
     *
     */
  
    public void setRequest(HttpServletRequest setRequest)
    {
      getProperties().setObject(Property.Request, setRequest);
      getProperties().setObject(Property.Session, setRequest.getSession());
    }
  
    /**
     * Returns the request of this context.
     *
     * @return                  The <code>HttpServletRequest</code> for this context.
     *
     */
  
    public HttpServletRequest getRequest()
    {
      return (HttpServletRequest)getProperties().getObject(Property.Request);
    }
  
    /**
     * Returns the request of the supplied context.
     *
     * @param    context            The {@link MessageBrokerContext} to read from.
     *
    * @return                  The <code>HttpServletRequest</code> for the context.
    *
    */
 
   public static HttpServletRequest getRequest(MessageBrokerContext context)
   {
     return (HttpServletRequest)context.getProperties().getObject(Property.Request);
   }
 
   /* Response. */
 
   /**
    * Sets the response of this context.
    *
    * @param    setResponse          The <code>HttpServletRespose</code> for this context.
    *
    */
 
   public void setResponse(HttpServletResponse setResponse)
   {
     getProperties().setObject(Property.Response, setResponse);
   }
 
   /**
    * Returns the response of this context.
    *
    * @return                  The <code>HttpServletResponse</code> for this context.
    *
    */
 
   public HttpServletResponse getResponse()
   {
     return (HttpServletResponse)getProperties().getObject(Property.Response);
   }
 
   /**
    * Returns the response of the supplied context.
    *
    * @param    context            The {@link MessageBrokerContext} to read from.
    *
    * @return                  The <code>HttpServletResponse</code> for the context.
    *
    */
 
   public static HttpServletResponse getResponse(MessageBrokerContext context)
   {
     return (HttpServletResponse)context.getProperties().getObject(Property.Response);
   }
 
   /* Session. */
 
   /**
    * Sets the session of this context.
    *
    * @param    setSession          The <code>HttpSession</code> for this context.
    *
    */
 
   public void setSession(HttpSession setSession)
   {
     getProperties().setObject(Property.Session, setSession);
   }
 
   /**
    * Sets the session of this context. The session is obtained from the supplied request.
    *
    * @param    setRequest          The <code>HttpServletRequest</code> containing the session.
    *
    */
 
   public void setSession(HttpServletRequest setRequest)
   {
     getProperties().setObject(Property.Session, setRequest.getSession());
   }
 
   /**
    * Returns the session of this context.
    *
    * @return                  The <code>HttpSession</code> for this context.
    *
    */
 
   public HttpSession getSession()
   {
     return (HttpSession)getProperties().getObject(Property.Session);
   }
 
   /**
    * Returns the session of the supplied context.
    *
    * @param    context            The {@link MessageBrokerContext} to read from.
    *
    * @return                  The <code>HttpSession</code> for the context.
    *
    */
 
   public static HttpSession getSession(MessageBrokerContext context)
   {
     return (HttpSession)context.getProperties().getObject(Property.Session);
   }
 
   /* Servlet config. */
 
   /**
    * Sets the servlet configuration of this context.
    *
    * @param    setServletConfig      The <code>ServletConfig</code> for this context.
    *
    */
 
   public void setServletConfig(ServletConfig setServletConfig)
   {
     getProperties().setObject(Property.ServletConfig, setServletConfig);
   }
 
   /**
    * Returns the servlet configuration of this context.
    *
    * @return                  The <code>ServletConfig</code> for this context.
    *
    */
 
   public ServletConfig getServletConfig()
   {
     return (ServletConfig)getProperties().getObject(Property.ServletConfig);
   }
 
   /**
    * Returns the servlet configuration of the supplied context.
    *
    * @param    context            The {@link MessageBrokerContext} to read from.
    *
    * @return                  The <code>ServletConfig</code> for the context.
    *
    */
 
   public static ServletConfig getServletConfig(MessageBrokerContext context)
   {
     return (ServletConfig)context.getProperties().getObject(Property.ServletConfig);
   }
 }