com.goldencode.p2j.oo.web

Class RemoteWebRequest

java.lang.Object

com.goldencode.p2j.oo.lang.BaseObject

com.goldencode.p2j.oo.web.RemoteWebRequest

All Implemented Interfaces:

_BaseObject_, IhttpMessage, IhttpRequest, IwebRequest

public class RemoteWebRequest
extends BaseObject
implements IwebRequest

A wrapper over a HttpServletRequest instance, to expose it as a legacy IwebRequest.

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
RemoteWebRequest()

Method Summary

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)

Methods inherited from class com.goldencode.p2j.oo.lang.BaseObject

__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, assertNotNull, assertNotNull, getLegacyClass, getNextSibling, getPrevSibling, legacyClone, legacyEquals, toLegacyString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.oo.lang._BaseObject_

__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, getLegacyClass, getNextSibling, getPrevSibling, isTracked, legacyClone, legacyEquals, toLegacyString

Field Detail

UNSUPPORTED_CGI_VAR

private static final java.lang.Object UNSUPPORTED_CGI_VAR

A marker for unsupported CGI_VARS.

CGI_VARS

private static final 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.

basepath

private java.lang.String basepath

The base path for this request.

target

private java.lang.String target

The target path for this request.

request

private javax.servlet.http.HttpServletRequest request

The servlet request.

paths

private java.lang.String[] paths

The paths for this request, as configured at the handler.

contentMD5

private raw contentMD5

The MD5 hash of body

entity

private object<? extends _BaseObject_> entity

The body entity.

Constructor Detail

RemoteWebRequest

public RemoteWebRequest()

Method Detail

__web_RemoteWebRequest_execute__

public void __web_RemoteWebRequest_execute__()

The execute method to initialize the FWD-related state for an instance.

__web_RemoteWebRequest_constructor__

public void __web_RemoteWebRequest_constructor__()

Default constructor.

_initialize

private boolean _initialize()

Initialize this instance with the specified details. Web context is fetch from WebHandler's context for now.

getMethod

public character getMethod()

Get the HTTP method.

Specified by:

getMethod in interface IhttpRequest

Returns:

the HTTP method.

setMethod

public void setMethod(character method)

Set the HTTP method. This is read-only.

Specified by:

setMethod in interface IhttpRequest

Parameters:

method - the HTTP method.

getUri

public object<? extends Uri> getUri()

Get the HTTP URI.

Specified by:

getUri in interface IhttpRequest

Returns:

the HTTP URI.

setUri

public void setUri(object<? extends Uri> uri)

Set the HTTP URI. This is read-only.

Specified by:

setUri in interface IhttpRequest

Parameters:

uri - the HTTP URI.

getCharacterEncoding

public character getCharacterEncoding()

Get the character encoding.

Specified by:

getCharacterEncoding in interface IhttpMessage

Returns:

See above.

setCharacterEncoding

public void setCharacterEncoding(character _encoding)

Set the character encoding. This is read-only.

Specified by:

setCharacterEncoding in interface IhttpMessage

Parameters:

_encoding - The character encoding.

getContentLength

public integer getContentLength()

Get the content length.

Specified by:

getContentLength in interface IhttpMessage

Returns:

See above.

setContentLength

public void setContentLength(integer _var)

Set the content length. This is read-only.

Specified by:

setContentLength in interface IhttpMessage

Parameters:

_var - The content length.

getContentMd5

public raw getContentMd5()

Get the content MD5.

Specified by:

getContentMd5 in interface IhttpMessage

Returns:

See above.

setContentMd5

public void setContentMd5(raw _var)

Set the content MD5. This is not implemented.

Specified by:

setContentMd5 in interface IhttpMessage

Parameters:

_var - The content MD5.

getContentType

public character getContentType()

Get the content type.

Specified by:

getContentType in interface IhttpMessage

Returns:

See above.

setContentType

public void setContentType(character _var)

Set the content type. This is read-only.

Specified by:

setContentType in interface IhttpMessage

Parameters:

_var - The content type.

getEntity

public object<? extends _BaseObject_> getEntity()

Get the body entity.

Specified by:

getEntity in interface IhttpMessage

Returns:

See above.

setEntity

public void setEntity(object<? extends _BaseObject_> _var)

Set the body entity. This is a read-only.

Specified by:

setEntity in interface IhttpMessage

Parameters:

_var - The body entity.

getTransferEncoding

public character getTransferEncoding()

Get the transfer encoding.

Specified by:

getTransferEncoding in interface IhttpMessage

Returns:

See above.

setTransferEncoding

public void setTransferEncoding(character transferEncoding)

Set the transfer encoding. This is read-only.

Specified by:

setTransferEncoding in interface IhttpMessage

Parameters:

transferEncoding - The transfer encoding.

getVersion

public character getVersion()

Get the HTTP version.

Specified by:

getVersion in interface IhttpMessage

Returns:

See above.

setVersion

public void setVersion(character version)

Set the HTTP version. This is read-only.

Specified by:

setVersion in interface IhttpMessage

Parameters:

version - The HTTP version.

clearHeaders

public void clearHeaders()

Clear the headers. This is not implemented.

Specified by:

clearHeaders in interface IhttpMessage

getHeader

public object<? extends HttpHeader> getHeader(character _pcName)

Get the specified header's value.

Specified by:

getHeader in interface IhttpMessage

Parameters:

_pcName - The header name.

Returns:

The header object. Null if not exists.

getHeaders

public integer getHeaders(OutputExtentParameter<object<? extends HttpHeader>> _poHeaders)

Populate the specified extent variable with all the headers.

Specified by:

getHeaders in interface IhttpMessage

Parameters:

_poHeaders - The header array.

Returns:

The number of read headers.

hasHeader

public logical hasHeader(character _pcName)

Check if the specified header name exists.

Specified by:

hasHeader in interface IhttpMessage

Parameters:

_pcName - The header name.

Returns:

See above.

removeHeader

public void removeHeader(character _pcName)

Remove the specified header. This is not implemented.

Specified by:

removeHeader in interface IhttpMessage

Parameters:

_pcName - The header name.

setHeader

public void setHeader(object<? extends HttpHeader> _poHeader)

Set the specified header. This is not implemented.

Specified by:

setHeader in interface IhttpMessage

Parameters:

_poHeader - The header instance.

setHeader

public object<? extends HttpHeader> setHeader(character _pcName,
                                              character _pcValue)

Set the specified header. This is not implemented.

Parameters:

_pcName - The header name.

_pcValue - The header value.

Returns:

see above

getResolvedWebAppPath

public character getResolvedWebAppPath()

Resolve the web app path.

Specified by:

getResolvedWebAppPath in interface IwebRequest

Returns:

The servlet path.

getContextNames

public character getContextNames()

Get the context names. This returns all CGI_VARS keys.

Specified by:

getContextNames in interface IwebRequest

Returns:

A comma-separated list of CGI var names.

getDefaultCookieDomain

public character getDefaultCookieDomain()

Get the default cookie domain.

Specified by:

getDefaultCookieDomain in interface IwebRequest

Returns:

See above.

getDefaultCookiePath

public character getDefaultCookiePath()

Get the default cookie path.

Specified by:

getDefaultCookiePath in interface IwebRequest

Returns:

See above.

getLocalAddress

public character getLocalAddress()

Get the local address.

Specified by:

getLocalAddress in interface IwebRequest

Returns:

See above.

getLocalHost

public character getLocalHost()

Get the local host.

Specified by:

getLocalHost in interface IwebRequest

Returns:

See above.

getLocalPort

public integer getLocalPort()

Get the local port.

Specified by:

getLocalPort in interface IwebRequest

Returns:

See above.

getPathInfo

public character getPathInfo()

Get the path information.

Specified by:

getPathInfo in interface IwebRequest

Returns:

See above.

_getPathInfo

protected java.lang.String _getPathInfo()

getPathParameterNames

public character getPathParameterNames()

Get the path parameter names.

Specified by:

getPathParameterNames in interface IwebRequest

Returns:

See above.

getRemoteAddress

public character getRemoteAddress()

Get the remote address.

Specified by:

getRemoteAddress in interface IwebRequest

Returns:

See above.

getRemoteHost

public character getRemoteHost()

Get the remote host.

Specified by:

getRemoteHost in interface IwebRequest

Returns:

See above.

getRemotePort

public integer getRemotePort()

Get the remote port.

Specified by:

getRemotePort in interface IwebRequest

Returns:

See above.

getRemoteUser

public character getRemoteUser()

Get the remote user.

Specified by:

getRemoteUser in interface IwebRequest

Returns:

See above.

getResolvedTransportPath

public character getResolvedTransportPath()

Get the resolved transport path.

Specified by:

getResolvedTransportPath in interface IwebRequest

Returns:

Always empty string.

getServerSoftware

public character getServerSoftware()

Get the server software info.

Specified by:

getServerSoftware in interface IwebRequest

Returns:

See above.

getTransportPath

public character getTransportPath()

Get the transport path.

Specified by:

getTransportPath in interface IwebRequest

Returns:

The basepath.

getUriTemplate

public character getUriTemplate()

Get the URI template.

Specified by:

getUriTemplate in interface IwebRequest

Returns:

See above.

getWebAppPath

public character getWebAppPath()

Get the servlet path.

Specified by:

getWebAppPath in interface IwebRequest

Returns:

See above.

getContextValue

public longchar getContextValue(character _pcName)

Get the context value with the specified name.

Specified by:

getContextValue in interface IwebRequest

Parameters:

_pcName - The context name.

Returns:

The context value.

getPathParameter

public character getPathParameter(character _pcName)

Get the path parameter value, with the specified name.

Specified by:

getPathParameter in interface IwebRequest

Parameters:

_pcName - The path parameter name.

Returns:

See above.

getCookies

public integer getCookies(OutputExtentParameter<object<? extends Cookie>> _poCookies)

Get the request cookies.

Specified by:

getCookies in interface IhttpMessage

Parameters:

_poCookies - The extent instance to populate with cookies.

Returns:

The number of found cookies.

getCookie

public object<? extends Cookie> getCookie(character _pcName)

Get the cookie with the specified name.

Specified by:

getCookie in interface IhttpMessage

Specified by:

getCookie in interface IwebRequest

Parameters:

_pcName - The cookie name.

Returns:

The cookie instance.

_getCookie

private object<? extends Cookie> _getCookie(javax.servlet.http.Cookie cookie)

setCookie

public void setCookie(object<? extends Cookie> _poCookie)

Set or add the specified cookie. This is a no-op.

Specified by:

setCookie in interface IhttpMessage

Parameters:

_poCookie - The cookie to set.

hasCookie

public logical hasCookie(object<? extends Cookie> _poCookie)

Check if the specified cookie exists in the request.

Specified by:

hasCookie in interface IhttpMessage

Parameters:

_poCookie - The cookie instance.

Returns:

See above.

hasCookie

public logical hasCookie(character _pcName)

Check if the specified cookie exists in the request.

Specified by:

hasCookie in interface IhttpMessage

Specified by:

hasCookie in interface IwebRequest

Parameters:

_pcName - The cookie name.

Returns:

See above.

removeCookie

public void removeCookie(character _pcName)

Remove the specified cookie. This is not implemented.

Specified by:

removeCookie in interface IhttpMessage

Specified by:

removeCookie in interface IwebRequest

Parameters:

_pcName - The cookie name.

removeCookie

public void removeCookie(object<? extends Cookie> _poCookie)

Remove the specified cookie. This is a no-op.

Specified by:

removeCookie in interface IhttpMessage

Parameters:

_poCookie - The cookie instance.

clearCookies

public void clearCookies()

Clear all cookies. This is a no-op.

Specified by:

clearCookies in interface IhttpMessage

emptyIfNull

private java.lang.String emptyIfNull(java.lang.String val)

Return the empty value for a null string.

Parameters:

val - The string.

Returns:

See above.

setCookies

public void setCookies(object<? extends Cookie>[] _poCookies)

Specified by:

setCookies in interface IhttpMessage

setHeaders

public void setHeaders(object<? extends HttpHeader>[] _poHeader)

Specified by:

setHeaders in interface IhttpMessage

throwReadOnly

private void throwReadOnly(java.lang.String name)

throwNotImplementedMethod

private void throwNotImplementedMethod(java.lang.String name)

throwNotImplementedProperty

private void throwNotImplementedProperty(java.lang.String name)