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

java.lang.Object
- com.goldencode.p2j.main.ClientParameters

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable
```
public class ClientParameters
extends java.lang.Object
implements java.io.Externalizable
```
Container of client-side parameters which need to be exposed to the server-side application code.
This can be used for values that are effectively constants (set or queried at the time the client starts and then unchangable for the remainer of the client's lifetime). It is suitable for values that correspond to:
- Read-only environmental state that is exposed by the 4GL (e.g. SESSION:WINDOW-SYSTEM).
- 4GL command line option equivalents (e.g. -param).
- Operating system PID and userid.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`batchMode` The batch mode.
`java.lang.Integer`	`browserTimezone` The offset in minutes from UTC for the browser timezone.
`java.lang.String`	`browserWebSocket` The browser WebSocket address.
`boolean`	`chui` `true` if this client is ChUI, `false` for GUI.
`java.lang.Integer`	`clientTimezone` The offset in minutes from UTC for the client timezone.
`java.lang.String`	`driverName` Driver class name.
`boolean`	`embedded` `true` if this client is web embedded, `false` otherwise.
`java.lang.Long`	`ipCaptureTimestamp` The UTC timestamp of the capture time for `browserWebSocket`.
`boolean`	`isHeadless` `true` if this client is headless, `false` otherwise.
`java.lang.String`	`osDeviceId` The device ID from the OS in the client process
`java.lang.String`	`osUserName` User name as reported by the operating system.
`long`	`pid` Process ID (PID) of the client process as reported by the operating system.
`java.lang.String`	`propath` The propath parameter.
`java.lang.Integer`	`screenColorDepth` The client screen color depth.
`java.lang.Integer`	`screenHeight` The client screen height.
`java.lang.Float`	`screenScalingFactor` The client screen scaling factor.
`java.lang.Integer`	`screenWidth` The client screen width.
`java.lang.String`	`serverBaseUrl` The server base URL as given to spawn the web client.
`java.lang.String`	`socketTrustStoreFilename` Filename of client-side SSL certificate store.
`java.lang.String`	`socketTrustStorePassword` The password for access to client-side SSL certificate store.
`java.lang.String`	`storageId` The storage ID for the end-user (available with SSO)
`java.lang.String`	`terminalName` Terminal name as specified on the client command line.
`java.lang.String`	`userAgent` The user agent info of the browser where the js client runs.
`boolean`	`web` `true` if this client is web (embedded, gui, chui), `false` otherwise.
`int`	`webPort` The client web server port.
`java.lang.String`	`webRoot` The client web root path depending on how the client is spawned, it could be behind a proxy, direct, etc.
`static java.lang.String`	`WINDOW_SYSTEM_MS_WIN95` Constant identifying the "MS-WIN95" window-system.
`static java.lang.String`	`WINDOW_SYSTEM_MS_WINDOWS` Constant for the "MS-WINDOWS" window-system (GUI driver default).
`static java.lang.String`	`WINDOW_SYSTEM_MS_WINXP` Constant identifying the "MS-WINXP" window-system.
`static java.lang.String`	`WINDOW_SYSTEM_TTY` Constant for the "TTY" window-system (CHUI driver default).
`java.lang.String`	`windowSystem` Identify the SESSION:WINDOW-SYSTEM attribute used by this client.

Constructor Summary

Constructors
Constructor and Description

ClientParameters()

Constructors
Constructor and Description
`ClientParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`readExternal(java.io.ObjectInput in)` Replacement for the default object reading method.
`void`	`writeExternal(java.io.ObjectOutput out)` Replacement for the default object writing method.

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

- Field Detail
  - WINDOW_SYSTEM_TTY
```
public static final java.lang.String WINDOW_SYSTEM_TTY
```
    Constant for the "TTY" window-system (CHUI driver default).
    
    See Also:
    
    Constant Field Values
  - WINDOW_SYSTEM_MS_WINDOWS
```
public static final java.lang.String WINDOW_SYSTEM_MS_WINDOWS
```
    Constant for the "MS-WINDOWS" window-system (GUI driver default).
    
    See Also:
    
    Constant Field Values
  - WINDOW_SYSTEM_MS_WIN95
```
public static final java.lang.String WINDOW_SYSTEM_MS_WIN95
```
    Constant identifying the "MS-WIN95" window-system.
    
    See Also:
    
    Constant Field Values
  - WINDOW_SYSTEM_MS_WINXP
```
public static final java.lang.String WINDOW_SYSTEM_MS_WINXP
```
    Constant identifying the "MS-WINXP" window-system.
    
    See Also:
    
    Constant Field Values
  - windowSystem
```
public java.lang.String windowSystem
```
    Identify the SESSION:WINDOW-SYSTEM attribute used by this client.
  - osUserName
```
public java.lang.String osUserName
```
    User name as reported by the operating system.
  - terminalName
```
public java.lang.String terminalName
```
    Terminal name as specified on the client command line.
  - pid
```
public long pid
```
    Process ID (PID) of the client process as reported by the operating system.
  - webPort
```
public int webPort
```
    The client web server port.
  - driverName
```
public java.lang.String driverName
```
    Driver class name.
  - osDeviceId
```
public java.lang.String osDeviceId
```
    The device ID from the OS in the client process
  - storageId
```
public java.lang.String storageId
```
    The storage ID for the end-user (available with SSO)
  - chui
```
public boolean chui
```
    true if this client is ChUI, false for GUI.
  - web
```
public boolean web
```
    true if this client is web (embedded, gui, chui), false otherwise.
  - embedded
```
public boolean embedded
```
    true if this client is web embedded, false otherwise.
  - isHeadless
```
public boolean isHeadless
```
    true if this client is headless, false otherwise.
  - batchMode
```
public int batchMode
```
    The batch mode. 0 = none, 1 = batch on, 2/3 = batch forced (client:mode:batch=true)
  - socketTrustStoreFilename
```
public java.lang.String socketTrustStoreFilename
```
    Filename of client-side SSL certificate store. Default is trusted-cert.store from current directory.
  - socketTrustStorePassword
```
public java.lang.String socketTrustStorePassword
```
    The password for access to client-side SSL certificate store. Default is blank.
  - propath
```
public java.lang.String propath
```
    The propath parameter.
  - clientTimezone
```
public java.lang.Integer clientTimezone
```
    The offset in minutes from UTC for the client timezone.
  - browserWebSocket
```
public java.lang.String browserWebSocket
```
    The browser WebSocket address.
  - browserTimezone
```
public java.lang.Integer browserTimezone
```
    The offset in minutes from UTC for the browser timezone. Available with web sessions only.
  - ipCaptureTimestamp
```
public java.lang.Long ipCaptureTimestamp
```
    The UTC timestamp of the capture time for browserWebSocket. Available with web sessions only.
  - screenColorDepth
```
public java.lang.Integer screenColorDepth
```
    The client screen color depth. Currently implemented only for web sessions and represents the value accessible from the browser.
  - screenHeight
```
public java.lang.Integer screenHeight
```
    The client screen height. Currently implemented only for web sessions and represents the value accessible from the browser.
  - screenScalingFactor
```
public java.lang.Float screenScalingFactor
```
    The client screen scaling factor. Currently implemented only for web sessions and represents the value accessible from the browser.
  - screenWidth
```
public java.lang.Integer screenWidth
```
    The client screen width. Currently implemented only for web sessions and represents the value accessible from the browser.
  - userAgent
```
public java.lang.String userAgent
```
    The user agent info of the browser where the js client runs. Available with web sessions only.
  - serverBaseUrl
```
public java.lang.String serverBaseUrl
```
    The server base URL as given to spawn the web client. The URL may differ depending on how the client is spawned, it could be behind a proxy, direct, etc.
  - webRoot
```
public java.lang.String webRoot
```
    The client web root path depending on how the client is spawned, it could be behind a proxy, direct, etc.
- Constructor Detail
  - ClientParameters
```
public ClientParameters()
```
- Method Detail
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    Replacement for the default object writing method. The latest state is written to the output destination.
    
    Specified by:
    
    writeExternal in interface java.io.Externalizable
    
    Parameters:
    
    out - The output destination to which parameters will be saved.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
```
    Replacement for the default object reading method. The latest state is read from the input source.
    
    Specified by:
    
    readExternal in interface java.io.Externalizable
    
    Parameters:
    
    in - The input source from which parameters will be restored.
    
    Throws:
    
    java.io.IOException - In case of I/O errors.
    
    java.lang.ClassNotFoundException - If a parameter can't be instantiated.

Class ClientParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WINDOW_SYSTEM_TTY

WINDOW_SYSTEM_MS_WINDOWS

WINDOW_SYSTEM_MS_WIN95

WINDOW_SYSTEM_MS_WINXP

windowSystem

osUserName

terminalName

pid

webPort

driverName

osDeviceId

storageId

chui

web

embedded

isHeadless

batchMode

socketTrustStoreFilename

socketTrustStorePassword

propath

clientTimezone

browserWebSocket

browserTimezone

ipCaptureTimestamp

screenColorDepth

screenHeight

screenScalingFactor

screenWidth

userAgent

serverBaseUrl

webRoot

Constructor Detail

ClientParameters

Method Detail

writeExternal

readExternal