Class SessionsProp

    • 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

      • 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.
      • 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".
      • 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.