java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- - com.iizix.prop.PropCnr
  - - com.iizix.term.prop.SessionsProp

All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, IServerApplicationSetup, IServerApplicationSetupPropCnr, java.lang.Cloneable
Direct Known Subclasses:
EditorSessionsProp
```
public class SessionsProp
extends PropCnr
implements IServerApplicationSetup, IServerApplicationSetupPropCnr
```
This Sessions property container holds the terminal properties.

Field Summary
- Fields inherited from class com.iizix.prop.PropCnr
  EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID
- Fields inherited from class com.iizix.prop.GProp
  GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2
- Fields inherited from interface com.iizix.prop.IGProp
  EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors
Constructor	Description
`SessionsProp()`	Creates the sessions property container without a name.
`SessionsProp(Atom propertyAtom)`	Creates the sessions property container with the specified name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SessionsProp`	`clone()`	Clone must be overridden.
`java.lang.String`	`getDefaultName(PropCnr moduleRoot)`	Gets the name of the default property container name in case of multiple property containers.
`java.lang.String`	`getDescription()`	The description.
`java.lang.String`	`getID()`	Gets the ID of the setup.
`TerminalProps[]`	`getSessions()`	Gets all sessions.
`java.util.List<IServerApplicationSetupPropCnr>`	`getSetupPropertyContainers(PropCnr moduleRoot)`	Gets the list of property containers that describes the setup required.
`void`	`onApplicationLoad(AppFactory app)`	Called when the application is loaded.
`void`	`onApplicationSessionStarted(AppSessionGyro appGyro)`	Called when an application is instantiated and started by a user session.
`void`	`onApplicationSessionStopped(AppSessionGyro appGyro)`	Called when an application is stopped.
`void`	`onApplicationUnload(AppFactory app)`	Called when the application is unloaded.
`void`	`onAppSessionEndPoint(EndPointPropCnr cnr, AppSessionGyro appGyro)`	Called when a new end point property container is added for a server monitor instance.

Methods inherited from class com.iizix.prop.PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verify, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IPropCnr
addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, isSibling, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, usePropHashMap, usesPropIndex, validateClassInstances

- Constructor Detail
  - SessionsProp
```
public SessionsProp()
```
    Creates the sessions property container without a name. The name must be set in all cases using the setPropertyAtom call.
  - SessionsProp
```
public SessionsProp(Atom propertyAtom)
```
    Creates the sessions property container with the specified name. All system-reserved names for components begins with "$".
    Parameters:
    propertyAtom - the name of the component, unique within it's parent.
- Method Detail
  - clone
```
public SessionsProp clone()
```
    Clone must be overridden.
    Overrides:
    clone in class PropCnr
  - getSessions
```
public TerminalProps[] getSessions()
```
    Gets all sessions.
    Returns:
    The array of terminal properties configured.
  - getID
```
public java.lang.String getID()
```
    Gets the ID of the setup.
    Specified by:
    getID in interface IServerApplicationSetup
    Returns:
    The ID. The ID should start with the plug-in ID and be concatenated with an additional sub-ID in case of multiple setup's in the same plug-in.
  - getDescription
```
public java.lang.String getDescription()
```
    The description.
    Specified by:
    getDescription in interface IServerApplicationSetup
    Returns:
    A descriptive string of the setup.
  - getSetupPropertyContainers
```
public java.util.List<IServerApplicationSetupPropCnr> getSetupPropertyContainers(PropCnr moduleRoot)
```
    Gets the list of property containers that describes the setup required. The names of these property containers are relevant. This method is only called in the Designer, thus the default returns an empty list.
    Specified by:
    getSetupPropertyContainers in interface IServerApplicationSetup
    Parameters:
    moduleRoot - The root of the Module application.
    Returns:
    The list of setup property containers for the Designer, not used in the Server.
  - getDefaultName
```
public java.lang.String getDefaultName(PropCnr moduleRoot)
```
    Gets the name of the default property container name in case of multiple property containers. This name will be used when an alternate application setup is not specified for the setup ID.
    Specified by:
    getDefaultName in interface IServerApplicationSetup
    Parameters:
    moduleRoot - The root of the Module application.
    Returns:
    The name of the default setup property container for the Designer, "default".
  - onApplicationLoad
```
public void onApplicationLoad(AppFactory app)
                       throws ServerApplicationSetupException
```
    Called when the application is loaded.
    Specified by:
    onApplicationLoad in interface IServerApplicationSetupPropCnr
    Parameters:
    app - The application being loaded.
    Throws:
    ServerApplicationSetupException - For setup exceptions.
  - onApplicationUnload
```
public void onApplicationUnload(AppFactory app)
```
    Called when the application is unloaded.
    Specified by:
    onApplicationUnload in interface IServerApplicationSetupPropCnr
    Parameters:
    app - The application being unloaded.
  - onApplicationSessionStarted
```
public void onApplicationSessionStarted(AppSessionGyro appGyro)
```
    Called when an application is instantiated and started by a user session.
    Specified by:
    onApplicationSessionStarted in interface IServerApplicationSetupPropCnr
    Parameters:
    appGyro - The application session gyro.
  - onApplicationSessionStopped
```
public void onApplicationSessionStopped(AppSessionGyro appGyro)
```
    Called when an application is stopped.
    Specified by:
    onApplicationSessionStopped in interface IServerApplicationSetupPropCnr
    Parameters:
    appGyro - The application session gyro.
  - onAppSessionEndPoint
```
public void onAppSessionEndPoint(EndPointPropCnr cnr,
                                 AppSessionGyro appGyro)
```
    Called when a new end point property container is added for a server monitor instance. This is delegated to the plug-ins in the application's server environment in order to enable them to add information for the application session.
    Specified by:
    onAppSessionEndPoint in interface IServerApplicationSetupPropCnr
    Parameters:
    cnr - The container for the end point.
    appGyro - The application session gyro of the end point.

Class SessionsProp

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Constructor Detail

SessionsProp

SessionsProp

Method Detail

clone

getSessions

getID

getDescription

getSetupPropertyContainers

getDefaultName

onApplicationLoad

onApplicationUnload

onApplicationSessionStarted

onApplicationSessionStopped

onAppSessionEndPoint