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

java.lang.Object
- com.goldencode.p2j.util.AppServerDefinition

```
public class AppServerDefinition
extends java.lang.Object
```
A container of all the settings of an appservers. Access to the getters and setters is synchronized, so that in case the setting is changed/refreshed by another thread, concurrent access is safe.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`activate` The activate procedure; may be null/empty.
`private java.lang.String`	`appServer` The appserver's name.
`private java.lang.Integer`	`autoTrimTimeout` The number of seconds waiting before auto-trimming the agents, if they exceed the minimum capacity.
`private java.lang.String`	`connect` The connect procedure; may be null/empty.
`private java.lang.String`	`deactivate` The deactivate procedure; may be null/empty.
`private static java.util.Map<java.lang.String,AppServerDefinition>`	`definitions` A map of all initialized appserver definitions.
`private java.lang.String`	`disconnect` The disconnect procedure; may be null/empty.
`private java.lang.Integer`	`initialAgents` The number of agents to start initially.
`private static CentralLogger`	`LOG` Logger.
`private java.lang.Integer`	`maxAgents` The maximum number of agents which can be alive.
`private java.lang.Integer`	`minAgents` The minimum number of agents required for this appserver.
`private AppServerOperatingMode`	`operatingMode` The appserver's operating mode.
`private java.lang.Boolean`	`pasoe` Flag indicating if this is a PASOE appserver.
`private java.lang.String`	`projectToken` The project token.
`private java.lang.String`	`propath` Appserver's explicit propath.
`private java.util.Map<java.lang.String,java.lang.String>`	`properties` Environment settings incoming from progress.ini, global per appserver.
`private java.lang.Integer`	`requestTimeout` The amount of time (in seconds) to wait for an agent to be available, before attempting to auto-start a new one.
`private java.lang.String`	`shutdown` The shutdown procedure; may be null/empty.
`private java.lang.String`	`startup` The startup procedure; may be null/empty.
`private java.lang.String`	`startupParameter` The parameter for the startup procedure; may be null/empty.

Constructor Summary

Constructors
Modifier Constructor and Description

private AppServerDefinition(java.lang.String appServer)
Read the definition for the given appserver, and save it in this instance.

Constructors
Modifier	Constructor and Description
`private`	`AppServerDefinition(java.lang.String appServer)` Read the definition for the given appserver, and save it in this instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AppServerDefinition`	`get(java.lang.String appServer)` Get the settings for the specified appserver.
`java.lang.String`	`getActivate()` Getter for the `activate` field.
`java.lang.String`	`getAppServer()` Getter for the `appServer` field.
`java.lang.Integer`	`getAutoTrimTimeout()` Getter for the `autoTrimTimeout` field.
`java.lang.String`	`getConnect()` Getter for the `connect` field.
`java.lang.String`	`getDeactivate()` Getter for the `deactivate` field.
`java.lang.String`	`getDisconnect()` Getter for the `disconnect` field.
`java.lang.Integer`	`getInitialAgents()` Getter for the `initialAgents` field.
`java.lang.Integer`	`getMaxAgents()` Getter for the `maxAgents` field.
`java.lang.Integer`	`getMinAgents()` Getter for the `minAgents` field.
`AppServerOperatingMode`	`getOperatingMode()` Getter for the `operatingMode` field.
`java.lang.String`	`getProjectToken()` Get the project token that this agent serves.
`java.lang.String`	`getPropath()` Getter for the `propath` field.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Getter for `properties` properties.
`java.lang.Integer`	`getRequestTimeout()` Getter for the `requestTimeout` field.
`java.lang.String`	`getShutdown()` Getter for the `shutdown` field.
`java.lang.String`	`getStartup()` Getter for the `startup` field.
`java.lang.String`	`getStartupParameter()` Getter for the `startupParameter` field.
`boolean`	`isPasoe()` Check if this appserver definition is for PASOE.
`boolean`	`isSessionFree()` Get the Session-free state of this appserver `operatingMode`.
`void`	`refresh()` Refresh this appserver instance from the directory.
`(package private) static void`	`remove(java.lang.String appServer)` Remove the definition for the given appserver.
`void`	`setActivate(java.lang.String activate)` Setter for the `activate` field.
`void`	`setAppServer(java.lang.String appServer)` Setter for the `appServer` field.
`void`	`setAutoTrimTimeout(java.lang.Integer autoTrimTimeout)` Setter for the `autoTrimTimeout` field.
`void`	`setConnect(java.lang.String connect)` Setter for the `connect` field.
`void`	`setDeactivate(java.lang.String deactivate)` Setter for the `deactivate` field.
`void`	`setDisconnect(java.lang.String disconnect)` Setter for the `disconnect` field.
`void`	`setInitialAgents(java.lang.Integer initialAgents)` Setter for the `initialAgents` field.
`void`	`setMaxAgents(java.lang.Integer maxAgents)` Setter for the `maxAgents` field.
`void`	`setMinAgents(java.lang.Integer minAgents)` Setter for the `minAgents` field.
`void`	`setOperatingMode(AppServerOperatingMode operatingMode)` Setter for the `operatingMode` field.
`void`	`setPropath(java.lang.String propath)` Setter for the `propath` field.
`void`	`setRequestTimeout(java.lang.Integer requestTimeout)` Setter for the `requestTimeout` field.
`void`	`setShutdown(java.lang.String shutdown)` Setter for the `shutdown` field.
`void`	`setStartup(java.lang.String startup)` Setter for the `startup` field.
`void`	`setStartupParameter(java.lang.String startupParameter)` Setter for the `startupParameter` field.

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

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    Logger.
  - definitions
```
private static final java.util.Map<java.lang.String,AppServerDefinition> definitions
```
    A map of all initialized appserver definitions.
  - appServer
```
private java.lang.String appServer
```
    The appserver's name.
  - pasoe
```
private java.lang.Boolean pasoe
```
    Flag indicating if this is a PASOE appserver.
  - operatingMode
```
private AppServerOperatingMode operatingMode
```
    The appserver's operating mode.
  - requestTimeout
```
private java.lang.Integer requestTimeout
```
    The amount of time (in seconds) to wait for an agent to be available, before attempting to auto-start a new one.
  - autoTrimTimeout
```
private java.lang.Integer autoTrimTimeout
```
    The number of seconds waiting before auto-trimming the agents, if they exceed the minimum capacity.
  - propath
```
private java.lang.String propath
```
    Appserver's explicit propath.
  - initialAgents
```
private java.lang.Integer initialAgents
```
    The number of agents to start initially.
  - minAgents
```
private java.lang.Integer minAgents
```
    The minimum number of agents required for this appserver.
  - maxAgents
```
private java.lang.Integer maxAgents
```
    The maximum number of agents which can be alive.
  - activate
```
private java.lang.String activate
```
    The activate procedure; may be null/empty.
  - deactivate
```
private java.lang.String deactivate
```
    The deactivate procedure; may be null/empty.
  - connect
```
private java.lang.String connect
```
    The connect procedure; may be null/empty.
  - disconnect
```
private java.lang.String disconnect
```
    The disconnect procedure; may be null/empty.
  - startup
```
private java.lang.String startup
```
    The startup procedure; may be null/empty.
  - shutdown
```
private java.lang.String shutdown
```
    The shutdown procedure; may be null/empty.
  - startupParameter
```
private java.lang.String startupParameter
```
    The parameter for the startup procedure; may be null/empty.
  - projectToken
```
private java.lang.String projectToken
```
    The project token. Will be set on the context deserving the app-server.
  - properties
```
private java.util.Map<java.lang.String,java.lang.String> properties
```
    Environment settings incoming from progress.ini, global per appserver. The spawner will set these into the OS environment directly, before launching the child process.
- Constructor Detail
  - AppServerDefinition
```
private AppServerDefinition(java.lang.String appServer)
```
    Read the definition for the given appserver, and save it in this instance.
    
    Parameters:
    
    appServer - The application's server name.
    
    Throws:
    
    java.lang.IllegalArgumentException - If no appserver (with the given name) is configured in the directory.
- Method Detail
  - get
```
public static AppServerDefinition get(java.lang.String appServer)
```
    Get the settings for the specified appserver. If not yet initialized, it will read the settings for the appserver from the directory. The created instance will be shared by all parties.
    The initial call (which creates the instance) must be coming from a thread with its context authorized to access the appservers node for the P2J server.
    
    Parameters:
    
    appServer - The name of the appserver.
    
    Returns:
    
    The instance containing the settings for the specified appserver.
  - remove
```
static void remove(java.lang.String appServer)
```
    Remove the definition for the given appserver.
    
    Parameters:
    
    appServer - The appserver name.
  - refresh
```
public void refresh()
```
    Refresh this appserver instance from the directory. Must be called from threads which have their context authorized to access the appservers node for the P2J server.
  - getAppServer
```
public java.lang.String getAppServer()
```
    Getter for the appServer field.
    
    Returns:
    
    See above.
  - setAppServer
```
public void setAppServer(java.lang.String appServer)
```
    Setter for the appServer field.
    
    Parameters:
    
    appServer - The new value for the appServer field.
  - isPasoe
```
public boolean isPasoe()
```
    Check if this appserver definition is for PASOE.
    
    Returns:
    
    See above.
  - isSessionFree
```
public boolean isSessionFree()
```
    Get the Session-free state of this appserver operatingMode.
    
    Returns:
    
    true only if the operatingMode is AppServerOperatingMode.STATE_FREE.
  - getOperatingMode
```
public AppServerOperatingMode getOperatingMode()
```
    Getter for the operatingMode field.
    
    Returns:
    
    See above.
  - setOperatingMode
```
public void setOperatingMode(AppServerOperatingMode operatingMode)
```
    Setter for the operatingMode field.
    
    Parameters:
    
    operatingMode - The new value for the operatingMode field.
  - getRequestTimeout
```
public java.lang.Integer getRequestTimeout()
```
    Getter for the requestTimeout field.
    
    Returns:
    
    See above.
  - setRequestTimeout
```
public void setRequestTimeout(java.lang.Integer requestTimeout)
```
    Setter for the requestTimeout field.
    
    Parameters:
    
    requestTimeout - The new value for the requestTimeout field.
  - getAutoTrimTimeout
```
public java.lang.Integer getAutoTrimTimeout()
```
    Getter for the autoTrimTimeout field.
    
    Returns:
    
    See above.
  - setAutoTrimTimeout
```
public void setAutoTrimTimeout(java.lang.Integer autoTrimTimeout)
```
    Setter for the autoTrimTimeout field.
    
    Parameters:
    
    autoTrimTimeout - The new value for the autoTrimTimeout field.
  - getPropath
```
public java.lang.String getPropath()
```
    Getter for the propath field.
    
    Returns:
    
    See above.
  - setPropath
```
public void setPropath(java.lang.String propath)
```
    Setter for the propath field.
    
    Parameters:
    
    propath - The new value for the propath field.
  - getInitialAgents
```
public java.lang.Integer getInitialAgents()
```
    Getter for the initialAgents field.
    
    Returns:
    
    See above.
  - setInitialAgents
```
public void setInitialAgents(java.lang.Integer initialAgents)
```
    Setter for the initialAgents field.
    
    Parameters:
    
    initialAgents - The new value for the initialAgents field.
  - getMinAgents
```
public java.lang.Integer getMinAgents()
```
    Getter for the minAgents field.
    
    Returns:
    
    See above.
  - setMinAgents
```
public void setMinAgents(java.lang.Integer minAgents)
```
    Setter for the minAgents field.
    
    Parameters:
    
    minAgents - The new value for the minAgents field.
  - getMaxAgents
```
public java.lang.Integer getMaxAgents()
```
    Getter for the maxAgents field.
    
    Returns:
    
    See above.
  - setMaxAgents
```
public void setMaxAgents(java.lang.Integer maxAgents)
```
    Setter for the maxAgents field.
    
    Parameters:
    
    maxAgents - The new value for the maxAgents field.
  - getActivate
```
public java.lang.String getActivate()
```
    Getter for the activate field.
    
    Returns:
    
    See above.
  - setActivate
```
public void setActivate(java.lang.String activate)
```
    Setter for the activate field.
    
    Parameters:
    
    activate - The new value for the activate field.
  - getDeactivate
```
public java.lang.String getDeactivate()
```
    Getter for the deactivate field.
    
    Returns:
    
    See above.
  - setDeactivate
```
public void setDeactivate(java.lang.String deactivate)
```
    Setter for the deactivate field.
    
    Parameters:
    
    deactivate - The new value for the deactivate field.
  - getConnect
```
public java.lang.String getConnect()
```
    Getter for the connect field.
    
    Returns:
    
    See above.
  - setConnect
```
public void setConnect(java.lang.String connect)
```
    Setter for the connect field.
    
    Parameters:
    
    connect - The new value for the connect field.
  - getDisconnect
```
public java.lang.String getDisconnect()
```
    Getter for the disconnect field.
    
    Returns:
    
    See above.
  - setDisconnect
```
public void setDisconnect(java.lang.String disconnect)
```
    Setter for the disconnect field.
    
    Parameters:
    
    disconnect - The new value for the disconnect field.
  - getStartup
```
public java.lang.String getStartup()
```
    Getter for the startup field.
    
    Returns:
    
    See above.
  - setStartup
```
public void setStartup(java.lang.String startup)
```
    Setter for the startup field.
    
    Parameters:
    
    startup - The new value for the startup field.
  - getShutdown
```
public java.lang.String getShutdown()
```
    Getter for the shutdown field.
    
    Returns:
    
    See above.
  - setShutdown
```
public void setShutdown(java.lang.String shutdown)
```
    Setter for the shutdown field.
    
    Parameters:
    
    shutdown - The new value for the shutdown field.
  - getStartupParameter
```
public java.lang.String getStartupParameter()
```
    Getter for the startupParameter field.
    
    Returns:
    
    See above.
  - setStartupParameter
```
public void setStartupParameter(java.lang.String startupParameter)
```
    Setter for the startupParameter field.
    
    Parameters:
    
    startupParameter - The new value for the startupParameter field.
  - getProjectToken
```
public java.lang.String getProjectToken()
```
    Get the project token that this agent serves. If not set then the default is used.
    
    Returns:
    
    the prokectToken the agent serves.
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Getter for properties properties.
    
    Returns:
    
    a temporary copy of the private map of environment properties. Returns null is the map is null or empty.

Class AppServerDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

definitions

appServer

pasoe

operatingMode

requestTimeout

autoTrimTimeout

propath

initialAgents

minAgents

maxAgents

activate

deactivate

connect

disconnect

startup

shutdown

startupParameter

projectToken

properties

Constructor Detail

AppServerDefinition

Method Detail

get

remove

refresh

getAppServer

setAppServer

isPasoe

isSessionFree

getOperatingMode

setOperatingMode

getRequestTimeout

setRequestTimeout

getAutoTrimTimeout

setAutoTrimTimeout

getPropath

setPropath

getInitialAgents

setInitialAgents

getMinAgents

setMinAgents

getMaxAgents

setMaxAgents

getActivate

setActivate

getDeactivate

setDeactivate

getConnect

setConnect

getDisconnect

setDisconnect

getStartup

setStartup

getShutdown

setShutdown

getStartupParameter

setStartupParameter

getProjectToken

getProperties