com.ibm.edms.od

Class ODConfig

java.lang.Object

com.ibm.edms.od.ODConfig

public class ODConfig
extends java.lang.Object

The ODConfig Java object will be the preferred method in which to configure the system parameters and the arswww.ini will be deprecated with version 8.4 of ODWEK. Until then, both the ODConfig Java object and the arswww.ini file will be supported.

There are eight system parameters needed for a working ODServer instance. These can be set to default values through the ODConfig default constructor:

  try{
       ODConfig cfg = new ODConfig();
       ODServer srvr = new ODServer(cfg);
       srvr.initialize(null, "MyCustomApp");
       cfg.printConfig();
   }
   catch(ODException e){
       System.out.println("Exception " + e);
   }

This sample code will configure the following default parameters:

 AfpViewOpt   PLUGIN
 LineViewOpt  APPLET
 MaxHits      200  This is used to set a global maxhits that can be returned from a search. This will not override the Admin settings. Also can be set per folder using ODFolder.setMaxHits
 MetaViewOpt  NATVIE
 AppletDir    /applets
 Language     ENU  Specifies the Language to be used when outputing messages.
 TempDir      The temp path as defined by the Java System.getProperty("java.io.tmpdir") method.
 TraceDir     The temp path as defined by the Java System.getProperty("java.io.tmpdir") method.
 TraceLevel   0
 

For information on these parameters please refer the OnDemand Web Enablement Kit Implementation Guide.

These eight parameters can also be explicitly set via the following sample code which utilizes a different ODConfig constructor:

  try{
       ODConfig cfg = new ODConfig(ODConstant.PLUGIN, //AfpViewer
                                   ODConstant.APPLET, //LineViewer
                                   null,              //MetaViewer
                                   500,               //MaxHits
                                   "c:\\applets",     //AppletDir
                                   "ENU",             //Language
                                   "c:\\temp",        //TempDir
                                   "c:\\temp\\trace", //TraceDir
                                   1);                //TraceLevel

      ODServer srvr = new ODServer(cfg);
      srvr.initialize("MyCustomApp");
      cfg.printConfig();
   }
   catch(ODException e){
       System.out.println("Exception " + e);
   }
 

This constructor will set parameters with zero or null values to the defaults mentioned above.
NOTE: This object has no methods to set parameters except during construction. The object cannot be modified after it has been constructed.

(c) Copyright IBM Corp. 1993, 2015. All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AFP2HTML_CONFIG_FILE The absolute pathname to the afp2html configuration file.
static java.lang.String	AFP2HTML_INSTALL_DIR The absolute pathname to the directory containing the transform executable.
static java.lang.String	AFP2PDF_CONFIG_FILE The absolute pathname to the afp2pdf configuration file.
static java.lang.String	AFP2PDF_INSTALL_DIR The absolute pathname to the directory containing the transform executable.
static java.lang.String	AFP2XML_CONFIG_FILE The absolute pathname to the afp2xml configuration file.
static java.lang.String	AFP2XML_INSTALL_DIR The absolute pathname to the directory containing the transform executable.
static java.lang.String	DBG_TRACE
static java.lang.String	HTML5_L2P_TRANSFORM Specifies the name of the Generic Transform Viewer to be used to transform Line data to PDF for the HTML5 Line Viewer when selecting Copy Pages to File.
static java.lang.String	IN_OPERATOR_DELIMITER Set a character to be used in IN operator queries.
static java.lang.String	MAX_TRACELOG_SIZE Used to set the maximum size in MB a trace log (arswww.trace) can grow to before it is renamed (arswww.trace.YYYYMMDD.HHMMSS) and a new trace log is created.
static java.lang.String	ODWEK_INSTALL_DIR The ODWEK install directory for non-default install locations.
static java.lang.String	RES_CACHE_MAX Defines the maximum space available for the use of a resource file cache.
static java.lang.String	RESOURCE_CACHE_DIR This parameter will override the default ODWEK behavior of caching resources in memory.
static java.lang.String	SQL_WILDCARD_ESCAPE Set a character to be used as a wildcard escape character during sql generation.
static java.lang.String	SSL_KEYRINGFILE
static java.lang.String	SSL_KEYRINGSTASH
static java.lang.String	TransformXML Specifies the fully qualified path to the XML containing ODTransform definitions.
static java.lang.String	USE_SSL_DEFAULT
static java.lang.String	VIEWER_EVENT_FUNCTION Specifies the name of a function the Java Line Data Viewer will call to notify the Web Application that a change has been made to the Annotation status of a document.
static java.lang.String	VIEWER_EVENT_NOTE_ADD The arguments passed to the function specified with the ODConfig.VIEWER_EVENT_FUNCTION property that the Java Line Data Viewer will call when a Web Application wants to be notified that an Annotation has been added to a document.
static java.lang.String	VIEWER_EVENT_NOTE_DELETE The arguments passed to the function specified with the ODConfig.VIEWER_EVENT_FUNCTION property that the Java Line Data Viewer will call when a Web Application wants to be notified that an Annotation has been deleted from a document.
static java.lang.String	VIEWER_EVENT_NOTE_UPDATE The arguments passed to the function specified with the ODConfig.VIEWER_EVENT_FUNCTION property that the Java Line Data Viewer will call when a Web Application wants to be notified that an Annotation has been updated for a document.
static java.lang.String	XENOS_CONFIG_FILE The absolute pathname to the xenos configuration file.
static java.lang.String	XENOS_INSTALL_DIR The absolute pathname to the directory containing the transform executable.

Constructor Summary

Constructors

Constructor and Description
ODConfig() The class constructor.
ODConfig(java.lang.String afpViewer, java.lang.String lineViewer, java.lang.String metaViewer, long maxHits, java.lang.String appletDir, java.lang.String language, java.lang.String tempDir, java.lang.String traceDir, int traceLevel) ODConfig constructor
ODConfig(java.lang.String afpViewer, java.lang.String lineViewer, java.lang.String metaViewer, long maxHits, java.lang.String appletDir, java.lang.String language, java.lang.String tempDir, java.lang.String traceDir, int traceLevel, java.util.Properties props) ODConfig constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAfpViewerType() Get the AFP viewer type
java.lang.String	getAppletDirectory() Get the full path to where the applet jar files reside
java.lang.String	getLanguageForMessages() Deprecated. As of Version 9.0, the Messaging Language can be changed in runtime. This api will only return the original as set in the ODConfig.
java.lang.String	getLineViewerType() Get the LINE viewer type
long	getMaxNumberOfHitsToDisplay() Get the maximum number of search result hits that will be displayed
java.lang.String	getMetaViewerType() Get the META viewer type
java.lang.String	getTemporaryWorkingDirectory() Returns the directory where ODWEK will create temporary working files
java.lang.String	getTraceDirectory() Get the directory where the arswww.trace file will be written and updated
int	getTraceLevel() Get the level at which events will be logged.
boolean	hasODTransforms()
void	printConfig() Print out the complete configuration settings
void	setLocale(java.util.Locale loc) Set the locale using a java.util.Locale object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AFP2HTML_INSTALL_DIR

public static final java.lang.String AFP2HTML_INSTALL_DIR

The absolute pathname to the directory containing the transform executable.

AFP2HTML_CONFIG_FILE

public static final java.lang.String AFP2HTML_CONFIG_FILE

The absolute pathname to the afp2html configuration file.

AFP2PDF_INSTALL_DIR

public static final java.lang.String AFP2PDF_INSTALL_DIR

The absolute pathname to the directory containing the transform executable.

AFP2PDF_CONFIG_FILE

public static final java.lang.String AFP2PDF_CONFIG_FILE

The absolute pathname to the afp2pdf configuration file.

XENOS_INSTALL_DIR

public static final java.lang.String XENOS_INSTALL_DIR

The absolute pathname to the directory containing the transform executable.

XENOS_CONFIG_FILE

public static final java.lang.String XENOS_CONFIG_FILE

The absolute pathname to the xenos configuration file.

AFP2XML_INSTALL_DIR

public static final java.lang.String AFP2XML_INSTALL_DIR

The absolute pathname to the directory containing the transform executable.

AFP2XML_CONFIG_FILE

public static final java.lang.String AFP2XML_CONFIG_FILE

The absolute pathname to the afp2xml configuration file.

ODWEK_INSTALL_DIR

public static final java.lang.String ODWEK_INSTALL_DIR

The ODWEK install directory for non-default install locations.

See Also:

for more details. https://www-304.ibm.com/support/docview.wss?uid=swg27019696

USE_SSL_DEFAULT

public static final java.lang.String USE_SSL_DEFAULT

SSL_KEYRINGFILE

public static final java.lang.String SSL_KEYRINGFILE

SSL_KEYRINGSTASH

public static final java.lang.String SSL_KEYRINGSTASH

DBG_TRACE

public static final java.lang.String DBG_TRACE

IN_OPERATOR_DELIMITER

public static final java.lang.String IN_OPERATOR_DELIMITER

Set a character to be used in IN operator queries. The default is a space.

SQL_WILDCARD_ESCAPE

public static final java.lang.String SQL_WILDCARD_ESCAPE

Set a character to be used as a wildcard escape character during sql generation. The default is null.

MAX_TRACELOG_SIZE

public static final java.lang.String MAX_TRACELOG_SIZE

Used to set the maximum size in MB a trace log (arswww.trace) can grow to before it is renamed (arswww.trace.YYYYMMDD.HHMMSS) and a new trace log is created. Only valid when a trace level is set. The default is to allow the trace log file to grow until the application is terminated.

RESOURCE_CACHE_DIR

public static final java.lang.String RESOURCE_CACHE_DIR

This parameter will override the default ODWEK behavior of caching resources in memory. If a ResourceCacheDir is specified, then ODWEK will store resources in a file cache at that location, instead of memory.

RES_CACHE_MAX

public static final java.lang.String RES_CACHE_MAX

Defines the maximum space available for the use of a resource file cache. WARNING: We will only track the total size of actual resource files. Additional files within the ResourceCacheDir could allow ODWEK to exceed the file system size.

See Also:

ODConfig.RESOURCE_CACHE_DIR

TransformXML

public static final java.lang.String TransformXML

Specifies the fully qualified path to the XML containing ODTransform definitions. This is defined in the Properties object passed into ODConfig().

See Also:

ODConfig.ODConfig(String, String, String, long, String, String, String, String, int, Properties)

HTML5_L2P_TRANSFORM

public static final java.lang.String HTML5_L2P_TRANSFORM

Specifies the name of the Generic Transform Viewer to be used to transform Line data to PDF for the HTML5 Line Viewer when selecting Copy Pages to File. This is defined in the Properties object passed into ODConfig().

See Also:

ODConfig.ODConfig(String, String, String, long, String, String, String, String, int, Properties)

VIEWER_EVENT_FUNCTION

public static final java.lang.String VIEWER_EVENT_FUNCTION

Specifies the name of a function the Java Line Data Viewer will call to notify the Web Application that a change has been made to the Annotation status of a document. Only those events that have been passed in the ODConfig will trigger a call from the Java Line Data Viewer.

See Also:

ODConfig.VIEWER_EVENT_NOTE_ADD, ODConfig.VIEWER_EVENT_NOTE_DELETE, ODConfig.VIEWER_EVENT_NOTE_UPDATE

VIEWER_EVENT_NOTE_ADD

public static final java.lang.String VIEWER_EVENT_NOTE_ADD

The arguments passed to the function specified with the ODConfig.VIEWER_EVENT_FUNCTION property that the Java Line Data Viewer will call when a Web Application wants to be notified that an Annotation has been added to a document.

See Also:

ODConfig.VIEWER_EVENT_FUNCTION, ODConfig.VIEWER_EVENT_NOTE_DELETE, ODConfig.VIEWER_EVENT_NOTE_UPDATE

VIEWER_EVENT_NOTE_DELETE

public static final java.lang.String VIEWER_EVENT_NOTE_DELETE

The arguments passed to the function specified with the ODConfig.VIEWER_EVENT_FUNCTION property that the Java Line Data Viewer will call when a Web Application wants to be notified that an Annotation has been deleted from a document.

See Also:

ODConfig.VIEWER_EVENT_FUNCTION, ODConfig.VIEWER_EVENT_NOTE_ADD, ODConfig.VIEWER_EVENT_NOTE_UPDATE

VIEWER_EVENT_NOTE_UPDATE

public static final java.lang.String VIEWER_EVENT_NOTE_UPDATE

The arguments passed to the function specified with the ODConfig.VIEWER_EVENT_FUNCTION property that the Java Line Data Viewer will call when a Web Application wants to be notified that an Annotation has been updated for a document.

See Also:

ODConfig.VIEWER_EVENT_FUNCTION, ODConfig.VIEWER_EVENT_NOTE_DELETE, ODConfig.VIEWER_EVENT_NOTE_ADD

Constructor Detail

ODConfig

public ODConfig()

The class constructor. Sets all members to working defaults
afpViewer is set to ODConstant.PLUGIN
lineViewer is set to ODConstant.APPLET
metaViewer is set to ODConstant.NATIVE
maxHits is set to 200
appletDir is set to /applets
language is set to ENU
tempDir is set to java.io.tmpdir
traceDir is set to java.io.tmpdir
traceLevel is set to 0 (off)


NOTE: If a security manager exists, a "read" PropertyPermission for file.separator must be configured
i.e. java.util.PropertyPermission pm = new java.util.PropertyPermission("file.separator", "read");

NOTE: Only a single language can be used in any one WebApplication. Subsequent requests with different settings for Language are ignored.

ODConfig

public ODConfig(java.lang.String afpViewer,
                java.lang.String lineViewer,
                java.lang.String metaViewer,
                long maxHits,
                java.lang.String appletDir,
                java.lang.String language,
                java.lang.String tempDir,
                java.lang.String traceDir,
                int traceLevel)
         throws ODException

ODConfig constructor

Parameters:

afpViewer - Conversion method for AFP data viewing

lineViewer - Conversion method for LINE data viewing

metaViewer - Conversion method for META data viewing

maxHits - Maximum number of hits to display

appletDir - Directory where the applets reside

language - Language in which messages will be output

tempDir - Directory to store temp files

traceDir - Path to write trace file

traceLevel - Sets the amount of trace information that will be gathered

NOTE: Only a single language can be used in any one WebApplication. Subsequent requests with different settings for Language are ignored.

Throws:

ODException - for invalid values

ODConfig

public ODConfig(java.lang.String afpViewer,
                java.lang.String lineViewer,
                java.lang.String metaViewer,
                long maxHits,
                java.lang.String appletDir,
                java.lang.String language,
                java.lang.String tempDir,
                java.lang.String traceDir,
                int traceLevel,
                java.util.Properties props)
         throws ODException

ODConfig constructor. This Constructor can be used to specify semi-custom configuration options passed via the Java Properties Object. For more details and an example of the usage of this constructor, please review the associated TechDoc at http://www-1.ibm.com/support/docview.wss?uid=swg21273746


NOTE: If a security manager exists, a "read" PropertyPermission for file.separator must be configured
i.e. java.util.PropertyPermission pm = new java.util.PropertyPermission("file.separator", "read");
NOTE: Only a single language can be used in any one WebApplication. Subsequent requests with different settings for Language are ignored.

Parameters:

afpViewer - Conversion method for AFP data viewing

lineViewer - Conversion method for LINE data viewing

metaViewer - Conversion method for META data viewing

maxHits - Maximum number of hits to display

appletDir - Directory where the applets reside

language - Language in which messages will be output

tempDir - Directory to store temp files

traceDir - Path to write trace file

traceLevel - Sets the amount of trace information that will be gathered

props - a Properties object that includes name, value pairs of ODConstant.xxx and value

Throws:

ODException - for invalid values

Method Detail

getAfpViewerType

public java.lang.String getAfpViewerType()

Get the AFP viewer type

Returns:

Conversion type

See Also:

ODConstant.ASCII, ODConstant.HTML, ODConstant.NATIVE, ODConstant.PDF, ODConstant.PLUGIN, ODConstant.XENOS

getAppletDirectory

public java.lang.String getAppletDirectory()

Get the full path to where the applet jar files reside

Returns:

The full path to where the applet jar files reside

getMetaViewerType

public java.lang.String getMetaViewerType()

Get the META viewer type

Returns:

Conversion type

See Also:

ODConstant.NATIVE, ODConstant.XENOS

getLineViewerType

public java.lang.String getLineViewerType()

Get the LINE viewer type

Returns:

Conversion type

See Also:

ODConstant.ASCII, ODConstant.APPLET, ODConstant.NATIVE, ODConstant.XENOS

getMaxNumberOfHitsToDisplay

public long getMaxNumberOfHitsToDisplay()

Get the maximum number of search result hits that will be displayed

Returns:

The maximum number of search result hits that will be displayed

getLanguageForMessages

public java.lang.String getLanguageForMessages()

Deprecated. As of Version 9.0, the Messaging Language can be changed in runtime. This api will only return the original as set in the ODConfig.

Get the three character language abbreviation that will be used for displaying messages.

Returns:

The three character language abbreviation

See Also:

ODServer.getMsgsLanguage()

setLocale

public void setLocale(java.util.Locale loc)
               throws java.lang.Exception

Set the locale using a java.util.Locale object

Parameters:

loc -

Throws:

java.lang.Exception

getTemporaryWorkingDirectory

public java.lang.String getTemporaryWorkingDirectory()

Returns the directory where ODWEK will create temporary working files

Returns:

Directory where ODWEK will create temporary working files

getTraceDirectory

public java.lang.String getTraceDirectory()

Get the directory where the arswww.trace file will be written and updated

Returns:

The directory where the arswww.trace file will be

getTraceLevel

public int getTraceLevel()

Get the level at which events will be logged.
0: No logging enabled
1: Log only ERROR events
2: Log only ERROR and WARNING events
3: Log ERROR, WARNING, and INFO events
4: Log ALL events

Returns:

Log level 0 - 4

hasODTransforms

public boolean hasODTransforms()

printConfig

public void printConfig()

Print out the complete configuration settings