HttpSession (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.http.HttpSession

All Implemented Interfaces:

ClientCommunicationInterface, SocketNameInterface
```
public class HttpSession
extends Object
implements ClientCommunicationInterface
```
The instance of a HTTP session.

Field Summary

Fields
Modifier and Type	Field and Description
`ClientSession`	`clientSession` The client session that this HTTP session is tied to (null if none).
`HttpUserEnvironment`	`environment` The user environment.
`int`	`errCode` The current error code (zero if none yet, or 200 if OK).
`String`	`errExtra` The current extra error text (empty string if none yet).
`String`	`errText` The current error text (empty string if none yet).
`Hashtable<String,String>`	`formData` The table of decoded form data in name/value pairs (or null if no posted data).
`String`	`fullServerName` The protocol, name and port of this server (http[s]://hostName[:port].
`HttpHeaderFields`	`headerFields` The header fields.
`static String`	`hexes` Hex characters.
`String`	`hostAddress` The address of this server.
`String`	`hostName` The name of this server.
`String`	`httpMethod` The HTTP method used (GET, POST or n/a).
`String`	`httpVersion` The http protocol version.
`boolean`	`isKeepAlive` Indicates that this connection is of keep-alive state.
`boolean`	`isReplyDataCgiGenerated` Boolean value that is set to true if the reply data is CGI-generated.
`HttpSession`	`previousHttpSession` The previous HTTP session (saved for the state-less communication).
`String`	`replyContentType` Reply Content-type (null is default).
`String`	`requestLine` The request line.
`HttpRequestParser`	`requestParser` The current request parser.
`HttpResource`	`resource` The current HTTP resource to be sent or that has been sent to the client (null if none).
`String`	`resourceName` The requested resource name.
`int`	`serverPort` The server port number.
`ServerSocketInterface`	`serverSocket` The server socket interface (null if none).
`Date`	`sessionEstablishedTime` Time when the session was first established.
`ISocket`	`socket` The current socket (null if none).
`String`	`uriParams` The URI parameters (after '?', may be null if not specified).
`AdminConfigWebApplication`	`webApplication` The web application data.
`HttpWebServer`	`webServer` The Web Server.

Constructor Summary

Constructors
Constructor and Description

HttpSession(HttpWebServer webServer)
Creates a new ....

Constructors
Constructor and Description
`HttpSession(HttpWebServer webServer)` Creates a new ....

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addReplyExtraHeader(String header)` Add reply extra header (from CGI).
`boolean`	`close()` Closes an open client connection.
`void`	`createConstAppAction()` Create constant AppAction session ID.
`void`	`createSessionCookie(HttpSession httpSetSession)` Creates and sets a cookie identification string to be used for this session and for further checks when new GET or POST data is sent from a client.
`void`	`createSingleSessionCookie(boolean doRemove)` Creates (or removes) a single-session special cookie.
`boolean`	`dispose()` The session is disposed of.
`boolean`	`doesCookieSessionMatch()` Verifies that the current session originates from a previously created cookie session identification string.
`String`	`getApplicationAction()` Get application action = server name + resource name + current digest code.
`BrowserCapabilities`	`getBrowserCapabilities()` Gets the browser capabilities.
`String`	`getClientDNSName()` Gets the DNS name of this client connection.
`InetAddress`	`getClientInetAddress()` Gets the address of the client or null if socket is not connected.
`String`	`getClientIPAddress()` Gets the IP address of this client connection (as 1.2.3.4).
`String`	`getConstAppAction()` Access the constant AppAction session ID.
`VirtualInterface`	`getControl(String id)` Gets a virtual "control" from an ID (can also be a menu item).
`int`	`getControlMaximumLength(String id)` Gets the control ID maximum length.
`String`	`getControlText(String id)` Gets the control ID text.
`String`	`getControlText(String id, int col, int row)` Gets the control ID text.
`String`	`getCurrentSequencedDigestCode()` Gets the session identifier digest code of the current sequence ID.
`String`	`getDigestCode()` Gets the session identifier digest code.
`String`	`getGlobalVariable(String name)` Gets a NetPhantom global variable.
`static char`	`getHex(int v)` Gets the hex representation of a number 0-15.
`String`	`getHostField(String name)` Gets the host field by name.
`String`	`getHostField(String name, int line)` Gets the host field by name.
`static long`	`getLongRandom()` Gets a random long value.
`HttpSession`	`getMessageDigestSession()` Gets the session used for message digests.
`String`	`getNextSequencedDigestCode()` Gets the session identifier digest code of the next sequence ID.
`Enumeration<String>`	`getReplyExtraHeaders()` Get reply extra headers (or null if none).
`String`	`getSecureLoginCookie(String resourceName)` Checks if there is a SecureLogin cookie set for this session.
`String`	`getSequenceID()` Access current sequence number (ID).
`InetAddress`	`getServerInetAddress()` Gets the address of the server or null if no connection exists.
`ServerSocketInterface`	`getServerSocket()` Gets the server socket interface associated with the accept of this socket.
`static HttpSession`	`getSession(String hashCode, boolean checkDigestCode)` Looks up an existing httpSession from a hash code.
`String`	`getSessionCookieID()` Get cookie session ID.
`boolean`	`getSetCookies(StringBuilder buf)` Gets the cookies set to send to the client for this session (if any).
`HttpSession`	`getSingleSessionForUser()` Gets the single-session cookie (if this is allowed).
`ISocket`	`getSocket()` Gets socket associated with this communication.
`String`	`getTextID(String id)` Gets a text ID from the current runtime application.
`String`	`getTranslatedHostField(String name)` Gets the host field by name after it has undergone translation using the application translation table.
`String`	`getTranslatedHostField(String name, int line)` Gets the host field by name after it has undergone translation using the application translation table.
`HashMap<String,String>`	`getURIParams()` Gets the URI parameters without regards to case.
`HashMap<String,String>`	`getURIParams(boolean keepCase)` Gets the URI parameters without regards to case.
`static HashMap<String,String>`	`getURIParams(String uriParams, boolean keepCase)` Parses the URI params.
`String`	`getVisibleControlText(String id, int col, int row)` Gets the control ID text.
`void`	`hardClose()` Hard-closes the current socket connection to the client.
`boolean`	`hasSessionTimedOut()` Checks if a session has been inactive for a certain amount of time.
`boolean`	`isCookieUsed()` Check if cookie is used.
`boolean`	`isHTTP10()` Checks if this HTTP session is of version 1.0 or lower.
`boolean`	`isHTTP11()` Checks if this HTTP session is of version 1.1 or higher.
`static String`	`md5Digest(MessageDigest md, String string)` MD5-Digests a String to a hex code.
`String`	`md5Digest(String string)` MD5-Digests a String to a hex code.
`byte[]`	`receiveTransaction()` Reads a transaction from the client.
`byte[]`	`receiveTransaction(Object[] isCompressed)` Reads a transaction from the client.
`void`	`removeSessionCookie()` Remove session cookie.
`void`	`saveSession()` Saves this session to be used for state-less HTTP communication.
`void`	`sendTransaction(byte[] data)` Sends a transaction to the client.
`void`	`sendTransaction(byte[] data, int type)` Sends a transaction to the client.
`void`	`setCookie(HttpCookie cookie)` Sets a cookie to send to the client.
`void`	`setSecureLoginCookie(String value, String resourceName)` Sets the SecureLogin cookie value for this session to a string.
`void`	`transferSession(HttpSession newSession)` Transfers control of a NetPhantom Application from the session specified as a parameter to an existing one.
`void`	`varDelete(String name)` Deletes a HTTP session variable.
`void`	`varDeleteAll()` Deletes all variables.
`String`	`varGet(String name)` Gets the contents of a HTTP session variable.
`void`	`varSet(String name, String data)` Sets a HTTP session variable.

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

- Field Detail
  - hexes
```
public static final String hexes
```
    Hex characters.
    
    See Also:
    
    Constant Field Values
  - isReplyDataCgiGenerated
```
public boolean isReplyDataCgiGenerated
```
    Boolean value that is set to true if the reply data is CGI-generated.
  - isKeepAlive
```
public boolean isKeepAlive
```
    Indicates that this connection is of keep-alive state. This flag is set when the reply has been generated by the HttpReply class.
  - replyContentType
```
public String replyContentType
```
    Reply Content-type (null is default).
  - webServer
```
public final HttpWebServer webServer
```
    The Web Server.
  - environment
```
public HttpUserEnvironment environment
```
    The user environment.
  - socket
```
public ISocket socket
```
    The current socket (null if none).
  - serverSocket
```
public ServerSocketInterface serverSocket
```
    The server socket interface (null if none).
  - hostName
```
public String hostName
```
    The name of this server.
  - hostAddress
```
public String hostAddress
```
    The address of this server.
  - serverPort
```
public int serverPort
```
    The server port number.
  - fullServerName
```
public String fullServerName
```
    The protocol, name and port of this server (http[s]://hostName[:port].
  - httpVersion
```
public String httpVersion
```
    The http protocol version.
  - requestLine
```
public String requestLine
```
    The request line.
  - httpMethod
```
public String httpMethod
```
    The HTTP method used (GET, POST or n/a).
  - uriParams
```
public String uriParams
```
    The URI parameters (after '?', may be null if not specified).
  - resourceName
```
public String resourceName
```
    The requested resource name.
  - headerFields
```
public HttpHeaderFields headerFields
```
    The header fields.
  - sessionEstablishedTime
```
public final Date sessionEstablishedTime
```
    Time when the session was first established.
  - errCode
```
public int errCode
```
    The current error code (zero if none yet, or 200 if OK).
  - errText
```
public String errText
```
    The current error text (empty string if none yet).
  - errExtra
```
public String errExtra
```
    The current extra error text (empty string if none yet). This text describes a problem in more detail.
  - formData
```
public Hashtable<String,String> formData
```
    The table of decoded form data in name/value pairs (or null if no posted data).
  - clientSession
```
public ClientSession clientSession
```
    The client session that this HTTP session is tied to (null if none).
  - previousHttpSession
```
public HttpSession previousHttpSession
```
    The previous HTTP session (saved for the state-less communication).
  - resource
```
public HttpResource resource
```
    The current HTTP resource to be sent or that has been sent to the client (null if none).
  - webApplication
```
public AdminConfigWebApplication webApplication
```
    The web application data.
  - requestParser
```
public HttpRequestParser requestParser
```
    The current request parser.
- Constructor Detail
  - HttpSession
```
public HttpSession(HttpWebServer webServer)
```
    Creates a new ....
- Method Detail
  - setCookie
```
public void setCookie(HttpCookie cookie)
```
    Sets a cookie to send to the client.
  - getSetCookies
```
public boolean getSetCookies(StringBuilder buf)
```
    Gets the cookies set to send to the client for this session (if any).
    
    Returns:
    
    true if any cookies were set.
  - isHTTP10
```
public boolean isHTTP10()
```
    Checks if this HTTP session is of version 1.0 or lower.
  - isHTTP11
```
public boolean isHTTP11()
```
    Checks if this HTTP session is of version 1.1 or higher.
  - varSet
```
public void varSet(String name,
                   String data)
```
    Sets a HTTP session variable. The name of the variable is always converted to upper case.
  - varGet
```
public String varGet(String name)
```
    Gets the contents of a HTTP session variable. If the variable is not found, null is returned. The name of the variable is always converted to upper case.
  - varDelete
```
public void varDelete(String name)
```
    Deletes a HTTP session variable. The name of the variable is always converted to upper case.
  - varDeleteAll
```
public void varDeleteAll()
```
    Deletes all variables.
  - getHostField
```
public String getHostField(String name)
```
    Gets the host field by name.
    
    Returns:
    
    null if no client session is found, empty string if not found.
  - getHostField
```
public String getHostField(String name,
                           int line)
```
    Gets the host field by name. The name is assumed to be in upper case.
    
    Returns:
    
    null if no client session is found or empty string if not found.
  - getTranslatedHostField
```
public String getTranslatedHostField(String name)
```
    Gets the host field by name after it has undergone translation using the application translation table.
    
    Returns:
    
    null if no client session or current runtime is found, empty string if not found.
  - getTranslatedHostField
```
public String getTranslatedHostField(String name,
                                     int line)
```
    Gets the host field by name after it has undergone translation using the application translation table.
    
    Returns:
    
    null if no client session or current runtime is found, empty string if not found.
  - getTextID
```
public String getTextID(String id)
```
    Gets a text ID from the current runtime application. The ID is assumed to be in upper case.
    
    Returns:
    
    null if no client session or current runtime is found, empty string if not found.
  - getControlMaximumLength
```
public int getControlMaximumLength(String id)
```
    Gets the control ID maximum length.
    
    Returns:
    
    -1 when no client session exists or the control is not found (or doesn't support it).
  - getControlText
```
public String getControlText(String id)
```
    Gets the control ID text.
    
    Returns:
    
    null if no client sessions exists, no runtime, no current panel or if the control cannot be found.
  - getControlText
```
public String getControlText(String id,
                             int col,
                             int row)
```
    Gets the control ID text. The row and col parameters should be set to -1 if they do not apply.
    The following combination of parameters apply:
```
 Parameter        Normal control  Combobox      List box
 ---------------  --------------  ------------  ------------------
 x and y omitted  text            text          n/a
 x omitted        n/a             line in list  n/a
 y omitted        n/a             n/a           Header column text
 both x,y         n/a             n/a           List box cell
 
```
    Note that the text for the control is returned even if it is not visible.
    Returns:
    
    null if no client sessions exists, no runtime, no current panel or if the control cannot be found.
  - getVisibleControlText
```
public String getVisibleControlText(String id,
                                    int col,
                                    int row)
```
    Gets the control ID text. The row and col parameters should be set to -1 if they do not apply.
    The following combination of parameters apply:
```
 Parameter        Normal control  Combobox      List box
 ---------------  --------------  ------------  ------------------
 x and y omitted  text            text          n/a
 x omitted        n/a             line in list  n/a
 y omitted        n/a             n/a           Header column text
 both x,y         n/a             n/a           List box cell
 
```
    Note that the text for the control is empty if the control is not visible.
    Returns:
    
    null if no client sessions exists, no runtime, no current panel or if the control cannot be found.
  - getControl
```
public VirtualInterface getControl(String id)
```
    Gets a virtual "control" from an ID (can also be a menu item).
    
    Returns:
    
    null if not found.
  - getGlobalVariable
```
public String getGlobalVariable(String name)
```
    Gets a NetPhantom global variable. The name of the variable is assumed to be in upper case.
    
    Returns:
    
    null if not found.
  - getClientDNSName
```
public String getClientDNSName()
```
    Gets the DNS name of this client connection. A return value of "null" indicates that there is no DNS name found.
    
    Specified by:
    
    getClientDNSName in interface SocketNameInterface
  - getClientIPAddress
```
public String getClientIPAddress()
```
    Gets the IP address of this client connection (as 1.2.3.4).
    
    Specified by:
    
    getClientIPAddress in interface SocketNameInterface
  - getDigestCode
```
public String getDigestCode()
```
    Gets the session identifier digest code.
  - getCurrentSequencedDigestCode
```
public String getCurrentSequencedDigestCode()
```
    Gets the session identifier digest code of the current sequence ID.
  - getNextSequencedDigestCode
```
public String getNextSequencedDigestCode()
```
    Gets the session identifier digest code of the next sequence ID.
  - getSequenceID
```
public String getSequenceID()
```
    Access current sequence number (ID).
  - md5Digest
```
public String md5Digest(String string)
```
    MD5-Digests a String to a hex code.
  - md5Digest
```
public static String md5Digest(MessageDigest md,
                               String string)
```
    MD5-Digests a String to a hex code.
  - getHex
```
public static char getHex(int v)
```
    Gets the hex representation of a number 0-15.
  - isCookieUsed
```
public boolean isCookieUsed()
```
    Check if cookie is used.
  - createSessionCookie
```
public void createSessionCookie(HttpSession httpSetSession)
```
    Creates and sets a cookie identification string to be used for this session and for further checks when new GET or POST data is sent from a client.
    Note: if the web application is not using cookies, this method will do nothing.
  - createSingleSessionCookie
```
public void createSingleSessionCookie(boolean doRemove)
```
    Creates (or removes) a single-session special cookie.
  - getSingleSessionForUser
```
public HttpSession getSingleSessionForUser()
```
    Gets the single-session cookie (if this is allowed).
    
    Returns:
    
    null if not found.
  - getSessionCookieID
```
public String getSessionCookieID()
```
    Get cookie session ID.
  - doesCookieSessionMatch
```
public boolean doesCookieSessionMatch()
```
    Verifies that the current session originates from a previously created cookie session identification string. This cookie should be sent by the browser.
    
    Returns:
    
    false if the session identifier doesn't match, the cookie is not sent or a previous cookie identifier has not been created for the session.
    true session matches with the cookie session identifier, or there is no check performed on the cookie for the application.
  - removeSessionCookie
```
public void removeSessionCookie()
```
    Remove session cookie.
  - getSecureLoginCookie
```
public String getSecureLoginCookie(String resourceName)
```
    Checks if there is a SecureLogin cookie set for this session.
    
    Returns:
    
    null for none, otherwise the contents.
  - setSecureLoginCookie
```
public void setSecureLoginCookie(String value,
                                 String resourceName)
```
    Sets the SecureLogin cookie value for this session to a string. If the string is null, the cookie will be removed at the client side.
  - getBrowserCapabilities
```
public BrowserCapabilities getBrowserCapabilities()
```
    Gets the browser capabilities. This is only done once for a session (for performance reasons). When a web application is running, these capabilities kept automatically.
  - saveSession
```
public void saveSession()
```
    Saves this session to be used for state-less HTTP communication.
  - getApplicationAction
```
public String getApplicationAction()
```
    Get application action = server name + resource name + current digest code.
  - createConstAppAction
```
public void createConstAppAction()
```
    Create constant AppAction session ID.
  - getConstAppAction
```
public String getConstAppAction()
```
    Access the constant AppAction session ID.
  - getSession
```
public static HttpSession getSession(String hashCode,
                                     boolean checkDigestCode)
```
    Looks up an existing httpSession from a hash code.
    
    Returns:
    
    null if the session is not found.
  - transferSession
```
public void transferSession(HttpSession newSession)
```
    Transfers control of a NetPhantom Application from the session specified as a parameter to an existing one.
  - getMessageDigestSession
```
public HttpSession getMessageDigestSession()
```
    Gets the session used for message digests.
  - dispose
```
public boolean dispose()
```
    The session is disposed of.
  - hasSessionTimedOut
```
public boolean hasSessionTimedOut()
```
    Checks if a session has been inactive for a certain amount of time.
  - getClientInetAddress
```
public InetAddress getClientInetAddress()
```
    Gets the address of the client or null if socket is not connected.
    
    Specified by:
    
    getClientInetAddress in interface ClientCommunicationInterface
  - getServerInetAddress
```
public InetAddress getServerInetAddress()
```
    Gets the address of the server or null if no connection exists.
    
    Specified by:
    
    getServerInetAddress in interface ClientCommunicationInterface
  - receiveTransaction
```
public byte[] receiveTransaction()
```
    Reads a transaction from the client. This call is blocking until the transaction has been read. This function always returns null.
    
    Specified by:
    
    receiveTransaction in interface ClientCommunicationInterface
  - receiveTransaction
```
public byte[] receiveTransaction(Object[] isCompressed)
```
    Reads a transaction from the client. This call is blocking until the transaction has been read. This function always returns null.
    
    Specified by:
    
    receiveTransaction in interface ClientCommunicationInterface
  - sendTransaction
```
public void sendTransaction(byte[] data)
```
    Sends a transaction to the client. This call is blocking until the transaction has been sent.
    
    Specified by:
    
    sendTransaction in interface ClientCommunicationInterface
  - sendTransaction
```
public void sendTransaction(byte[] data,
                            int type)
```
    Sends a transaction to the client. This call is blocking until the transaction has been sent. The type of message to send is 0=uncompressed binary, 1=compressed binary and 2=UTF-8 text (for WebSocket).
    
    Specified by:
    
    sendTransaction in interface ClientCommunicationInterface
  - close
```
public boolean close()
```
    Closes an open client connection. In this case it does nothing, the HttpRequestParser does the processing.
    
    Specified by:
    
    close in interface ClientCommunicationInterface
    
    Returns:
    
    true if the close operation completed with flushing potential data, false otherwise.
  - hardClose
```
public void hardClose()
```
    Hard-closes the current socket connection to the client.
    
    Specified by:
    
    hardClose in interface ClientCommunicationInterface
  - getSocket
```
public ISocket getSocket()
```
    Gets socket associated with this communication.
    
    Specified by:
    
    getSocket in interface ClientCommunicationInterface
    
    Returns:
    
    null if no socket is available.
  - getServerSocket
```
public ServerSocketInterface getServerSocket()
```
    Gets the server socket interface associated with the accept of this socket.
    
    Specified by:
    
    getServerSocket in interface ClientCommunicationInterface
    
    Returns:
    
    null if no server socket is available.
  - addReplyExtraHeader
```
public void addReplyExtraHeader(String header)
```
    Add reply extra header (from CGI).
  - getReplyExtraHeaders
```
public Enumeration<String> getReplyExtraHeaders()
```
    Get reply extra headers (or null if none).
  - getLongRandom
```
public static long getLongRandom()
```
    Gets a random long value.
  - getURIParams
```
public static HashMap<String,String> getURIParams(String uriParams,
                                                  boolean keepCase)
```
    Parses the URI params.
    
    Parameters:
    
    uriParams - the URI parameters to parse, null for none.
    
    keepCase - If every parameter is case sensitive, otherwise they are converted to lower case.
    
    Returns:
    
    A map that may contain null values if no value was specified for the parameter.
  - getURIParams
```
public HashMap<String,String> getURIParams()
```
    Gets the URI parameters without regards to case.
    
    Returns:
    
    A map that may contain null values if no value was specified for the parameter.
  - getURIParams
```
public HashMap<String,String> getURIParams(boolean keepCase)
```
    Gets the URI parameters without regards to case.
    
    Parameters:
    
    keepCase - If every parameter is case sensitive, otherwise they are converted to lower case.
    
    Returns:
    
    A map that may contain null values if no value was specified for the parameter.

Class HttpSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hexes

isReplyDataCgiGenerated

isKeepAlive

replyContentType

webServer

environment

socket

serverSocket

hostName

hostAddress

serverPort

fullServerName

httpVersion

requestLine

httpMethod

uriParams

resourceName

headerFields

sessionEstablishedTime

errCode

errText

errExtra

formData

clientSession

previousHttpSession

resource

webApplication

requestParser

Constructor Detail

HttpSession

Method Detail

setCookie

getSetCookies

isHTTP10

isHTTP11

varSet

varGet

varDelete

varDeleteAll

getHostField

getHostField

getTranslatedHostField

getTranslatedHostField

getTextID

getControlMaximumLength

getControlText

getControlText

getVisibleControlText

getControl

getGlobalVariable

getClientDNSName

getClientIPAddress

getDigestCode

getCurrentSequencedDigestCode

getNextSequencedDigestCode

getSequenceID

md5Digest

md5Digest

getHex

isCookieUsed

createSessionCookie

createSingleSessionCookie

getSingleSessionForUser

getSessionCookieID

doesCookieSessionMatch

removeSessionCookie

getSecureLoginCookie

setSecureLoginCookie

getBrowserCapabilities

saveSession

getApplicationAction

createConstAppAction

getConstAppAction

getSession