Package com.iizix.term.prop

Class SessionsProp

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, Cloneable
Direct Known Subclasses:
EditorSessionsProp
public class SessionsProp extends PropCnr implements IServerApplicationSetup, IServerApplicationSetupPropCnr
This Sessions property container holds the terminal properties.

  • Constructor Details

    • 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 Details

    • 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 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 String getDescription()
      The description.
      Specified by:
      getDescription in interface IServerApplicationSetup
      Returns:
      A descriptive string of the setup.

    • getSetupPropertyContainers

      public 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 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.