Docmosis API 4.5.0

com.docmosis
Class SystemManager

java.lang.Object
  extended bycom.docmosis.SystemManager

public final class SystemManager
extends Object

Initialise the document processing system. This will first initialise the configuration then initialise other sub-systems based on the configuration. This should be the first point of contact for any using system.


Constructor Summary
SystemManager()
           
 
Method Summary
static String getVersion()
          Get the version of this Docmosis build.
static void initialise()
          Initialise the system from configuration files and System properties.
static void initialise(Configuration configuration)
          Initialise the system from the configuration as well as default configuration files and System properties.
static boolean isInitialized()
          Determine if the system has been initialised.
static void release()
          Shuts down everything in the system, so that it can be re-initialised from scratch.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SystemManager

public SystemManager()
Method Detail

initialise

public static void initialise()
                       throws StartupException
Initialise the system from configuration files and System properties. Errors starting subsystems will be logged. Once initialisation is complete a good programmatic way to check that the system is ready to render is DocumentProcessor.hasOnlineConverters()

Throws:
StartupException - if an issue occurs starting up
See Also:
com.docmosis.util.DMProperties, DocumentProcessor.hasOnlineConverters()

initialise

public static void initialise(Configuration configuration)
                       throws StartupException
Initialise the system from the configuration as well as default configuration files and System properties. The supplied configuration overrides any other settings. Errors starting subsystems will be logged. Once initialisation is complete a good programmatic way to check that the system is ready to render is DocumentProcessor.hasOnlineConverters()

Parameters:
configuration - any overriding configuration settings (may be null)
Throws:
StartupException - if an issue occurs starting up
See Also:
com.docmosis.util.DMProperties, DocumentProcessor.hasOnlineConverters()

release

public static void release()
Shuts down everything in the system, so that it can be re-initialised from scratch.

See Also:
DMProperties

isInitialized

public static boolean isInitialized()
Determine if the system has been initialised.

Returns:
true if so.

getVersion

public static String getVersion()
Get the version of this Docmosis build.

Returns:
a string version identifier

Docmosis API 4.5.0

Copyright © 2014 Docmosis Pty Ltd. All Rights Reserved.