HttpMessage (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.oo.lang.BaseObject
- - com.goldencode.p2j.oo.net.http.HttpMessage

All Implemented Interfaces:

IAdaptable, ISupportInitialize, _BaseObject_, IhttpMessage

Direct Known Subclasses:

HttpRequest, HttpResponse
```
public class HttpMessage
extends BaseObject
implements IhttpMessage, ISupportInitialize, IAdaptable
```
Business logic (converted to Java from the 4GL source code in OpenEdge/Net/HTTP/HttpMessage.cls).

Field Summary

Fields
Modifier and Type	Field and Description
`private static ContextLocal<longchar>`	`_versions`
`private raw`	`contentMd5` An MD5 hash of the message's content.
`private object<? extends IStringKeyedMap>`	`cookies` Only cookies relevant to only this message (request or response)
`private object<? extends _BaseObject_>`	`entity` Object containing the response body/entity.
`private object<? extends HttpHeaderCollection>`	`headers` Holds headers for this message
`private character`	`transferEncoding` The message's Transfer-Encoding.
`private character`	`version` The HTTP version supported.

Constructor Summary

Constructors
Constructor and Description

HttpMessage()

Constructors
Constructor and Description
`HttpMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`__net_http_HttpMessage_constructor__()` Constructor.
`void`	`__net_http_HttpMessage_destructor__()` Destructor.
`void`	`__net_http_HttpMessage_execute__()` Execute method.
`void`	`clearCookies()` Removes all cookies from this message.
`void`	`clearHeaders()` Removes all headers from this message.
`void`	`destroy()` Destroy.
`object<? extends _BaseObject_>`	`getAdapter(object<? extends LegacyClass> _p1)` Returns an adapter for this message
`character`	`getCharacterEncoding()` Get the message's content encoding.
`integer`	`getContentLength()` Get the message content length.
`raw`	`getContentMd5()` Get an MD5 hash of the message's content.
`character`	`getContentType()` Get message content type.
`object<? extends Cookie>`	`getCookie(character _p1)` Returns a cookie by name from this message.
`protected object<? extends IStringKeyedMap>`	`getCookies()` Get cookies relevant to only this message (request or response).
`integer`	`getCookies(OutputExtentParameter<object<? extends Cookie>> _extpoCookies)` Returns all the cookies for this message.
`object<? extends _BaseObject_>`	`getEntity()` Get an object containing the message body/entity.
`object<? extends HttpHeader>`	`getHeader(character _p1)` Returns a named header.
`protected object<? extends HttpHeaderCollection>`	`getHeaders()` Get the headers of this message.
`integer`	`getHeaders(OutputExtentParameter<object<? extends HttpHeader>> _extp1)` Returns all the headers.
`character`	`getTransferEncoding()` Get the message's Transfer-Encoding.
`character`	`getVersion()` Get the HTTP version supported.
`logical`	`hasCookie(character _p1)` Indicates whether a cookie exists for this message.
`logical`	`hasCookie(object<? extends Cookie> _p1)` Indicates whether a cookie exists for this message.
`logical`	`hasHeader(character _p1)` Indicates whether a header exists for this message or not.
`void`	`initialize()` Initialize
`void`	`removeCookie(character _p1)` Removes coolies from this message for a given name.
`void`	`removeCookie(object<? extends Cookie> _p1)` Removes a cookie from this message.
`void`	`removeHeader(character _p1)` Removes all headers with a given name from the set of message headers.
`void`	`setCharacterEncoding(character _encoding)` Set the message's content encoding.
`void`	`setContentLength(integer _len)` Set the message content length.
`void`	`setContentMd5(raw _var)` Set an MD5 hash of the message's content.
`void`	`setContentType(character _ctype)` Set message content type.
`void`	`setCookie(object<? extends Cookie> _p1)` Adds a cookie to this message
`void`	`setCookies(object<? extends Cookie>[] poCookies)`
`void`	`setEntity(object<? extends _BaseObject_> _var)` Set an object containing the message body/entity.
`void`	`setHeader(object<? extends HttpHeader> _p1)` Adds header info to this message's collection of headers.
`void`	`setHeaders(object<? extends HttpHeader>[] poHeaders)`
`void`	`setTransferEncoding(character _var)` Set the message's Transfer-Encoding.
`void`	`setVersion(character _var)` Set the HTTP version supported.

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
  - _versions
```
private static ContextLocal<longchar> _versions
```
  - contentMd5
```
private raw contentMd5
```
    An MD5 hash of the message's content.
  - transferEncoding
```
private character transferEncoding
```
    The message's Transfer-Encoding.
  - version
```
private character version
```
    The HTTP version supported. Typically HTTP/1.1
  - headers
```
private object<? extends HttpHeaderCollection> headers
```
    Holds headers for this message
  - entity
```
private object<? extends _BaseObject_> entity
```
    Object containing the response body/entity.
  - cookies
```
private object<? extends IStringKeyedMap> cookies
```
    Only cookies relevant to only this message (request or response)
- Constructor Detail
  - HttpMessage
```
public HttpMessage()
```
- Method Detail
  - __net_http_HttpMessage_execute__
```
public void __net_http_HttpMessage_execute__()
```
    Execute method.
  - __net_http_HttpMessage_constructor__
```
protected void __net_http_HttpMessage_constructor__()
```
    Constructor.
  - __net_http_HttpMessage_destructor__
```
public void __net_http_HttpMessage_destructor__()
```
    Destructor.
  - getCharacterEncoding
```
public character getCharacterEncoding()
```
    Get the message's content encoding.
    
    Specified by:
    
    getCharacterEncoding in interface IhttpMessage
    
    Returns:
    
    the message's content encoding.
  - setCharacterEncoding
```
public void setCharacterEncoding(character _encoding)
```
    Set the message's content encoding.
    
    Specified by:
    
    setCharacterEncoding in interface IhttpMessage
    
    Parameters:
    
    _encoding - the message's content encoding.
  - getContentLength
```
public integer getContentLength()
```
    Get the message content length.
    
    Specified by:
    
    getContentLength in interface IhttpMessage
    
    Returns:
    
    the message content length.
  - setContentLength
```
public void setContentLength(integer _len)
```
    Set the message content length.
    
    Specified by:
    
    setContentLength in interface IhttpMessage
    
    Parameters:
    
    _len - the message content length.
  - getContentMd5
```
public raw getContentMd5()
```
    Get an MD5 hash of the message's content.
    
    Specified by:
    
    getContentMd5 in interface IhttpMessage
    
    Returns:
    
    an MD5 hash of the message's content.
  - setContentMd5
```
public void setContentMd5(raw _var)
```
    Set an MD5 hash of the message's content.
    
    Specified by:
    
    setContentMd5 in interface IhttpMessage
    
    Parameters:
    
    _var - an MD5 hash of the message's content.
  - getContentType
```
public character getContentType()
```
    Get message content type.
    
    Specified by:
    
    getContentType in interface IhttpMessage
    
    Returns:
    
    message content type.
  - setContentType
```
public void setContentType(character _ctype)
```
    Set message content type.
    
    Specified by:
    
    setContentType in interface IhttpMessage
    
    Parameters:
    
    _ctype - message content type.
  - getCookies
```
protected object<? extends IStringKeyedMap> getCookies()
```
    Get cookies relevant to only this message (request or response).
    
    Returns:
    
    cookies relevant to only this message (request or response).
  - getEntity
```
public object<? extends _BaseObject_> getEntity()
```
    Get an object containing the message body/entity.
    
    Specified by:
    
    getEntity in interface IhttpMessage
    
    Returns:
    
    an object containing the message body/entity.
  - setEntity
```
public void setEntity(object<? extends _BaseObject_> _var)
```
    Set an object containing the message body/entity.
    
    Specified by:
    
    setEntity in interface IhttpMessage
    
    Parameters:
    
    _var - an object containing the message body/entity.
  - getHeaders
```
protected object<? extends HttpHeaderCollection> getHeaders()
```
    Get the headers of this message.
    
    Returns:
    
    the headers of this message.
  - setHeaders
```
public void setHeaders(object<? extends HttpHeader>[] poHeaders)
```
    Specified by:
    
    setHeaders in interface IhttpMessage
  - getTransferEncoding
```
public character getTransferEncoding()
```
    Get the message's Transfer-Encoding.
    
    Specified by:
    
    getTransferEncoding in interface IhttpMessage
    
    Returns:
    
    the message's Transfer-Encoding.
  - setTransferEncoding
```
public void setTransferEncoding(character _var)
```
    Set the message's Transfer-Encoding.
    
    Specified by:
    
    setTransferEncoding in interface IhttpMessage
    
    Parameters:
    
    _var - the message's Transfer-Encoding.
  - getVersion
```
public character getVersion()
```
    Get the HTTP version supported.
    
    Specified by:
    
    getVersion in interface IhttpMessage
    
    Returns:
    
    the HTTP version supported.
  - setVersion
```
public void setVersion(character _var)
```
    Set the HTTP version supported.
    
    Specified by:
    
    setVersion in interface IhttpMessage
    
    Parameters:
    
    _var - the HTTP version supported.
  - clearCookies
```
public void clearCookies()
```
    Removes all cookies from this message.
    
    Specified by:
    
    clearCookies in interface IhttpMessage
  - clearHeaders
```
public void clearHeaders()
```
    Removes all headers from this message.
    
    Specified by:
    
    clearHeaders in interface IhttpMessage
  - destroy
```
public void destroy()
```
    Destroy.
    
    Specified by:
    
    destroy in interface ISupportInitialize
  - getAdapter
```
public object<? extends _BaseObject_> getAdapter(object<? extends LegacyClass> _p1)
```
    Returns an adapter for this message
    
    Specified by:
    
    getAdapter in interface IAdaptable
    
    Parameters:
    
    _p1 - The type we want to adapt this message to.
    
    Returns:
    
    The adapter. Will typically be of the type specified by the input argument.
  - getCookie
```
public object<? extends Cookie> getCookie(character _p1)
```
    Returns a cookie by name from this message.
    
    Specified by:
    
    getCookie in interface IhttpMessage
    
    Parameters:
    
    _p1 - The cookie's name to check.
    
    Returns:
    
    The (first) cookie found by name.
  - getCookies
```
public integer getCookies(OutputExtentParameter<object<? extends Cookie>> _extpoCookies)
```
    Returns all the cookies for this message.
    
    Specified by:
    
    getCookies in interface IhttpMessage
    
    Parameters:
    
    _extpoCookies - An array of cookies.
    
    Returns:
    
    The number of cookies returned.
  - getHeader
```
public object<? extends HttpHeader> getHeader(character _p1)
```
    Returns a named header.
    
    Specified by:
    
    getHeader in interface IhttpMessage
    
    Parameters:
    
    _p1 - The name of the header to retrieve.
    
    Returns:
    
    The header object. Null if not exists.
  - getHeaders
```
public integer getHeaders(OutputExtentParameter<object<? extends HttpHeader>> _extp1)
```
    Returns all the headers.
    
    Specified by:
    
    getHeaders in interface IhttpMessage
    
    Parameters:
    
    _extp1 - An array of headers.
    
    Returns:
    
    The number of headers returned.
  - hasCookie
```
public logical hasCookie(character _p1)
```
    Indicates whether a cookie exists for this message.
    
    Specified by:
    
    hasCookie in interface IhttpMessage
    
    Parameters:
    
    _p1 - The cookie's name to check.
    
    Returns:
    
    true if this message contains the cookie.
  - hasCookie
```
public logical hasCookie(object<? extends Cookie> _p1)
```
    Indicates whether a cookie exists for this message.
    
    Specified by:
    
    hasCookie in interface IhttpMessage
    
    Parameters:
    
    _p1 - The cookie to check.
    
    Returns:
    
    true if this message contains the cookie.
  - hasHeader
```
public logical hasHeader(character _p1)
```
    Indicates whether a header exists for this message or not.
    
    Specified by:
    
    hasHeader in interface IhttpMessage
    
    Parameters:
    
    _p1 - The name of a header to check.
    
    Returns:
    
    true if this message contains the header.
  - initialize
```
public void initialize()
```
    Initialize
    
    Specified by:
    
    initialize in interface ISupportInitialize
  - removeCookie
```
public void removeCookie(character _p1)
```
    Removes coolies from this message for a given name.
    
    Specified by:
    
    removeCookie in interface IhttpMessage
    
    Parameters:
    
    _p1 - The name of the cookie(s) to remove.
  - removeCookie
```
public void removeCookie(object<? extends Cookie> _p1)
```
    Removes a cookie from this message.
    
    Specified by:
    
    removeCookie in interface IhttpMessage
    
    Parameters:
    
    _p1 - The cookie to remove.
  - removeHeader
```
public void removeHeader(character _p1)
```
    Removes all headers with a given name from the set of message headers. No-op if none exists.
    
    Specified by:
    
    removeHeader in interface IhttpMessage
    
    Parameters:
    
    _p1 - The name of the header to remove.
  - setCookie
```
public void setCookie(object<? extends Cookie> _p1)
```
    Adds a cookie to this message
    
    Specified by:
    
    setCookie in interface IhttpMessage
    
    Parameters:
    
    _p1 - The cookie to add.
  - setCookies
```
public void setCookies(object<? extends Cookie>[] poCookies)
```
    Specified by:
    
    setCookies in interface IhttpMessage
  - setHeader
```
public void setHeader(object<? extends HttpHeader> _p1)
```
    Adds header info to this message's collection of headers.
    
    Specified by:
    
    setHeader in interface IhttpMessage
    
    Parameters:
    
    _p1 - The header.

Class HttpMessage

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_versions

contentMd5

transferEncoding

version

headers

entity

cookies

Constructor Detail

HttpMessage

Method Detail

__net_http_HttpMessage_execute__

__net_http_HttpMessage_constructor__

__net_http_HttpMessage_destructor__

getCharacterEncoding

setCharacterEncoding

getContentLength

setContentLength

getContentMd5

setContentMd5

getContentType

setContentType

getCookies

getEntity

setEntity

getHeaders

setHeaders

getTransferEncoding

setTransferEncoding

getVersion

setVersion

clearCookies

clearHeaders

destroy

getAdapter

getCookie

getCookies

getHeader

getHeaders

hasCookie

hasCookie

hasHeader

initialize

removeCookie

removeCookie

removeHeader

setCookie

setCookies

setHeader