Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

okapi.tools
Class ToolRequest

java.lang.Object
  extended by javax.servlet.ServletRequestWrapper
      extended by javax.servlet.http.HttpServletRequestWrapper
          extended by okapi.tools.ToolRequest
All Implemented Interfaces:
javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
public class ToolRequest
extends javax.servlet.http.HttpServletRequestWrapper

Class ToolRequest. Request Wrapper used by the Aggregator to collect the output from any servlet.

Version:
$Revision: 863 $, $Date: 2006-05-07 17:24:27 -0400 (Sun, 07 May 2006) $
Author:
MIT Stellar team

Field Summary
 
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Constructor Summary
ToolRequest(javax.servlet.http.HttpServletRequest request)
           
 
Method Summary
protected  java.lang.Object clone()
           
 boolean equals(java.lang.Object o)
          Method equals
protected  void finalize()
           
 java.lang.Object getAttribute(java.lang.String name)
          Method getAttribute
 java.util.Enumeration getAttributeNames()
          Method getAttributeNames
 java.lang.String getAuthType()
          Method getAuthType
 java.lang.String getCharacterEncoding()
          Method getCharacterEncoding
 int getContentLength()
          Method getContentLength
 java.lang.String getContentType()
          Method getContentType
 java.lang.String getContextPath()
          Method getContextPath
 javax.servlet.http.Cookie[] getCookies()
          Method getCookies
 long getDateHeader(java.lang.String name)
          Method getDateHeader
 java.lang.String getHeader(java.lang.String name)
          Method getHeader
 java.util.Enumeration getHeaderNames()
          Method getHeaderNames
 java.util.Enumeration getHeaders(java.lang.String name)
          Method getHeaders
 javax.servlet.ServletInputStream getInputStream()
          Method getInputStream
 int getIntHeader(java.lang.String name)
          Method getIntHeader
 java.lang.String getLocalAddr()
          Method getLocalAddr
 java.util.Locale getLocale()
          Method getLocale
 java.util.Enumeration getLocales()
          Method getLocales
 java.lang.String getLocalName()
          Method getLocalName
 int getLocalPort()
          Method getLocalPort
 java.lang.String getMethod()
          Method getMethod
 java.lang.String getParameter(java.lang.String name)
          Method getParameter
 java.util.Map getParameterMap()
          Method getParameterMap
 java.util.Enumeration getParameterNames()
          Method getParameterNames
 java.lang.String[] getParameterValues(java.lang.String name)
          Method getParameterValues
 java.lang.String getPathInfo()
          Method getPathInfo
 java.lang.String getPathTranslated()
          Method getPathTranslated
 java.lang.String getProtocol()
          Method getProtocol
 java.lang.String getQueryString()
          Method getQueryString
 java.io.BufferedReader getReader()
          Method getReader
 java.lang.String getRealPath(java.lang.String path)
          Method getRealPath
 java.lang.String getRemoteAddr()
          Method getRemoteAddr
 java.lang.String getRemoteHost()
          Method getRemoteHost
 int getRemotePort()
          Method getRemotePort
 java.lang.String getRemoteUser()
          Method getRemoteUser.
 javax.servlet.ServletRequest getRequest()
          Method getRequest
 javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
          Method getRequestDispatcher
 java.lang.String getRequestedSessionId()
          Method getRequestedSessionId
 java.lang.String getRequestURI()
          Method getRequestURI
 java.lang.StringBuffer getRequestURL()
          Method getRequestURL
 java.lang.String getScheme()
          Method getScheme
 java.lang.String getServerName()
          Method getServerName
 int getServerPort()
          Method getServerPort
 java.lang.String getServletPath()
          Method getServletPath
 javax.servlet.http.HttpSession getSession()
          Method getSession
 javax.servlet.http.HttpSession getSession(boolean create)
          Method getSession
 java.security.Principal getUserPrincipal()
          Method getUserPrincipal
 int hashCode()
          Method hashCode
 boolean isRequestedSessionIdFromCookie()
          Method isRequestedSessionIdFromCookie
 boolean isRequestedSessionIdFromUrl()
          Method isRequestedSessionIdFromUrl
 boolean isRequestedSessionIdFromURL()
          Method isRequestedSessionIdFromURL
 boolean isRequestedSessionIdValid()
          Method isRequestedSessionIdValid
 boolean isSecure()
          Method isSecure
 boolean isUserInRole(java.lang.String role)
          Method isUserInRole
 void removeAttribute(java.lang.String name)
          Method removeAttribute
 void setAttribute(java.lang.String name, java.lang.Object o)
          Method setAttribute
 void setCharacterEncoding(java.lang.String enc)
          Method setCharacterEncoding
 void setContextPath(java.lang.String path)
          Method setContextPath SAKAI
 void setPathInfo(java.lang.String path)
          Method setPathInfo SAKAI
 void setRequest(javax.servlet.ServletRequest request)
          Method setRequest
 java.lang.String toString()
          Method toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ToolRequest

public ToolRequest(javax.servlet.http.HttpServletRequest request)
Parameters:
request -
Method Detail

getAuthType

public java.lang.String getAuthType()
Method getAuthType

Specified by:
getAuthType in interface javax.servlet.http.HttpServletRequest
Overrides:
getAuthType in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getContextPath

public java.lang.String getContextPath()
Method getContextPath

Specified by:
getContextPath in interface javax.servlet.http.HttpServletRequest
Overrides:
getContextPath in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

setContextPath

public void setContextPath(java.lang.String path)
Method setContextPath SAKAI

Parameters:
path -

getCookies

public javax.servlet.http.Cookie[] getCookies()
Method getCookies

Specified by:
getCookies in interface javax.servlet.http.HttpServletRequest
Overrides:
getCookies in class javax.servlet.http.HttpServletRequestWrapper
Returns:
Cookie[]

getDateHeader

public long getDateHeader(java.lang.String name)
Method getDateHeader

Specified by:
getDateHeader in interface javax.servlet.http.HttpServletRequest
Overrides:
getDateHeader in class javax.servlet.http.HttpServletRequestWrapper
Parameters:
name -
Returns:
long

getHeader

public java.lang.String getHeader(java.lang.String name)
Method getHeader

Specified by:
getHeader in interface javax.servlet.http.HttpServletRequest
Overrides:
getHeader in class javax.servlet.http.HttpServletRequestWrapper
Parameters:
name -
Returns:
String

getHeaderNames

public java.util.Enumeration getHeaderNames()
Method getHeaderNames

Specified by:
getHeaderNames in interface javax.servlet.http.HttpServletRequest
Overrides:
getHeaderNames in class javax.servlet.http.HttpServletRequestWrapper
Returns:
Enumeration

getHeaders

public java.util.Enumeration getHeaders(java.lang.String name)
Method getHeaders

Specified by:
getHeaders in interface javax.servlet.http.HttpServletRequest
Overrides:
getHeaders in class javax.servlet.http.HttpServletRequestWrapper
Parameters:
name -
Returns:
Enumeration

getIntHeader

public int getIntHeader(java.lang.String name)
Method getIntHeader

Specified by:
getIntHeader in interface javax.servlet.http.HttpServletRequest
Overrides:
getIntHeader in class javax.servlet.http.HttpServletRequestWrapper
Parameters:
name -
Returns:
int

getMethod

public java.lang.String getMethod()
Method getMethod

Specified by:
getMethod in interface javax.servlet.http.HttpServletRequest
Overrides:
getMethod in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getPathInfo

public java.lang.String getPathInfo()
Method getPathInfo

Specified by:
getPathInfo in interface javax.servlet.http.HttpServletRequest
Overrides:
getPathInfo in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

setPathInfo

public void setPathInfo(java.lang.String path)
Method setPathInfo SAKAI

Parameters:
path -

getPathTranslated

public java.lang.String getPathTranslated()
Method getPathTranslated

Specified by:
getPathTranslated in interface javax.servlet.http.HttpServletRequest
Overrides:
getPathTranslated in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getQueryString

public java.lang.String getQueryString()
Method getQueryString

Specified by:
getQueryString in interface javax.servlet.http.HttpServletRequest
Overrides:
getQueryString in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getRemoteUser

public java.lang.String getRemoteUser()
Method getRemoteUser. Return current user

Specified by:
getRemoteUser in interface javax.servlet.http.HttpServletRequest
Overrides:
getRemoteUser in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getRequestedSessionId

public java.lang.String getRequestedSessionId()
Method getRequestedSessionId

Specified by:
getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
Overrides:
getRequestedSessionId in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getRequestURI

public java.lang.String getRequestURI()
Method getRequestURI

Specified by:
getRequestURI in interface javax.servlet.http.HttpServletRequest
Overrides:
getRequestURI in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getRequestURL

public java.lang.StringBuffer getRequestURL()
Method getRequestURL

Specified by:
getRequestURL in interface javax.servlet.http.HttpServletRequest
Overrides:
getRequestURL in class javax.servlet.http.HttpServletRequestWrapper
Returns:
StringBuffer

getServletPath

public java.lang.String getServletPath()
Method getServletPath

Specified by:
getServletPath in interface javax.servlet.http.HttpServletRequest
Overrides:
getServletPath in class javax.servlet.http.HttpServletRequestWrapper
Returns:
String

getSession

public javax.servlet.http.HttpSession getSession()
Method getSession

Specified by:
getSession in interface javax.servlet.http.HttpServletRequest
Overrides:
getSession in class javax.servlet.http.HttpServletRequestWrapper
Returns:
HttpSession

getSession

public javax.servlet.http.HttpSession getSession(boolean create)
Method getSession

Specified by:
getSession in interface javax.servlet.http.HttpServletRequest
Overrides:
getSession in class javax.servlet.http.HttpServletRequestWrapper
Parameters:
create -
Returns:
HttpSession

getUserPrincipal

public java.security.Principal getUserPrincipal()
Method getUserPrincipal

Specified by:
getUserPrincipal in interface javax.servlet.http.HttpServletRequest
Overrides:
getUserPrincipal in class javax.servlet.http.HttpServletRequestWrapper
Returns:
Principal

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()
Method isRequestedSessionIdFromCookie

Specified by:
isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
Overrides:
isRequestedSessionIdFromCookie in class javax.servlet.http.HttpServletRequestWrapper
Returns:
boolean

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()
Method isRequestedSessionIdFromUrl

Specified by:
isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
Overrides:
isRequestedSessionIdFromUrl in class javax.servlet.http.HttpServletRequestWrapper
Returns:
boolean

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()
Method isRequestedSessionIdFromURL

Specified by:
isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
Overrides:
isRequestedSessionIdFromURL in class javax.servlet.http.HttpServletRequestWrapper
Returns:
boolean

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()
Method isRequestedSessionIdValid

Specified by:
isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
Overrides:
isRequestedSessionIdValid in class javax.servlet.http.HttpServletRequestWrapper
Returns:
boolean

isUserInRole

public boolean isUserInRole(java.lang.String role)
Method isUserInRole

Specified by:
isUserInRole in interface javax.servlet.http.HttpServletRequest
Overrides:
isUserInRole in class javax.servlet.http.HttpServletRequestWrapper
Parameters:
role -
Returns:
boolean

getRequest

public javax.servlet.ServletRequest getRequest()
Method getRequest

Overrides:
getRequest in class javax.servlet.ServletRequestWrapper
Returns:
ServletRequest

setRequest

public void setRequest(javax.servlet.ServletRequest request)
Method setRequest

Overrides:
setRequest in class javax.servlet.ServletRequestWrapper
Parameters:
request -

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Method getAttribute

Specified by:
getAttribute in interface javax.servlet.ServletRequest
Overrides:
getAttribute in class javax.servlet.ServletRequestWrapper
Parameters:
name -
Returns:
Object

getAttributeNames

public java.util.Enumeration getAttributeNames()
Method getAttributeNames

Specified by:
getAttributeNames in interface javax.servlet.ServletRequest
Overrides:
getAttributeNames in class javax.servlet.ServletRequestWrapper
Returns:
Enumeration

getCharacterEncoding

public java.lang.String getCharacterEncoding()
Method getCharacterEncoding

Specified by:
getCharacterEncoding in interface javax.servlet.ServletRequest
Overrides:
getCharacterEncoding in class javax.servlet.ServletRequestWrapper
Returns:
String

setCharacterEncoding

public void setCharacterEncoding(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException
Method setCharacterEncoding

Specified by:
setCharacterEncoding in interface javax.servlet.ServletRequest
Overrides:
setCharacterEncoding in class javax.servlet.ServletRequestWrapper
Parameters:
enc -
Throws:
java.io.UnsupportedEncodingException

getContentLength

public int getContentLength()
Method getContentLength

Specified by:
getContentLength in interface javax.servlet.ServletRequest
Overrides:
getContentLength in class javax.servlet.ServletRequestWrapper
Returns:
int

getContentType

public java.lang.String getContentType()
Method getContentType

Specified by:
getContentType in interface javax.servlet.ServletRequest
Overrides:
getContentType in class javax.servlet.ServletRequestWrapper
Returns:
String

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
Method getInputStream

Specified by:
getInputStream in interface javax.servlet.ServletRequest
Overrides:
getInputStream in class javax.servlet.ServletRequestWrapper
Returns:
ServletInputStream
Throws:
java.io.IOException

getParameter

public java.lang.String getParameter(java.lang.String name)
Method getParameter

Specified by:
getParameter in interface javax.servlet.ServletRequest
Overrides:
getParameter in class javax.servlet.ServletRequestWrapper
Parameters:
name -
Returns:
String

getParameterMap

public java.util.Map getParameterMap()
Method getParameterMap

Specified by:
getParameterMap in interface javax.servlet.ServletRequest
Overrides:
getParameterMap in class javax.servlet.ServletRequestWrapper
Returns:
Map

getParameterNames

public java.util.Enumeration getParameterNames()
Method getParameterNames

Specified by:
getParameterNames in interface javax.servlet.ServletRequest
Overrides:
getParameterNames in class javax.servlet.ServletRequestWrapper
Returns:
Enumeration

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)
Method getParameterValues

Specified by:
getParameterValues in interface javax.servlet.ServletRequest
Overrides:
getParameterValues in class javax.servlet.ServletRequestWrapper
Parameters:
name -
Returns:
String[]

getProtocol

public java.lang.String getProtocol()
Method getProtocol

Specified by:
getProtocol in interface javax.servlet.ServletRequest
Overrides:
getProtocol in class javax.servlet.ServletRequestWrapper
Returns:
String

getScheme

public java.lang.String getScheme()
Method getScheme

Specified by:
getScheme in interface javax.servlet.ServletRequest
Overrides:
getScheme in class javax.servlet.ServletRequestWrapper
Returns:
String

getServerName

public java.lang.String getServerName()
Method getServerName

Specified by:
getServerName in interface javax.servlet.ServletRequest
Overrides:
getServerName in class javax.servlet.ServletRequestWrapper
Returns:
String

getServerPort

public int getServerPort()
Method getServerPort

Specified by:
getServerPort in interface javax.servlet.ServletRequest
Overrides:
getServerPort in class javax.servlet.ServletRequestWrapper
Returns:
int

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException
Method getReader

Specified by:
getReader in interface javax.servlet.ServletRequest
Overrides:
getReader in class javax.servlet.ServletRequestWrapper
Returns:
BufferedReader
Throws:
java.io.IOException

getRemoteAddr

public java.lang.String getRemoteAddr()
Method getRemoteAddr

Specified by:
getRemoteAddr in interface javax.servlet.ServletRequest
Overrides:
getRemoteAddr in class javax.servlet.ServletRequestWrapper
Returns:
String

getRemoteHost

public java.lang.String getRemoteHost()
Method getRemoteHost

Specified by:
getRemoteHost in interface javax.servlet.ServletRequest
Overrides:
getRemoteHost in class javax.servlet.ServletRequestWrapper
Returns:
String

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object o)
Method setAttribute

Specified by:
setAttribute in interface javax.servlet.ServletRequest
Overrides:
setAttribute in class javax.servlet.ServletRequestWrapper
Parameters:
name -
o -

removeAttribute

public void removeAttribute(java.lang.String name)
Method removeAttribute

Specified by:
removeAttribute in interface javax.servlet.ServletRequest
Overrides:
removeAttribute in class javax.servlet.ServletRequestWrapper
Parameters:
name -

getLocale

public java.util.Locale getLocale()
Method getLocale

Specified by:
getLocale in interface javax.servlet.ServletRequest
Overrides:
getLocale in class javax.servlet.ServletRequestWrapper
Returns:
Locale

getLocales

public java.util.Enumeration getLocales()
Method getLocales

Specified by:
getLocales in interface javax.servlet.ServletRequest
Overrides:
getLocales in class javax.servlet.ServletRequestWrapper
Returns:
Enumeration

isSecure

public boolean isSecure()
Method isSecure

Specified by:
isSecure in interface javax.servlet.ServletRequest
Overrides:
isSecure in class javax.servlet.ServletRequestWrapper
Returns:
boolean

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
Method getRequestDispatcher

Specified by:
getRequestDispatcher in interface javax.servlet.ServletRequest
Overrides:
getRequestDispatcher in class javax.servlet.ServletRequestWrapper
Parameters:
path -
Returns:
RequestDispatcher

getRealPath

public java.lang.String getRealPath(java.lang.String path)
Method getRealPath

Specified by:
getRealPath in interface javax.servlet.ServletRequest
Overrides:
getRealPath in class javax.servlet.ServletRequestWrapper
Parameters:
path -
Returns:
String

getRemotePort

public int getRemotePort()
Method getRemotePort

Specified by:
getRemotePort in interface javax.servlet.ServletRequest
Overrides:
getRemotePort in class javax.servlet.ServletRequestWrapper
Returns:
int

getLocalName

public java.lang.String getLocalName()
Method getLocalName

Specified by:
getLocalName in interface javax.servlet.ServletRequest
Overrides:
getLocalName in class javax.servlet.ServletRequestWrapper
Returns:
String

getLocalAddr

public java.lang.String getLocalAddr()
Method getLocalAddr

Specified by:
getLocalAddr in interface javax.servlet.ServletRequest
Overrides:
getLocalAddr in class javax.servlet.ServletRequestWrapper
Returns:
String

getLocalPort

public int getLocalPort()
Method getLocalPort

Specified by:
getLocalPort in interface javax.servlet.ServletRequest
Overrides:
getLocalPort in class javax.servlet.ServletRequestWrapper
Returns:
int

hashCode

public int hashCode()
Method hashCode

Overrides:
hashCode in class java.lang.Object
Returns:
int

equals

public boolean equals(java.lang.Object o)
Method equals

Overrides:
equals in class java.lang.Object
Parameters:
o -
Returns:
boolean

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

toString

public java.lang.String toString()
Method toString

Overrides:
toString in class java.lang.Object
Returns:
String

finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright ? 2001-2009 MIT. All Rights Reserved.