org.directwebremoting.dwrp
Class Batch

java.lang.Object
  extended by org.directwebremoting.dwrp.Batch
Direct Known Subclasses:
CallBatch, PollBatch

public class Batch
extends java.lang.Object

A Batch is a request from the client. This can be either a from a call (CallBatch) or an active reverse ajax poll (PollBatch)

Author:
Joe Walker [joe at getahead dot ltd dot uk]

Constructor Summary
Batch(javax.servlet.http.HttpServletRequest request)
          Initialize the batch from an HttpServletRequest
Batch(java.util.Map<java.lang.String,FormField> allParameters, boolean get)
          Initialize the batch from a set of pre-parsed parameters
 
Method Summary
 java.lang.String getBatchId()
           
 java.lang.String getDocumentDomain()
           
 java.lang.String getDwrSessionId()
           
 java.util.Map<java.lang.String,FormField> getExtraParameters()
           
 java.lang.String getInstanceId()
           
 java.lang.Long getNextReverseAjaxIndex()
           
 java.lang.String getPage()
           
 java.lang.String getScriptSessionId()
           
 boolean isGet()
          Is this request from a GET?
static boolean isMultipartContent(javax.servlet.http.HttpServletRequest request)
          Utility method that determines whether the request contains multipart content.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Batch

public Batch(javax.servlet.http.HttpServletRequest request)
      throws ServerException
Initialize the batch from an HttpServletRequest

Throws:
ServerException

Batch

public Batch(java.util.Map<java.lang.String,FormField> allParameters,
             boolean get)
Initialize the batch from a set of pre-parsed parameters

Method Detail

isMultipartContent

public static boolean isMultipartContent(javax.servlet.http.HttpServletRequest request)
Utility method that determines whether the request contains multipart content.

Parameters:
request - The servlet request to be evaluated. Must be non-null.
Returns:
true if the request is multipart, false otherwise.

getBatchId

public java.lang.String getBatchId()
Returns:
the batchId

getInstanceId

public java.lang.String getInstanceId()
Returns:
the instanceId

getNextReverseAjaxIndex

public java.lang.Long getNextReverseAjaxIndex()
Returns:
the nextReverseAjaxIndex

isGet

public boolean isGet()
Is this request from a GET?

Returns:
true if the request is a GET request

getScriptSessionId

public java.lang.String getScriptSessionId()
Returns:
the scriptSessionId

getDwrSessionId

public java.lang.String getDwrSessionId()
Returns:
the httpSessionId

getPage

public java.lang.String getPage()
Returns:
the page

getDocumentDomain

public java.lang.String getDocumentDomain()
Returns:
the document domain

getExtraParameters

public java.util.Map<java.lang.String,FormField> getExtraParameters()
Returns:
the spareParameters

Copyright ยจ 2008