Package com.iizix.server.prop

Interface IServerApplicationSetup

All Known Implementing Classes:
ConnectionProfilesSetup, EditorConnectionProfilesSetup, EditorSessionsProp, SessionsProp
public interface IServerApplicationSetup
Interface implemented by the principal plug-in properties to provide information for a Server configuration of the application. E.g. the Database would use the Connection Profile settings, the Web Service uses Proxy information, the Terminal uses Terminal properties.
Author:
Christopher Mindus

  • Method Details

    • getID

      String getID()
      Gets the ID of the setup.
      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

      String getDescription()
      The description.
      Returns:
      A descriptive string of the setup.

    • getSetupPropertyContainers

      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.
      Parameters:
      moduleRoot - The root of the Module application.
      Returns:
      The list of setup property containers for the Designer, not used in the Server.

    • getDefaultName

      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.
      Parameters:
      moduleRoot - The root of the Module application.
      Returns:
      The name of the default setup property container for the Designer, not used in the Server (so default null is returned).