Package com.iizix.db.prop

Class ConnectionProfilesSetup

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.db.prop.ConnectionProfilesSetup
All Implemented Interfaces:
EventListener, IGProp<GProp<?>[]>, IPropCnr, IServerApplicationSetup, IServerApplicationSetupPropCnr, Cloneable
Direct Known Subclasses:
EditorConnectionProfilesSetup
public class ConnectionProfilesSetup extends PropCnr implements IServerApplicationSetup, IServerApplicationSetupPropCnr
Container with all connection profiles setup's by name.
Author:
Christopher Mindus

  • Constructor Details

    • ConnectionProfilesSetup

      public ConnectionProfilesSetup()
      Constructs the connection profiles setup container without name.

    • ConnectionProfilesSetup

      public ConnectionProfilesSetup(Atom name)
      Constructs the connection profiles setup container with specified name.
      Parameters:
      name - The name.

  • Method Details

    • clone

      public ConnectionProfilesSetup clone()
      Clones the instance.
      Overrides:
      clone in class PropCnr

    • getConnectionProfileSetup

      public ConnectionProfileSetup getConnectionProfileSetup(String name)
      Gets a ConnectionProfileSetup.
      Parameters:
      name - The name of the profile.
      Returns:
      The setup instance, or null if not found.

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

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

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

    • onApplicationLoad

      public void onApplicationLoad(AppFactory app) throws ServerApplicationSetupException
      Called when the application is loaded.
      Specified by:
      onApplicationLoad in interface IServerApplicationSetupPropCnr
      Parameters:
      app - The application begin 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 begin 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.