ServletRequestAdapter

java.lang.Object
- org.apache.openejb.server.httpd.ServletRequestAdapter

All Implemented Interfaces:: java.io.Serializable, HttpRequest

public class ServletRequestAdapter
extends java.lang.Object
implements HttpRequest

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.openejb.server.httpd.HttpRequest
  HttpRequest.Method

Field Summary
- Fields inherited from interface org.apache.openejb.server.httpd.HttpRequest
  HEADER_ACCEPT, HEADER_ACCEPT_ENCODING, HEADER_ACCEPT_LANGUAGE, HEADER_CACHE_CONTROL, HEADER_CONNECTION, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_COOKIE, HEADER_HOST, HEADER_SET_COOKIE, HEADER_USER_AGENT, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE

Constructor Summary

Constructors
Constructor and Description
`ServletRequestAdapter(HttpServletRequest request)`
`ServletRequestAdapter(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`authenticate(HttpServletResponse httpServletResponse)`
`java.lang.String`	`changeSessionId()`
`AsyncContext`	`getAsyncContext()`
`java.lang.Object`	`getAttribute(java.lang.String s)`
`java.util.Enumeration<java.lang.String>`	`getAttributeNames()`
`java.lang.String`	`getAuthType()`
`java.lang.String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`java.lang.String`	`getContentType()`
`java.lang.String`	`getContextPath()`
`Cookie[]`	`getCookies()`
`long`	`getDateHeader(java.lang.String s)`
`DispatcherType`	`getDispatcherType()`
`java.lang.String`	`getHeader(java.lang.String name)`
`java.util.Enumeration<java.lang.String>`	`getHeaderNames()`
`java.util.Enumeration<java.lang.String>`	`getHeaders(java.lang.String s)`
`ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(java.lang.String s)`
`java.lang.String`	`getLocalAddr()`
`java.util.Locale`	`getLocale()`
`java.util.Enumeration<java.util.Locale>`	`getLocales()`
`java.lang.String`	`getLocalName()`
`int`	`getLocalPort()`
`java.lang.String`	`getMethod()`
`java.lang.String`	`getParameter(java.lang.String name)` Gets a form or URL query parameter based on the name passed in.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()`
`java.util.Enumeration<java.lang.String>`	`getParameterNames()`
`java.util.Map`	`getParameters()` Gets all the form and URL query parameters
`java.lang.String[]`	`getParameterValues(java.lang.String s)`
`Part`	`getPart(java.lang.String s)`
`java.util.Collection<Part>`	`getParts()`
`java.lang.String`	`getPathInfo()`
`java.lang.String`	`getPathTranslated()`
`java.lang.String`	`getProtocol()`
`java.lang.String`	`getQueryString()`
`java.io.BufferedReader`	`getReader()`
`java.lang.String`	`getRealPath(java.lang.String s)`
`java.lang.String`	`getRemoteAddr()`
`java.lang.String`	`getRemoteHost()`
`int`	`getRemotePort()`
`java.lang.String`	`getRemoteUser()`
`HttpServletRequest`	`getRequest()`
`RequestDispatcher`	`getRequestDispatcher(java.lang.String s)`
`java.lang.String`	`getRequestedSessionId()`
`java.lang.String`	`getRequestURI()`
`java.lang.StringBuffer`	`getRequestURL()`
`java.lang.String`	`getScheme()`
`java.lang.String`	`getServerName()`
`int`	`getServerPort()`
`ServletContext`	`getServletContext()`
`java.lang.String`	`getServletPath()`
`HttpSession`	`getSession()`
`HttpSession`	`getSession(boolean create)`
`java.net.URI`	`getURI()` Gets the URI for the current URL page.
`java.security.Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(java.lang.String s)`
`void`	`login(java.lang.String s, java.lang.String s1)`
`void`	`logout()`
`void`	`removeAttribute(java.lang.String s)`
`void`	`setAttribute(java.lang.String s, java.lang.Object o)`
`void`	`setCharacterEncoding(java.lang.String s)`
`AsyncContext`	`startAsync()`
`AsyncContext`	`startAsync(ServletRequest servletRequest, ServletResponse servletResponse)`
`<T extends HttpUpgradeHandler> T`	`upgrade(java.lang.Class<T> httpUpgradeHandlerClass)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServletRequestAdapter

public ServletRequestAdapter(HttpServletRequest request)

ServletRequestAdapter

public ServletRequestAdapter(HttpServletRequest request,
                             HttpServletResponse response,
                             ServletContext servletContext)

Method Detail

getSession

public HttpSession getSession(boolean create)

getUserPrincipal

public java.security.Principal getUserPrincipal()

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

isUserInRole

public boolean isUserInRole(java.lang.String s)

login

public void login(java.lang.String s,
                  java.lang.String s1)
           throws ServletException

Throws:: ServletException

logout

public void logout()
            throws ServletException

Throws:: ServletException

getSession
```
public HttpSession getSession()
```

changeSessionId

public java.lang.String changeSessionId()

getHeader

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

getHeaderNames

public java.util.Enumeration<java.lang.String> getHeaderNames()

getHeaders

public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String s)

getIntHeader

public int getIntHeader(java.lang.String s)

getURI
```
public java.net.URI getURI()
```
Description copied from interface: HttpRequest

Gets the URI for the current URL page.

Specified by:

getURI in interface HttpRequest

Returns:

The URI

getContentLength
```
public int getContentLength()
```
Specified by:

getContentLength in interface HttpRequest

getContentLengthLong
```
public long getContentLengthLong()
```

getContentType
```
public java.lang.String getContentType()
```
Specified by:

getContentType in interface HttpRequest

getDispatcherType

public DispatcherType getDispatcherType()

authenticate

public boolean authenticate(HttpServletResponse httpServletResponse)
                     throws java.io.IOException,
                            ServletException

Throws:: java.io.IOException; ServletException

getAuthType
```
public java.lang.String getAuthType()
```

getContextPath

public java.lang.String getContextPath()

getCookies
```
public Cookie[] getCookies()
```

getDateHeader

public long getDateHeader(java.lang.String s)

getInputStream

public ServletInputStream getInputStream()
                                  throws java.io.IOException

Throws:: java.io.IOException

getLocalAddr

public java.lang.String getLocalAddr()

getLocale
```
public java.util.Locale getLocale()
```

getLocales

public java.util.Enumeration<java.util.Locale> getLocales()

getLocalName

public java.lang.String getLocalName()

getLocalPort
```
public int getLocalPort()
```

getMethod
```
public java.lang.String getMethod()
```

getPart

public Part getPart(java.lang.String s)
             throws java.io.IOException,
                    ServletException

Throws:: java.io.IOException; ServletException

upgrade

public <T extends HttpUpgradeHandler> T upgrade(java.lang.Class<T> httpUpgradeHandlerClass)
                                         throws java.io.IOException,
                                                ServletException

Throws:: java.io.IOException; ServletException

getParts

public java.util.Collection<Part> getParts()
                                    throws java.io.IOException,
                                           ServletException

Throws:: java.io.IOException; ServletException

getPathInfo
```
public java.lang.String getPathInfo()
```

getPathTranslated

public java.lang.String getPathTranslated()

getQueryString

public java.lang.String getQueryString()

getRemoteUser

public java.lang.String getRemoteUser()

getRequestedSessionId

public java.lang.String getRequestedSessionId()

getRequestURI

public java.lang.String getRequestURI()

getRequestURL

public java.lang.StringBuffer getRequestURL()

getServletPath

public java.lang.String getServletPath()

getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
Description copied from interface: HttpRequest

Gets a form or URL query parameter based on the name passed in.

Specified by:

getParameter in interface HttpRequest

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

getParameterNames

public java.util.Enumeration<java.lang.String> getParameterNames()

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String s)

getProtocol
```
public java.lang.String getProtocol()
```

getReader

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

Throws:: java.io.IOException

getRealPath

public java.lang.String getRealPath(java.lang.String s)

getParameters
```
public java.util.Map getParameters()
```
Description copied from interface: HttpRequest

Gets all the form and URL query parameters

Specified by:

getParameters in interface HttpRequest

Returns:

All the form and URL query parameters

getAsyncContext
```
public AsyncContext getAsyncContext()
```

getAttribute
```
public java.lang.Object getAttribute(java.lang.String s)
```
Specified by:

getAttribute in interface HttpRequest

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

getCharacterEncoding

public java.lang.String getCharacterEncoding()

setAttribute

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

Specified by:: setAttribute in interface HttpRequest

setCharacterEncoding

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

Throws:: java.io.UnsupportedEncodingException

startAsync
```
public AsyncContext startAsync()
```

startAsync

public AsyncContext startAsync(ServletRequest servletRequest,
                               ServletResponse servletResponse)

getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
Specified by:

getRemoteAddr in interface HttpRequest

getRemoteHost

public java.lang.String getRemoteHost()

getRemotePort
```
public int getRemotePort()
```

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String s)

getScheme
```
public java.lang.String getScheme()
```

getServerName

public java.lang.String getServerName()

getServerPort
```
public int getServerPort()
```

getServletContext

public ServletContext getServletContext()

isAsyncStarted
```
public boolean isAsyncStarted()
```

isAsyncSupported
```
public boolean isAsyncSupported()
```

isSecure
```
public boolean isSecure()
```

removeAttribute

public void removeAttribute(java.lang.String s)

getRequest

public HttpServletRequest getRequest()

Class ServletRequestAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.openejb.server.httpd.HttpRequest

Field Summary

Fields inherited from interface org.apache.openejb.server.httpd.HttpRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServletRequestAdapter

ServletRequestAdapter

Method Detail

getSession

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromUrl

isRequestedSessionIdFromURL

isRequestedSessionIdValid

isUserInRole

login

logout

getSession

changeSessionId

getHeader

getHeaderNames

getHeaders

getIntHeader

getURI

getContentLength

getContentLengthLong

getContentType

getDispatcherType

authenticate

getAuthType

getContextPath

getCookies

getDateHeader

getInputStream

getLocalAddr

getLocale

getLocales

getLocalName

getLocalPort

getMethod

getPart

upgrade

getParts

getPathInfo

getPathTranslated

getQueryString

getRemoteUser

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getParameter

getParameterMap

getParameterNames

getParameterValues

getProtocol

getReader

getRealPath

getParameters

getAsyncContext

getAttribute

getAttributeNames

getCharacterEncoding

setAttribute

setCharacterEncoding

startAsync

startAsync

getRemoteAddr

getRemoteHost

getRemotePort

getRequestDispatcher

getScheme

getServerName

getServerPort

getServletContext

isAsyncStarted