Class AppDefinition

Method Details

• getAppAliases

  public Set<String> getAppAliases()

  Gets the unmodifiable application aliases set.

  Returns:

  The set of aliases, the App ID is not among the aliases. Return value is never null.

• getIiziAppFile

  public File getIiziAppFile()

  Gets the compiled iiziApp Jar file of this definition (CC-FIX-APP-DEFINITIONS).

  Returns:

  The Jar file, or null for an application of Module project directories or of a database.

• isJarApplication

  public boolean isJarApplication()

  Checks if this definition is a compiled iiziApp Jar file given as a file (the -appjar form of the command line, or a fileName of the configuration), as opposed to Module project directories or a database application.

  Returns:

  true for a Jar file application.

• isModuleDirectories

  public boolean isModuleDirectories()

  Checks if this definition loads Module project directories (-project, the development server): such an application is never written into the server configuration (CC-FIX-APP-DEFINITIONS, M-5).

  Returns:

  true for Module project directories.

• getModuleDirectories

  public List<File> getModuleDirectories()

  Gets the Module project directories of this definition (-project, the development server), in the order they were added.

  Returns:

  The directories, an empty list for a compiled iiziApp Jar or a database application.

• getOwnModuleProjects

  public List<ModuleProjectPropCnr> getOwnModuleProjects()

  Gets the Module projects this definition loads from its OWN directories (CC-FIX-APP-MODULE-REFERENCES): the Module projects of the current factory whose directory is one of getModuleDirectories(), i.e. without the copies included for the Module projects of other applications this one references.

  Returns:

  The own Module projects; empty for a compiled application or when not loaded.

• getLoadGeneration

  public long getLoadGeneration()

  Gets the load generation: the count of successful loads of this application (CC-FIX-APP-MODULE-REFERENCES).

  Returns:

  The generation, zero before the first load.

• getReferencedApplicationIDs

  public Set<String> getReferencedApplicationIDs()

  Gets the IDs of the applications whose Module projects this application includes as copies, i.e. the applications it references, directly or through a chain (CC-FIX-APP-MODULE-REFERENCES).

  Returns:

  The application IDs in order of inclusion, empty for an application without references.

• dispose

  public void dispose()

  Disposes of the application definition.

  This method is intended to be called from the server: DO NOT CALL THIS METHOD.

• addListener

  public boolean addListener(IAppChangedListener listener)

  Adds an app change listener to be informed of app load/reloads and/or app dispose.

  Parameters:

  listener - The listener to add.

  Returns:

  true if the listener was added, false otherwise (nothing changed).

  Throws:

  NullPointerException - If the listener is null.

• removeListener

  public boolean removeListener(IAppChangedListener listener)

  Adds an app change listener to be informed of app load/reloads and/or app dispose.

  Parameters:

  listener - The listener to remove.

  Returns:

  true if listener is successfully removed, false otherwise, i.e. if not previous an added listener instance.

• getFactory

  public AppFactory getFactory()

  Gets the application factory.

  Returns:

  The application factory once loaded, null otherwise.

• addModuleDirectory

  public void addModuleDirectory(File dir) throws IOException

  Adds a directory for loading.

  Parameters:

  dir - The Module directory to load.

  Throws:

  IOException - if the directory is already added, or if the application definition is a compiled application.

• hasAppChanged

  public boolean hasAppChanged()

  Checks if the iiziApp has been changed and needs reload.

  Returns:

  true if app has changed and hot deploy is used, false when not changed or hot deploy is not used.

• getServerEnvironmentName

  public String getServerEnvironmentName()

  Returns the Server environment for the application.

• loadApplication

  public void loadApplication(ServerShell server) throws PropException, IOException, ServerApplicationSetupException, IllegalStateException

  Loads the application.

  Throws:

  IOException - For file errors.

  PropException - For property errors.

  ServerApplicationSetupException - In case a plug-in fail to initialize.

  IllegalStateException - If there are duplicates among the names, or if there is a collision of names in the Assets table when applying the App ID and/or it's aliases, or the asset table is corrupt.

• isHotDeployEnabled

  public boolean isHotDeployEnabled()

  Checks if hot deploy is used for this application.

  Returns:

  true if hot deploy is enabled, false otherwise.

• reload

  public boolean reload(ServerShell server, boolean forceReload) throws PropException, IOException, ServerApplicationSetupException, IllegalStateException

  Reloads the application if it has changed. Apps loaded from databases are not reloaded using this method.

  An application that includes the Module projects of other applications as copies (CC-FIX-APP-MODULE-REFERENCES) reloads when one of them has reloaded or changed, and reloads those first, so that its copies are taken from their current state; a referenced application's reload in turn reloads every application that includes it.

  Returns:

  true if reloaded, false if not changed or not loaded with hot deploy.

  Throws:

  IOException - For file errors.

  PropException - For property errors.

  ServerApplicationSetupException - In case a plug-in fail to initialize.

  IllegalStateException - If there are duplicates among the names, or if there is a collision of names in the Assets table when applying the App ID and/or it's aliases, or the asset table is corrupt.

• disposeHotDeploy

  public void disposeHotDeploy()

  Disposes of the application's hot deploy.

• getAppSessionFileProvider

  public WSFileProvider getAppSessionFileProvider() throws IOException

  Get the web server file provider for the application session.

  Returns:

  The web server file provider.

  Throws:

  IOException - If the directory for the application session files failed to be created.

  IllegalStateException - If the application is not yet loaded or is disposed of.