public class RemoteWebRequest extends BaseObject implements IwebRequest
HttpServletRequest
instance, to expose it as a legacy
IwebRequest
.Modifier and Type | Field and Description |
---|---|
private java.lang.String |
basepath
The base path for this request.
|
private static java.util.Map<java.lang.String,java.util.function.Function<javax.servlet.http.HttpServletRequest,java.lang.Object>> |
CGI_VARS
All reported CGI variables and their expression to calculate it.
|
private raw |
contentMD5
The MD5 hash of body
|
private object<? extends _BaseObject_> |
entity
The body entity.
|
private java.lang.String[] |
paths
The paths for this request, as configured at the handler.
|
private javax.servlet.http.HttpServletRequest |
request
The servlet request.
|
private java.lang.String |
target
The target path for this request.
|
private static java.lang.Object |
UNSUPPORTED_CGI_VAR
A marker for unsupported
CGI_VARS . |
Constructor and Description |
---|
RemoteWebRequest() |
Modifier and Type | Method and Description |
---|---|
void |
__web_RemoteWebRequest_constructor__()
Default constructor.
|
void |
__web_RemoteWebRequest_execute__()
The execute method to initialize the FWD-related state for an instance.
|
private object<? extends Cookie> |
_getCookie(javax.servlet.http.Cookie cookie) |
protected java.lang.String |
_getPathInfo() |
private boolean |
_initialize()
Initialize this instance with the specified details.
|
void |
clearCookies()
Clear all cookies.
|
void |
clearHeaders()
Clear the headers.
|
private java.lang.String |
emptyIfNull(java.lang.String val)
Return the empty value for a null string.
|
character |
getCharacterEncoding()
Get the character encoding.
|
integer |
getContentLength()
Get the content length.
|
raw |
getContentMd5()
Get the content MD5.
|
character |
getContentType()
Get the content type.
|
character |
getContextNames()
Get the context names.
|
longchar |
getContextValue(character _pcName)
Get the context value with the specified name.
|
object<? extends Cookie> |
getCookie(character _pcName)
Get the cookie with the specified name.
|
integer |
getCookies(OutputExtentParameter<object<? extends Cookie>> _poCookies)
Get the request cookies.
|
character |
getDefaultCookieDomain()
Get the default cookie domain.
|
character |
getDefaultCookiePath()
Get the default cookie path.
|
object<? extends _BaseObject_> |
getEntity()
Get the body entity.
|
object<? extends HttpHeader> |
getHeader(character _pcName)
Get the specified header's value.
|
integer |
getHeaders(OutputExtentParameter<object<? extends HttpHeader>> _poHeaders)
Populate the specified extent variable with all the headers.
|
character |
getLocalAddress()
Get the local address.
|
character |
getLocalHost()
Get the local host.
|
integer |
getLocalPort()
Get the local port.
|
character |
getMethod()
Get the HTTP method.
|
character |
getPathInfo()
Get the path information.
|
character |
getPathParameter(character _pcName)
Get the path parameter value, with the specified name.
|
character |
getPathParameterNames()
Get the path parameter names.
|
character |
getRemoteAddress()
Get the remote address.
|
character |
getRemoteHost()
Get the remote host.
|
integer |
getRemotePort()
Get the remote port.
|
character |
getRemoteUser()
Get the remote user.
|
character |
getResolvedTransportPath()
Get the resolved transport path.
|
character |
getResolvedWebAppPath()
Resolve the web app path.
|
character |
getServerSoftware()
Get the server software info.
|
character |
getTransferEncoding()
Get the transfer encoding.
|
character |
getTransportPath()
Get the transport path.
|
object<? extends Uri> |
getUri()
Get the HTTP URI.
|
character |
getUriTemplate()
Get the URI template.
|
character |
getVersion()
Get the HTTP version.
|
character |
getWebAppPath()
Get the servlet path.
|
logical |
hasCookie(character _pcName)
Check if the specified cookie exists in the request.
|
logical |
hasCookie(object<? extends Cookie> _poCookie)
Check if the specified cookie exists in the request.
|
logical |
hasHeader(character _pcName)
Check if the specified header name exists.
|
void |
removeCookie(character _pcName)
Remove the specified cookie.
|
void |
removeCookie(object<? extends Cookie> _poCookie)
Remove the specified cookie.
|
void |
removeHeader(character _pcName)
Remove the specified header.
|
void |
setCharacterEncoding(character _encoding)
Set the character encoding.
|
void |
setContentLength(integer _var)
Set the content length.
|
void |
setContentMd5(raw _var)
Set the content MD5.
|
void |
setContentType(character _var)
Set the content type.
|
void |
setCookie(object<? extends Cookie> _poCookie)
Set or add the specified cookie.
|
void |
setCookies(object<? extends Cookie>[] _poCookies) |
void |
setEntity(object<? extends _BaseObject_> _var)
Set the body entity.
|
object<? extends HttpHeader> |
setHeader(character _pcName,
character _pcValue)
Set the specified header.
|
void |
setHeader(object<? extends HttpHeader> _poHeader)
Set the specified header.
|
void |
setHeaders(object<? extends HttpHeader>[] _poHeader) |
void |
setMethod(character method)
Set the HTTP method.
|
void |
setTransferEncoding(character transferEncoding)
Set the transfer encoding.
|
void |
setUri(object<? extends Uri> uri)
Set the HTTP URI.
|
void |
setVersion(character version)
Set the HTTP version.
|
private void |
throwNotImplementedMethod(java.lang.String name) |
private void |
throwNotImplementedProperty(java.lang.String name) |
private void |
throwReadOnly(java.lang.String name) |
__lang_BaseObject_constructor__, __lang_BaseObject_execute__, assertNotNull, assertNotNull, clone, getLegacyClass, getNextSibling, getPrevSibling, legacyEquals, toLegacyString
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
__lang_BaseObject_constructor__, clone, getLegacyClass, getNextSibling, getPrevSibling, isTracked, legacyEquals, toLegacyString
private static final java.lang.Object UNSUPPORTED_CGI_VAR
CGI_VARS
.private static final java.util.Map<java.lang.String,java.util.function.Function<javax.servlet.http.HttpServletRequest,java.lang.Object>> CGI_VARS
private java.lang.String basepath
private java.lang.String target
private javax.servlet.http.HttpServletRequest request
private java.lang.String[] paths
private raw contentMD5
private object<? extends _BaseObject_> entity
public void __web_RemoteWebRequest_execute__()
public void __web_RemoteWebRequest_constructor__()
private boolean _initialize()
public character getMethod()
getMethod
in interface IhttpRequest
public void setMethod(character method)
setMethod
in interface IhttpRequest
method
- the HTTP method.public object<? extends Uri> getUri()
getUri
in interface IhttpRequest
public void setUri(object<? extends Uri> uri)
setUri
in interface IhttpRequest
uri
- the HTTP URI.public character getCharacterEncoding()
getCharacterEncoding
in interface IhttpMessage
public void setCharacterEncoding(character _encoding)
setCharacterEncoding
in interface IhttpMessage
_encoding
- The character encoding.public integer getContentLength()
getContentLength
in interface IhttpMessage
public void setContentLength(integer _var)
setContentLength
in interface IhttpMessage
_var
- The content length.public raw getContentMd5()
getContentMd5
in interface IhttpMessage
public void setContentMd5(raw _var)
setContentMd5
in interface IhttpMessage
_var
- The content MD5.public character getContentType()
getContentType
in interface IhttpMessage
public void setContentType(character _var)
setContentType
in interface IhttpMessage
_var
- The content type.public object<? extends _BaseObject_> getEntity()
getEntity
in interface IhttpMessage
public void setEntity(object<? extends _BaseObject_> _var)
setEntity
in interface IhttpMessage
_var
- The body entity.public character getTransferEncoding()
getTransferEncoding
in interface IhttpMessage
public void setTransferEncoding(character transferEncoding)
setTransferEncoding
in interface IhttpMessage
transferEncoding
- The transfer encoding.public character getVersion()
getVersion
in interface IhttpMessage
public void setVersion(character version)
setVersion
in interface IhttpMessage
version
- The HTTP version.public void clearHeaders()
clearHeaders
in interface IhttpMessage
public object<? extends HttpHeader> getHeader(character _pcName)
getHeader
in interface IhttpMessage
_pcName
- The header name.public integer getHeaders(OutputExtentParameter<object<? extends HttpHeader>> _poHeaders)
getHeaders
in interface IhttpMessage
_poHeaders
- The header array.public logical hasHeader(character _pcName)
hasHeader
in interface IhttpMessage
_pcName
- The header name.public void removeHeader(character _pcName)
removeHeader
in interface IhttpMessage
_pcName
- The header name.public void setHeader(object<? extends HttpHeader> _poHeader)
setHeader
in interface IhttpMessage
_poHeader
- The header instance.public object<? extends HttpHeader> setHeader(character _pcName, character _pcValue)
_pcName
- The header name._pcValue
- The header value.public character getResolvedWebAppPath()
getResolvedWebAppPath
in interface IwebRequest
public character getContextNames()
CGI_VARS
keys.getContextNames
in interface IwebRequest
public character getDefaultCookieDomain()
getDefaultCookieDomain
in interface IwebRequest
public character getDefaultCookiePath()
getDefaultCookiePath
in interface IwebRequest
public character getLocalAddress()
getLocalAddress
in interface IwebRequest
public character getLocalHost()
getLocalHost
in interface IwebRequest
public integer getLocalPort()
getLocalPort
in interface IwebRequest
public character getPathInfo()
getPathInfo
in interface IwebRequest
protected java.lang.String _getPathInfo()
public character getPathParameterNames()
getPathParameterNames
in interface IwebRequest
public character getRemoteAddress()
getRemoteAddress
in interface IwebRequest
public character getRemoteHost()
getRemoteHost
in interface IwebRequest
public integer getRemotePort()
getRemotePort
in interface IwebRequest
public character getRemoteUser()
getRemoteUser
in interface IwebRequest
public character getResolvedTransportPath()
getResolvedTransportPath
in interface IwebRequest
public character getServerSoftware()
getServerSoftware
in interface IwebRequest
public character getTransportPath()
getTransportPath
in interface IwebRequest
basepath
.public character getUriTemplate()
getUriTemplate
in interface IwebRequest
public character getWebAppPath()
getWebAppPath
in interface IwebRequest
public longchar getContextValue(character _pcName)
getContextValue
in interface IwebRequest
_pcName
- The context name.public character getPathParameter(character _pcName)
getPathParameter
in interface IwebRequest
_pcName
- The path parameter name.public integer getCookies(OutputExtentParameter<object<? extends Cookie>> _poCookies)
getCookies
in interface IhttpMessage
_poCookies
- The extent instance to populate with cookies.public object<? extends Cookie> getCookie(character _pcName)
getCookie
in interface IhttpMessage
getCookie
in interface IwebRequest
_pcName
- The cookie name.public void setCookie(object<? extends Cookie> _poCookie)
setCookie
in interface IhttpMessage
_poCookie
- The cookie to set.public logical hasCookie(object<? extends Cookie> _poCookie)
hasCookie
in interface IhttpMessage
_poCookie
- The cookie instance.public logical hasCookie(character _pcName)
hasCookie
in interface IhttpMessage
hasCookie
in interface IwebRequest
_pcName
- The cookie name.public void removeCookie(character _pcName)
removeCookie
in interface IhttpMessage
removeCookie
in interface IwebRequest
_pcName
- The cookie name.public void removeCookie(object<? extends Cookie> _poCookie)
removeCookie
in interface IhttpMessage
_poCookie
- The cookie instance.public void clearCookies()
clearCookies
in interface IhttpMessage
private java.lang.String emptyIfNull(java.lang.String val)
val
- The string.public void setCookies(object<? extends Cookie>[] _poCookies)
setCookies
in interface IhttpMessage
public void setHeaders(object<? extends HttpHeader>[] _poHeader)
setHeaders
in interface IhttpMessage
private void throwReadOnly(java.lang.String name)
private void throwNotImplementedMethod(java.lang.String name)
private void throwNotImplementedProperty(java.lang.String name)