com.ibm.edms.od

Class ODServer

java.lang.Object

com.ibm.edms.od.ODServer

All Implemented Interfaces:

java.io.Serializable

public class ODServer
extends java.lang.Object
implements java.io.Serializable

A class representing a connection to an OnDemand server. From this class you can logon to an OnDemand Server, logoff from an OnDemand Server, change the user's password, get a listing of OnDemand Folders that are available to the user, and open an OnDemand Folder (ODFolder) for document searches and retrieval.

The ODServer object is the base object of a single ODWEK Instance. All other ODWEK (OnDemand Web Enablement Kit) objects such as ODFolder, ODHit, and etc. will be based on this ODServer object.

This grouping of objects will be referred to in this JavaDoc as a single ODWEK Instance.

WARNING:
It is the application developer's responsibility to limit concurrent access to a single ODWEK Instance. Failure to do so will result in unexpected results. If the client application requires more throughput, then additional ODWEK Instances should be initialized to handle an increased number of threads.
For Example: If the application was to make two simultaneous ODFolder.Search() calls against a single ODWEK Instance, the second search will be blocked until the first completes. Best Usage here would be to have a separate ODWEK Instance to handle each ODFolder.search() call separately.

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

See Also:

ODServer.ODServer(ODConfig), ODServer.ODServer(), ODServer.cancel(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ODServer() Deprecated. Use ODServer.ODServer(ODConfig cfg). Removed v8.4.
ODServer(ODConfig cfg) The class constructor.

Method Summary

Modifier and Type	Method and Description
ODHold	addHold(java.lang.String name, java.lang.String desc) Add a new Hold Definition to the OnDemand Server.
void	cancel() Cancel the current search or retrieve operation.
void	changePassword(java.lang.String newPassword) Change the user's password.
void	changePassword(java.lang.String server, java.lang.String user, java.lang.String password, java.lang.String newPassword) Change the user's password.
java.lang.String[]	getAllTransformViewerNames() Get all ODTransform names as specified in the transform.xml
java.util.Enumeration	getAllTransformViewers() Get all ODTransform defined in the transform.xml
long	getAnnotationAddMask() Get the mask to determine which types of annotations can be added, and what the default is set to.
ODApplicationGroup	getApplicationGroup(long id) Get an ODApplicationGroup object.
ODApplicationGroup	getApplicationGroup(java.lang.String name) Get an ODApplicationGroup object.
java.lang.String[]	getApplicationGroupNames() Get String[] of names for all Application Groups available to this user/server.
java.lang.String[]	getApplicationGroupNames(java.lang.String criteria) Get String[] of Application Group names that match the criteria.
java.util.Enumeration	getCabinets() Get the Cabinets defined for this ODServer.
char	getConnectType() Get the connection type used during logon.
long	getCurrentDate(char qual) Return the current date in the OnDemand Internal date format.
java.lang.String	getExternalDate(long internalDate, java.lang.String fmt, char qual) Convert an OnDemand Internal date format to a formatted string
java.lang.String	getFolderDescription(java.lang.String fldName) Get the folder description for the specified folder.
java.util.Enumeration	getFolderNames() Get the folder names.
java.util.Enumeration	getFolderNames(java.lang.String criteria) Get the list of folder names that match the search criteria.
java.util.Enumeration	getFolders() Return an Enumeration of all ODFolder objects available to this user/server.
java.util.Enumeration	getFolders(java.lang.String criteria) Return an Enumeration of all ODFolder objects available to this user/server, limited by the search criteria specified.
java.util.Hashtable	getHeaders()
java.util.Enumeration	getHolds() Get an enumeration of ODHold objects that are defined for this OnDemand Server/User.
long	getInternalDate(java.lang.String date, java.lang.String fmt, char qual) Convert date string to OnDemand Internal date format.
java.util.Locale	getLocale() Get the Locale for this session.
java.lang.String	getMessageOfTheDay()
java.lang.String	getMsgsLanguage() Deprecated. Use ODServer.getLocale().
int	getNumCabinets() Get the number of Cabinets defined for this ODServer.
int	getNumFolders() Get the number of folders available, based on the user permissions associated with this ODServer object.
int	getNumFolders(java.lang.String criteria) Get the number of folders.
java.lang.String	getOS() Get the OS type that the OnDemand Server is running on.
java.lang.String	getPassword() Return the user's password.
int	getPort() Get the port used for logon.
java.lang.String	getServerName() Get the server name.
java.lang.String[]	getServerPrinters() Return a list of server printers.
char	getServerPrinterType(java.lang.String printer) Return the type of the specified server printer.
long	getServerTimeoutValue() Get the server timeout value for the logged on user.
java.lang.String	getServerVersion() Get the OnDemand Server version string.
ODTransform	getTransformViewer(java.lang.String vwrName) Get the specified ODTransform as specified in the transform.xml
java.util.Hashtable	getTransformViewersForDocType(char doctype) Get a listing of Transform viewer names that are defined for a specific docType.
ODUser	getUser() Get the ODUser object for the current user.
java.lang.String	getUserAlias() Get the alias of the user.
java.lang.String	getUserId() Get the name of the user.
java.lang.String	getVersion() Get the ODWEK Version string.
boolean	hasPermToLoad(java.lang.String fldrName, java.lang.String applGrpName) Determines if conditions are in place for the logged on user to perform the load operations through ODWEK.
void	initialize(java.lang.String applicationName) Initialize the connection to the OnDemand server.
void	initialize(java.lang.String configDir, java.lang.String applicationName) Deprecated. Use ODServer.initialize(String applicationName). Removed v8.4.
void	initialize(java.lang.String configDir, java.lang.String applicationName, int code_page) Deprecated. Use ODServer.initialize(String applicationName). Removed v8.4.
boolean	isInitialized() Determine whether the ODServer object is currently initialized.
boolean	isServerTimedOut() Get the server timeout status.
boolean	keepServerAlive() Keep the connection alive by resetting the server timeout timer.
void	loadAddDoc(int numPages, java.util.Hashtable idxs_vals, byte[] b) The second call made in a series that will load n number of documents as a single load.
void	loadAddDoc(int numPages, java.util.Hashtable idxs_vals, java.io.File file) The second call made in a series that will load n number of documents as a single load.
void	loadCommit(java.lang.String agname, java.lang.String appname) The third call made in a series that will load n number of documents as a single load.
void	loadInit() The first call made in a series that will load n number of documents as a single load.
void	loadReset() An optional utility call that will reset the load process state back to uninitialized.
void	logoff() This method will log the user off of the OD server.
void	logon() This method is used to logon to the server.
void	logon(java.lang.String server, java.lang.String user, java.lang.String password) This method is used to logon to the OnDemand server.
void	logon(java.lang.String server, java.lang.String user, java.lang.String password, char connectType, int port, java.lang.String resv) Deprecated. Use ODServer.logon(String, String, String).
void	logon(java.lang.String server, java.lang.String user, java.lang.String password, java.lang.String new_password) This method is used to logon to the OnDemand server.
ODFolder	openFolder(java.lang.String fldName) This method will open the specified folder.
ODFolder	openFolderByBasename(java.lang.String fldBaseName) This method will open the specified folder.
void	setConnectType(char connectType) This method is used to set the server connection type.
void	setEncryptionKey(java.lang.String key) Set the encrypt key. Document identifiers (docids) are now encrypted.
void	setLocale(java.util.Locale locale) Set the Locale for this session.
void	setMsgsLanguage(java.lang.String language) Deprecated. Use ODServer.setLocale(Locale).
void	setPassThruToken(java.lang.String passThruText, int passThruSize, byte[] passThruByteArray) Method to set custom security tokens for Logon.
void	setPassword(java.lang.String password) Set the password for the user.
void	setPort(int port) Set the OD port number.
void	setServerName(java.lang.String server) Set the name of the OnDemand server to logon with.
void	setSSL(boolean useSSL, java.lang.String keyRingFile, java.lang.String keyStashFile) Set details for SSL usages with this ODServer.
void	setUserAlias(java.lang.String user_alias) Set the name of the user alias to log onto OD with.
void	setUserId(java.lang.String user) Set the name of the user to log onto OD with.
void	terminate() Terminate the connection to the OnDemand server.
void	unifiedLogon(java.lang.String server) This method will use UnifiedLogon to logon to the server.
void	updateTraceLevel(java.lang.String szNewLevel) Update the trace level at which events will be logged.
byte[]	viewerPassthru(java.lang.String queryStr) This method is used to pass ODWEK document viewer requests for data through to the ODWEK code.
byte[]	viewerPassthru(java.lang.String qs, java.io.InputStream is) This method is used to pass ODWEK document viewer requests for data through to the ODWEK code.
byte[]	xmlParse(java.lang.String xml, int action, boolean continueOnError, int exportFlags, int exportEncoding, ODCallback odc) Interface to arsxml batch administration client.
byte[]	xmlParse(java.lang.String xml, int action, boolean continueOnError, int exportFlags, int exportEncoding, java.lang.String exportSchemaLocation, ODCallback odc) Deprecated. Use ODServer.xmlParse(String, int, boolean, int, int, ODCallback). Deprecated at v10.5.
byte[]	xmlParse(java.lang.String xml, int action, java.util.Properties xmlProperties, ODCallback odc) Interface to arsxml batch administration client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODServer

public ODServer()

Deprecated. Use ODServer.ODServer(ODConfig cfg). Removed v8.4.

The class constructor.

See Also:

ODServer.ODServer(ODConfig)

ODServer

public ODServer(ODConfig cfg)

The class constructor. This constructor takes a ODConfig object which contains all the configuration details for this ODServer.

Parameters:

cfg - ODConfig object with the configuration details.

See Also:

ODConfig

Method Detail

initialize

public void initialize(java.lang.String applicationName)
                throws ODException

Initialize the connection to the OnDemand server. This method must be called after object creation and before the logon method is called.

Parameters:

applicationName - This is the application name that will be invoked by the ODWEK viewers via URL when requesting addition document data. This should include the relative webserver path.
EXAMPLE:

      odServer.initialze("/CustomServlet/");
 

Throws:

ODException

See Also:

ODServer.initialize(String configDir, String applicationName), ODServer.viewerPassthru(java.lang.String, java.io.InputStream)

initialize

public void initialize(java.lang.String configDir,
                       java.lang.String applicationName)
                throws ODException

Deprecated. Use ODServer.initialize(String applicationName). Removed v8.4.

Initialize the connection to the OnDemand server. This method must be called after object creation and before the logon method is called.

Parameters:

configDir - The directory where the arswww.ini file exists.

applicationName - This is the application name that will be invoked by the ODWEK viewers via URL when requesting addition document data. This should include the relative webserver path.
EXAMPLE:

      odServer.initialze("/CustomServlet/");
 

Throws:

ODException

initialize

public void initialize(java.lang.String configDir,
                       java.lang.String applicationName,
                       int code_page)
                throws ODException

Deprecated. Use ODServer.initialize(String applicationName). Removed v8.4.

Initialize the connection to the OnDemand server. This method must be called after object creation and before the logon method is called.

NOTE: ODWEK will only use Codepage 1208 internally. All input/output from ODWEK APIs will be 1208.

Parameters:

configDir - The directory where the arswww.ini file exists.

applicationName - This is the application name that will be invoked by the ODWEK viewers via URL when requesting addition document data. This should include the relative webserver path.
EXAMPLE:

      odServer.initialze("/CustomServlet/");
 

Throws:

ODException

terminate

public void terminate()

Terminate the connection to the OnDemand server. This method must be called when you are done with the server object. NOTE: Only ODServer objects that have been successfully initialized need to be terminated.

See Also:

ODServer.initialize(String), ODServer.isInitialized()

isInitialized

public boolean isInitialized()

Determine whether the ODServer object is currently initialized.

Returns:

true or false.

cancel

public void cancel()

Cancel the current search or retrieve operation. To issue this call you will need to create another thread and make the call from that thread using the same ODServer object that the search/retrieve call was made from.
Notes:

1. Based on timing of where the server-side transaction is currently running, a cancellation may not always be possible.
2. For search methods a successful cancel call is not always considered an error and therefore a partial hit list may be returned. Otherwise an exception may be thrown indicating that the search was cancelled (Exception Id 6009).
3. For retrieve methods a successful cancel call is considered an error and therefore the retrieve method call will throw an exception.

logon

public void logon(java.lang.String server,
                  java.lang.String user,
                  java.lang.String password,
                  char connectType,
                  int port,
                  java.lang.String resv)
           throws java.lang.Exception

Deprecated. Use ODServer.logon(String, String, String).

This method is used to logon to the OnDemand server.

Parameters:

server - The name of the OD server.

user - The name of the user.

password - The user's password.

Throws:

java.lang.Exception

logon

public void logon(java.lang.String server,
                  java.lang.String user,
                  java.lang.String password)
           throws java.lang.Exception

This method is used to logon to the OnDemand server.

Parameters:

server - The name of the OD server.

user - The name of the user.

password - The user's password.

Throws:

java.lang.Exception

See Also:

ODServer.setSSL(boolean, java.lang.String, java.lang.String)

logon

public void logon(java.lang.String server,
                  java.lang.String user,
                  java.lang.String password,
                  java.lang.String new_password)
           throws java.lang.Exception

This method is used to logon to the OnDemand server.

Parameters:

server - The name of the OD server.

user - The name of the user.

password - The user's password.

new_password - A new password to be set if the current password has expired.

Throws:

java.lang.Exception

See Also:

ODServer.initialize(java.lang.String), ODServer.setSSL(boolean, java.lang.String, java.lang.String)

unifiedLogon

public void unifiedLogon(java.lang.String server)
                  throws java.lang.Exception

This method will use UnifiedLogon to logon to the server. Only OnDemand Servers on Windows or z/OS provide support for Unified Logon. See OnDemand Server Install and Config documentation for details on configuring Unified Logon support with the OnDemand Servers.

Parameters:

server - The name of the OD server.

Throws:

java.lang.Exception

See Also:

ODServer.setSSL(boolean, java.lang.String, java.lang.String)

setPassThruToken

public void setPassThruToken(java.lang.String passThruText,
                             int passThruSize,
                             byte[] passThruByteArray)

Method to set custom security tokens for Logon. During ODServer#logon this information will be passed thru to the OnDemand Server to be processed via the server side authentication security exit.

Parameters:

passThruText - String containing custom token.

passThruSize - Int size of the byte array containing the custom token. (Required when passing token as a byte array)

passThruByteArray - byte[] containing custom token.

logon

public void logon()
           throws java.lang.Exception

This method is used to logon to the server. This method is to be called only after ODServer.setServerName(java.lang.String), ODServer.setUserId(java.lang.String) and ODServer.setPassword(java.lang.String) have been called.

Throws:

java.lang.Exception

See Also:

ODServer.initialize(java.lang.String), ODServer.setUserId(java.lang.String), ODServer.setPassword(java.lang.String), ODServer.setServerName(java.lang.String), ODServer.setSSL(boolean, java.lang.String, java.lang.String)

logoff

public void logoff()
            throws java.lang.Exception

This method will log the user off of the OD server.

Throws:

java.lang.Exception

changePassword

public void changePassword(java.lang.String server,
                           java.lang.String user,
                           java.lang.String password,
                           java.lang.String newPassword)
                    throws java.lang.Exception

Change the user's password. This method will logon/logoff the user on if the logon method was not previously called.

Parameters:

server - The name of the OD server.

user - The name of the user.

password - The user's password.

newPassword - The user's new password.

Throws:

java.lang.Exception - "Incorrect Logon Parameters" if Server, UserID or Password are not set.

changePassword

public void changePassword(java.lang.String newPassword)
                    throws java.lang.Exception

Change the user's password. This method will logon/logoff the user on if the logon method was not previously called. IF the user is not logged on, then this method is to be called only after ODServer.setServerName(java.lang.String), ODServer.setUserId(java.lang.String) and ODServer.setPassword(java.lang.String) have been called.

Parameters:

newPassword - The user's new password.

Throws:

java.lang.Exception - "Incorrect Logon Parameters" if Server, UserID or Password are not set.

openFolderByBasename

public ODFolder openFolderByBasename(java.lang.String fldBaseName)
                              throws java.lang.Exception

This method will open the specified folder.

Parameters:

fldBaseName - Name of folder to open.

Returns:

ODFolder This object contains folder criteria information and is the object which searches can be performed against.

Throws:

java.lang.Exception

See Also:

ODFolder

openFolder

public ODFolder openFolder(java.lang.String fldName)
                    throws java.lang.Exception

This method will open the specified folder.

NOTE: If language specific folder names are defined and you wish to open the folder by specifying the language specific folder name for the fldName ODServer.getFolders() must be called prior to the ODServer.openFolder(String) call. Failure to call these methods in the proper order could result in an Exception indicating the folder cannot be found on the server.

Parameters:

fldName - Name of folder to open.

Returns:

ODFolder This object contains folder criteria information and is the object which searches can be performed against.

Throws:

java.lang.Exception

See Also:

ODFolder

viewerPassthru

public byte[] viewerPassthru(java.lang.String qs,
                             java.io.InputStream is)
                      throws java.lang.Exception

This method is used to pass ODWEK document viewer requests for data through to the ODWEK code.

Parameters:

qs - The query string as sent from the ODWEK document viewer.

is - The InputStream from an HttpServletRequest as sent from the ODWEK document viewer.

Returns:

byte[] A byte array containing data to be sent back to the ODWEK document viewer.

Throws:

java.lang.Exception

viewerPassthru

public byte[] viewerPassthru(java.lang.String queryStr)
                      throws java.lang.Exception

This method is used to pass ODWEK document viewer requests for data through to the ODWEK code.

Parameters:

queryStr - The query string as sent from the ODWEK document viewer.

Returns:

byte[] A byte array containing data to be sent back to the ODWEK document viewer.

Throws:

java.lang.Exception

getFolders

public java.util.Enumeration getFolders(java.lang.String criteria)
                                 throws java.lang.Exception

Return an Enumeration of all ODFolder objects available to this user/server, limited by the search criteria specified.

The search will occur for the folder's base name only whether or not any defined language specific folder names exist.

Any existing folder lists associated with this ODServer will be replaced with the results of this call.

NOTE: The folders in this enumeration will need to be opened before use.

Parameters:

criteria - The search criteria to be used to limit the folder list. Can include the wildcard '%'. Examples include: 'Credit%', 'C%', etc... A complete folder name may be specified as well which results in only one folder being returned.

Returns:

Enumeration of ODFolder Objects.

Throws:

java.lang.Exception

See Also:

ODFolder.open(), ODFolder.getBaseName(), ODServer.getLocale()

getNumFolders

public int getNumFolders()
                  throws java.lang.Exception

Get the number of folders available, based on the user permissions associated with this ODServer object.

NOTE: Any folder list previously retrieved will be replaced by the result of this call.

Returns:

int The number of folders accessible to the user.

Throws:

java.lang.Exception

getNumFolders

public int getNumFolders(java.lang.String criteria)
                  throws java.lang.Exception

Get the number of folders.
This method will query the server for the folders that match the specified criteria.

The search will occur for the folder's base name only whether or not any defined language specific folder names exist.

Parameters:

criteria - Folder search criteria. This can include wild cards. Examples include: 'Credit%', 'C%', etc... A complete folder name may be specified as well which results in only one folder being returned.

NOTE: Any folder list previously retrieve will be replaced by the result of this call.

Returns:

int The number of folders accessible to the user based upon the criteria specified.

Throws:

java.lang.Exception

See Also:

ODFolder.getBaseName(), ODServer.getLocale()

getFolderNames

public java.util.Enumeration getFolderNames()
                                     throws java.lang.Exception

Get the folder names. This method will query the server for the folders which are accessible to the user.

Returns:

An enumeration of String objects containing the names of all folders accessible to the user.

NOTE: Any folder list previously retrieved will be replaced by the results of this call.

Throws:

java.lang.Exception

See Also:

ODServer.openFolder(java.lang.String)

getFolderNames

public java.util.Enumeration getFolderNames(java.lang.String criteria)
                                     throws java.lang.Exception

Get the list of folder names that match the search criteria.
This method will query the server for the folders which match the specified criteria.

The search will occur for the folder's base name only whether or not any defined language specific folder names exist.

Parameters:

criteria - Folder search criteria. This can include wild cards. Examples include: 'Credit%', 'C%', etc... A complete folder name may be specified as well which results in only one folder name being returned.

NOTE: Any folder list previously retrieved will be replaced by the results of this call.

Returns:

Enumeration An enumeration of String objects containing all folders accessible to the user based upon the criteria specified.

Throws:

java.lang.Exception

See Also:

ODServer.openFolder(java.lang.String), ODFolder.getBaseName(), ODServer.getLocale()

getFolderDescription

public java.lang.String getFolderDescription(java.lang.String fldName)
                                      throws java.lang.Exception

Get the folder description for the specified folder.

NOTE: If language specific folder names are defined and you wish to get the folder description by specifying the language specific folder name for the fldName, ODServer.getFolders() must be called prior to the ODServer.getFolderDescription(String) call. Failure to call these methods in the proper order could result in an Exception indicating the folder cannot be found on the server.

Parameters:

fldName - The name of the folder to retrieve a description for.

Returns:

String The description of the specified folder.

Throws:

java.lang.Exception

isServerTimedOut

public boolean isServerTimedOut()

Get the server timeout status.

Returns:

true if the server is timed out.

getServerTimeoutValue

public long getServerTimeoutValue()

Get the server timeout value for the logged on user.

Returns:

The server timeout value in seconds. If the server timout is 'Never Time Out' the return value is 0. If the ODServer has no logged on user, this method will return -1.

keepServerAlive

public boolean keepServerAlive()

Keep the connection alive by resetting the server timeout timer.

Returns:

true if the operation is successful.

getServerName

public java.lang.String getServerName()

Get the server name.

Returns:

String The name of the server.

setServerName

public void setServerName(java.lang.String server)

Set the name of the OnDemand server to logon with.

Parameters:

server - Name of the OnDemand server.

See Also:

ODServer.logon(java.lang.String, java.lang.String, java.lang.String, char, int, java.lang.String)

getUserId

public java.lang.String getUserId()

Get the name of the user.

Returns:

String The name of the user.

getUserAlias

public java.lang.String getUserAlias()

Get the alias of the user. NOTE:This call must be made after a sucessful Logon to take affect.

Returns:

String The user alias.

See Also:

ODServer.setUserAlias(java.lang.String)

setUserId

public void setUserId(java.lang.String user)

Set the name of the user to log onto OD with.

Parameters:

user - The name of the user.

setUserAlias

public void setUserAlias(java.lang.String user_alias)

Set the name of the user alias to log onto OD with. This alias can be used as a secondary id when a web application is accessing ODWEK via a single OnDemand UserID. This user alias will then be logged in the OnDemand System Log.

For Example: If you only have a single OnDemand user defined for all of your web application users, but you would like to see who is actually issuing a query against a specific Folder, you could set a unique user alias for this ODServer, and the user alias would then be referenced in the OnDemand System log for the query.

Parameters:

user_alias - The alias of the user.

setSSL

public void setSSL(boolean useSSL,
                   java.lang.String keyRingFile,
                   java.lang.String keyStashFile)

Set details for SSL usages with this ODServer. These settings will overwrite any settings previously specified in the ODConfig.

Parameters:

useSSL - Set to True if SSL port will be used.

keyRingFile - Fully qualified path to the SSL Key Ring File.

keyStashFile - Fully qualified path to the SSL Key Stash File.

getPassword

public java.lang.String getPassword()

Return the user's password. This will return the user's password in clear text.

Returns:

String The user's password.

setPassword

public void setPassword(java.lang.String password)

Set the password for the user. This method does not change the user's password.

Parameters:

password - The user's password, to be used during logon.

See Also:

ODServer.changePassword(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

setEncryptionKey

public void setEncryptionKey(java.lang.String key)
                      throws ODException

Set the encrypt key.

Document identifiers (docids) are now encrypted. This method can be called after a user logon to specify the encryption key to be used for docid generation. If this method is not called ODWEK will generate the encryption key. In both instances, the encrypted docid is bound to the userid currently logged in when the docid is generated. This ensures that only this user can retrieve the contents of the document using the docid. This userid binding to the docid can be circumvented by calling this method prior to user logon. When used in this fashion it is imperative that the calling application ensure the docid is only used to retrieve the contents of the document by users with the proper permissions.

Parameters:

key - Encryption key to be used for document ID generation.

Throws:

ODException

getConnectType

public char getConnectType()

Get the connection type used during logon.

Returns:

The connection type used to connect to OD with.

See Also:

ODConstant.CONNECT_TYPE_TCPIP

setConnectType

public void setConnectType(char connectType)
                    throws ODException

This method is used to set the server connection type.

Parameters:

connectType - Connection type to use during logon.

Throws:

ODException

See Also:

ODConstant.CONNECT_TYPE_TCPIP, ODServer.logon(java.lang.String, java.lang.String, java.lang.String, char, int, java.lang.String)

setMsgsLanguage

public void setMsgsLanguage(java.lang.String language)
                     throws java.lang.Exception

Deprecated. Use ODServer.setLocale(Locale).

Set the Messaging Language for this session. This will overwrite the default language used for messaging as set in the ODConfig. This will change any messages that are generated by OnDemand to be output in the specified language.

Parameters:

language - MSG Language to be used in any OnDemand Generated messages.

Throws:

java.lang.Exception

See Also:

ODConstant.LANGUAGE_ARA, ODConstant.LANGUAGE_CHS, ODConstant.LANGUAGE_CHT, ODConstant.LANGUAGE_CZE, ODConstant.LANGUAGE_DAN, ODConstant.LANGUAGE_DEU, ODConstant.LANGUAGE_ELL, ODConstant.LANGUAGE_ENU, ODConstant.LANGUAGE_ESP, ODConstant.LANGUAGE_FIN, ODConstant.LANGUAGE_FRA, ODConstant.LANGUAGE_HEB, ODConstant.LANGUAGE_HRV, ODConstant.LANGUAGE_HUN, ODConstant.LANGUAGE_ITA, ODConstant.LANGUAGE_JPN, ODConstant.LANGUAGE_KOR, ODConstant.LANGUAGE_NLD, ODConstant.LANGUAGE_NOR, ODConstant.LANGUAGE_PLK, ODConstant.LANGUAGE_PTB, ODConstant.LANGUAGE_RUS, ODConstant.LANGUAGE_SKY, ODConstant.LANGUAGE_SLO, ODConstant.LANGUAGE_SVE, ODConstant.LANGUAGE_TRK

getMsgsLanguage

public java.lang.String getMsgsLanguage()
                                 throws java.lang.Exception

Deprecated. Use ODServer.getLocale().

Get the Language used for Messages for this session.

Returns:

MSG Language to be used in any OnDemand Generated messages.

Throws:

java.lang.Exception

See Also:

ODConstant.LANGUAGE_ARA, ODConstant.LANGUAGE_CHS, ODConstant.LANGUAGE_CHT, ODConstant.LANGUAGE_CZE, ODConstant.LANGUAGE_DAN, ODConstant.LANGUAGE_DEU, ODConstant.LANGUAGE_ELL, ODConstant.LANGUAGE_ENU, ODConstant.LANGUAGE_ESP, ODConstant.LANGUAGE_FIN, ODConstant.LANGUAGE_FRA, ODConstant.LANGUAGE_HEB, ODConstant.LANGUAGE_HRV, ODConstant.LANGUAGE_HUN, ODConstant.LANGUAGE_ITA, ODConstant.LANGUAGE_JPN, ODConstant.LANGUAGE_KOR, ODConstant.LANGUAGE_NLD, ODConstant.LANGUAGE_NOR, ODConstant.LANGUAGE_PLK, ODConstant.LANGUAGE_PTB, ODConstant.LANGUAGE_RUS, ODConstant.LANGUAGE_SKY, ODConstant.LANGUAGE_SLO, ODConstant.LANGUAGE_SVE, ODConstant.LANGUAGE_TRK

setLocale

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

Set the Locale for this session. This will overwrite the default language used for messaging as set in the ODConfig. This will change any messages and also the getName/getDescription methods of the ODCriteria, ODFolder, ODCabinet, and ODHold objects where the defined NLS strings match the specified locale.

Parameters:

locale - Locale to be used in any OnDemand Generated messages.

Throws:

java.lang.Exception

getLocale

public java.util.Locale getLocale()
                           throws java.lang.Exception

Get the Locale for this session.

Returns:

Locale object to be used in any OnDemand Generated messages and getName/getDescription methods of the ODCriteria, ODFolder, ODCabinet, and ODHold objects where the defined NLS strings match the this locale.

Throws:

java.lang.Exception

See Also:

ODConstant.LANGUAGE_ARA, ODConstant.LANGUAGE_CHS, ODConstant.LANGUAGE_CHT, ODConstant.LANGUAGE_CZE, ODConstant.LANGUAGE_DAN, ODConstant.LANGUAGE_DEU, ODConstant.LANGUAGE_ELL, ODConstant.LANGUAGE_ENU, ODConstant.LANGUAGE_ESP, ODConstant.LANGUAGE_FIN, ODConstant.LANGUAGE_FRA, ODConstant.LANGUAGE_HEB, ODConstant.LANGUAGE_HRV, ODConstant.LANGUAGE_HUN, ODConstant.LANGUAGE_ITA, ODConstant.LANGUAGE_JPN, ODConstant.LANGUAGE_KOR, ODConstant.LANGUAGE_NLD, ODConstant.LANGUAGE_NOR, ODConstant.LANGUAGE_PLK, ODConstant.LANGUAGE_PTB, ODConstant.LANGUAGE_RUS, ODConstant.LANGUAGE_SKY, ODConstant.LANGUAGE_SLO, ODConstant.LANGUAGE_SVE, ODConstant.LANGUAGE_TRK

getPort

public int getPort()

Get the port used for logon.

Returns:

The server port number.

See Also:

ODServer.logon(java.lang.String, java.lang.String, java.lang.String, char, int, java.lang.String)

setPort

public void setPort(int port)

Set the OD port number.

Parameters:

port - OD port number

getServerPrinters

public java.lang.String[] getServerPrinters()
                                     throws java.lang.Exception

Return a list of server printers. This method will query the server for defined OnDemand server printers.

Returns:

String[] An array containing the names of all OD server printers.

Throws:

java.lang.Exception

getServerPrinterType

public char getServerPrinterType(java.lang.String printer)
                          throws java.lang.Exception

Return the type of the specified server printer.

Parameters:

printer - The name of the printer

Returns:

char - A constant representing the type of server printer.

Throws:

java.lang.Exception

See Also:

ODServer.getServerPrinters(), ODConstant.OD_PRT_TYPE_PRINT, ODConstant.OD_PRT_TYPE_FAX, ODConstant.OD_PRT_TYPE_PRINT_WITH_INFO

getFolders

public java.util.Enumeration getFolders()
                                 throws java.lang.Exception

Return an Enumeration of all ODFolder objects available to this user/server. Any existing folder lists associated with this ODFolder will be replaced.


NOTE: The folders in this enumeration will need to be opened before use.

Returns:

Enumeration of ODFolder Objects.

Throws:

java.lang.Exception

See Also:

ODFolder.open()

getApplicationGroup

public ODApplicationGroup getApplicationGroup(long id)
                                       throws ODException

Get an ODApplicationGroup object.

Parameters:

id - the numeric Application Group ID

Returns:

ODApplicationGroup object representing an OnDemand application group.

Throws:

ODException

See Also:

ODApplicationGroup

getApplicationGroup

public ODApplicationGroup getApplicationGroup(java.lang.String name)
                                       throws ODException

Get an ODApplicationGroup object.

Parameters:

name - The name of the Application Group

Returns:

ODApplicationGroup object representing an OnDemand application group.

Throws:

ODException

See Also:

ODApplicationGroup

getApplicationGroupNames

public java.lang.String[] getApplicationGroupNames()
                                            throws java.lang.Exception

Get String[] of names for all Application Groups available to this user/server.
Any existing list associated with this ODServer will be replaced.

Returns:

String[] containing Application Group Names

Throws:

java.lang.Exception

See Also:

ODServer.getApplicationGroupNames(String)

getApplicationGroupNames

public java.lang.String[] getApplicationGroupNames(java.lang.String criteria)
                                            throws java.lang.Exception

Get String[] of Application Group names that match the criteria. This list is limited by current user permissions. Any existing list associated with this ODServer will be replaced.

Returns:

String[] containing Application Group Names

Throws:

java.lang.Exception

See Also:

ODServer.getApplicationGroupNames()

getUser

public ODUser getUser()
               throws java.lang.Exception

Get the ODUser object for the current user. This user object includes all the default user info as set at the OnDemand server, as well as several user parameters that can be set via the ODUser class.

Returns:

ODUser object

Throws:

java.lang.Exception

See Also:

ODUser

getAnnotationAddMask

public long getAnnotationAddMask()

Get the mask to determine which types of annotations can be added, and what the default is set to. This mask is Global in scope and is set in the OnDemand Administrator under Server->System Properties.
For Example:

      System.out.println( " Can Add Public Annotations = " +
             ((ODServer.getAnnotationAddMask() & ODConstant.OD_SYSTEM_ANN_ADD_PUB_NOT_ALLOWED )== 0
                  ? false : true ));
 

NOTE: When going against a OnDemand Server version prior to 7.1.2.8, this functionality is not supported and this mask will always return zero.

See Also:

ODConstant.OD_SYSTEM_ANN_ADD_PUB_NOT_ALLOWED, ODConstant.OD_SYSTEM_ANN_ADD_PRI_NOT_ALLOWED, ODConstant.OD_SYSTEM_ANN_ADD_GRP_NOT_ALLOWED, ODConstant.OD_SYSTEM_ANN_ADD_DEFAULT_PUBLIC, ODConstant.OD_SYSTEM_ANN_ADD_DEFAULT_PRIVATE, ODConstant.OD_SYSTEM_ANN_ADD_DEFAULT_GROUP

getCabinets

public java.util.Enumeration getCabinets()
                                  throws java.lang.Exception

Get the Cabinets defined for this ODServer. The available cabinets will be based on the user permissions associated with the current ODServer.

Returns:

Enumeration of ODCabinet objects. Enumerator will be empty if there are zero cabinets defined to this server.

Throws:

java.lang.Exception

See Also:

ODCabinet

getNumCabinets

public int getNumCabinets()
                   throws java.lang.Exception

Get the number of Cabinets defined for this ODServer.

Returns:

int numCabinets

Throws:

java.lang.Exception

See Also:

ODServer.getCabinets()

getOS

public java.lang.String getOS()
                       throws ODException

Get the OS type that the OnDemand Server is running on. NOTE: OnDemand Server versions prior to 7.1.1.0 will return 'null'

Throws:

ODException

See Also:

ODConstant.SERVER_OS_AIX, ODConstant.SERVER_OS_SUNOS, ODConstant.SERVER_OS_LINUX, ODConstant.SERVER_OS_WINDOWS_32, ODConstant.SERVER_OS_WINDOWS_64, ODConstant.SERVER_OS_OS400, ODConstant.SERVER_OS_OS390

getHolds

public java.util.Enumeration getHolds()
                               throws java.lang.Exception

Get an enumeration of ODHold objects that are defined for this OnDemand Server/User.

Returns:

Enumeration of ODHold objects.

Throws:

java.lang.Exception

See Also:

ODHold

addHold

public ODHold addHold(java.lang.String name,
                      java.lang.String desc)
               throws ODException

Add a new Hold Definition to the OnDemand Server. To check if permissions will allow this user to add a Hold, use ODUser.getAuthority()

Throws:

ODException

See Also:

ODUser.getAuthority()

xmlParse

public byte[] xmlParse(java.lang.String xml,
                       int action,
                       java.util.Properties xmlProperties,
                       ODCallback odc)
                throws java.lang.Exception

Interface to arsxml batch administration client. NOTE: As of 10.1.0.6+, If added to xmlProperties, ExportSchemaLocation is ignored. XML processing has changed to expect the OnDemand schema file in the <OnDemand install dir>/xml only, regardless of what is found in the xml.

Parameters:

xml - This is data to be parsed by arsxml. It must be fully composed XML.

action - Action to take on input xml.

xmlProperties - - array of keyword/value pairs

   ContinueOnError      Controls error handling.
                        true  - Continue processing even if error encountered.
                        false - Stop processing if error encountered.

   UpdateExisting       Controls update handling.
                        true  - If an object already exists, then update it instead of add.
                        false - If an object already exists, do not update it

   ExportFlags          Controls child object exporting.
                        Values are additive.
                        1 -- export applications
                        2 -- export permissions
                        4 -- export logical views
                        8 -- export dependent objects

   ExportEncoding       Codepage of exported data. Must be an Integer. Ignored for non export actions.

odc - Instance of ODCallback object for processBegin/End calls

Returns:

A byte array containing the XML response

Throws:

ODException

java.lang.Exception

xmlParse

public byte[] xmlParse(java.lang.String xml,
                       int action,
                       boolean continueOnError,
                       int exportFlags,
                       int exportEncoding,
                       java.lang.String exportSchemaLocation,
                       ODCallback odc)
                throws java.lang.Exception

Deprecated. Use ODServer.xmlParse(String, int, boolean, int, int, ODCallback). Deprecated at v10.5.

Interface to arsxml batch administration client. NOTE: As of 10.1.0.6+, ExportSchemaLocation is ignored. XML processing has changed to expect the OnDemand schema file in the <OnDemand install dir>/xml only, regardless of what is found in the xml.

Parameters:

xml - This is data to be parsed by arsxml. It must be fully composed XML.

action - Action to take on input xml.

continueOnError - Continue processing even if error encountered.

exportFlags - Controls child object exporting.

exportEncoding - Codepage of exported data. Ignored for non export actions.

exportSchemaLocation - Path to include as part of noNamespaceSchemaLocation attribute.

odc - Instance of ODCallback object for processBegin/End calls

Returns:

A byte array containing the XML response

Throws:

ODException

java.lang.Exception

xmlParse

public byte[] xmlParse(java.lang.String xml,
                       int action,
                       boolean continueOnError,
                       int exportFlags,
                       int exportEncoding,
                       ODCallback odc)
                throws java.lang.Exception

Interface to arsxml batch administration client.

Parameters:

xml - This is data to be parsed by arsxml. It must be fully composed XML.

action - Action to take on input xml.

continueOnError - Continue processing even if error encountered.

exportFlags - Controls child object exporting.

exportEncoding - Codepage of exported data. Ignored for non export actions.

odc - Instance of ODCallback object for processBegin/End calls

Returns:

A byte array containing the XML response

Throws:

ODException

java.lang.Exception

getInternalDate

public long getInternalDate(java.lang.String date,
                            java.lang.String fmt,
                            char qual)

Convert date string to OnDemand Internal date format.

Parameters:

date - String containing user readable date.

fmt - String with date format of input date string. Will use default date format if a date format is not specified.

qual - ODConstant for date type.

Returns:

long representing the internal date value. A value of -1 indicates a failure, usually involving invalid format or etc.

See Also:

ODConstant.ODDATE_DATE, ODConstant.ODDATE_DATETIME, ODConstant.ODDATE_TIME, ODConstant.ODDATE_TZ_DATETIME

getCurrentDate

public long getCurrentDate(char qual)

Return the current date in the OnDemand Internal date format.

Parameters:

qual - ODConstant for date type.

Returns:

long representing the internal date value. A value of -1 indicates a failure, usually involving invalid format.

See Also:

ODConstant.ODDATE_DATE, ODConstant.ODDATE_DATETIME, ODConstant.ODDATE_TIME, ODConstant.ODDATE_TZ_DATETIME

getExternalDate

public java.lang.String getExternalDate(long internalDate,
                                        java.lang.String fmt,
                                        char qual)

Convert an OnDemand Internal date format to a formatted string

Parameters:

internalDate - a long value that represents an internal date value.

fmt - String with date format of input date string. Will use default date format if a date format is not specified.

qual - ODConstant for date type.

Returns:

date String containing user readable date. Null if an error occurs.

See Also:

ODConstant.ODDATE_DATE, ODConstant.ODDATE_DATETIME, ODConstant.ODDATE_TIME, ODConstant.ODDATE_TZ_DATETIME

getTransformViewersForDocType

public java.util.Hashtable getTransformViewersForDocType(char doctype)
                                                  throws java.lang.Exception

Get a listing of Transform viewer names that are defined for a specific docType. In order for the Transform viewer to be returned for the docType, the ODFileType node must be included as a child node of the transform node.

For example,

 
 <transform>
 	<TransformName>LineTransform</TransformName>
 	<ODFileType>L</ODFileType>
  ...
  </transform>
  
  

Parameters:

doctype -

Returns:

Hashtable of Name and Descriptions. Will return null if not defined.

Throws:

java.lang.Exception

See Also:

ODConstant.FileTypeAFP, ODConstant.FileTypeLINE

getAllTransformViewerNames

public java.lang.String[] getAllTransformViewerNames()
                                              throws java.lang.Exception

Get all ODTransform names as specified in the transform.xml

Returns:

String[] of ODTransform names

Throws:

java.lang.Exception

See Also:

ODConfig.hasODTransforms()

getAllTransformViewers

public java.util.Enumeration getAllTransformViewers()
                                             throws java.lang.Exception

Get all ODTransform defined in the transform.xml

Returns:

Enumeration of ODTransforms

Throws:

java.lang.Exception

See Also:

ODConfig.hasODTransforms()

getTransformViewer

public ODTransform getTransformViewer(java.lang.String vwrName)
                               throws ODException

Get the specified ODTransform as specified in the transform.xml

Parameters:

vwrName - Name of ODTransform

Returns:

ODTransform

Throws:

java.lang.Exception

ODException

See Also:

ODConfig.hasODTransforms()

getVersion

public java.lang.String getVersion()

Get the ODWEK Version string.

Returns:

String indicating the Release and PTF version of ODWEK.

getMessageOfTheDay

public java.lang.String getMessageOfTheDay()

updateTraceLevel

public void updateTraceLevel(java.lang.String szNewLevel)
                      throws ODException

Update the trace level at which events will be logged.

NOTE: This method should be used only as instructed by IBM Support.

Setting this parameter has a global effect. The value that is passed as the newLevel will apply to the level of tracing for all ODServer objects in the ODWEK instance, not just the ODServer from which the updateTraceLevel call is made.

The value returned by ODConfig.getTraceLevel() will not be effected by this call and will continue to return the value set in the ODConfig constructor.

Parameters:

szNewLevel - The new trace level as provided by IBM Support

Throws:

ODException

loadInit

public void loadInit()
              throws java.lang.Exception

The first call made in a series that will load n number of documents as a single load. This process is similar to the ODFolder.storeDocument(String, String, String, String[]) method in that documents are added in an ad-hoc fashion to be loaded. It differs, however, in that n number of documents may be added to a bundle using the ODServer.loadAddDoc(int, Hashtable, File) method and the entire bundle will be loaded in a single call to the OnDemand server using the ODServer.loadCommit(String, String) method.

This method performs the set-up for a load and can be set to an uninitialized state using the ODServer.loadReset() method.

NOTE: The OnDemand Server must be at V9.5.0.0 or higher to support this functionality.

Throws:

ODException - An ODException is thrown if this method is called when a load process is already in progress. An ODException could also be thrown if a temporary file cannot be written to the TempDir.

java.lang.Exception

See Also:

ODServer.hasPermToLoad(String, String), ODServer.loadAddDoc(int, Hashtable, File), ODServer.loadAddDoc(int, Hashtable, byte[]), ODServer.loadCommit(String, String), ODServer.loadReset()

loadAddDoc

public void loadAddDoc(int numPages,
                       java.util.Hashtable idxs_vals,
                       java.io.File file)
                throws java.lang.Exception

The second call made in a series that will load n number of documents as a single load. This process is similar to the ODFolder.storeDocument(String, String, String, String[]) method in that documents are added in an ad-hoc fashion to be loaded. It differs, however, in that n number of documents may be added to a bundle using this method and the entire bundle will be loaded in a single call to the OnDemand server using the ODServer.loadCommit(String, String) method.

This method prepares a bundle of document(s) and index value(s) to be loaded into the OnDemand archive. It can be called n number of times, once for each document that is being added to the load. It must be called after the ODServer.loadInit() method.

Date and Date/Time (with and without TZ) formats must be standardized using the ISO format
The format to specify a Date in is %Y-%m-%d
  2014-11-13
The format to specify a Date/Time (with and without TZ) in is %Y-%m-%d %H:%M:%S.%F
  2014-11-13 14:07:00.000000

NOTE: The OnDemand Server must be at V9.5.0.0 or higher to support this functionality.

Parameters:

numPages - - The number of pages in the document that is being stored. This value will be ignored if an Application Group field of type "Page Count" is not defined in the Application Group.

idxs_vals - - Hashtable of Application Group fields (keys) and the corresponding values to store for this document.

file - - The file to be added to the OnDemand archive.

Throws:

ODException - - An ODException will be thrown if the ODServer.loadInit() method has not yet been called. An ODException will also be thrown if the specified file cannot be found or is empty.

java.lang.Exception

See Also:

ODServer.hasPermToLoad(String, String), ODServer.loadInit(), ODServer.loadCommit(String, String), ODServer.loadReset()

loadAddDoc

public void loadAddDoc(int numPages,
                       java.util.Hashtable idxs_vals,
                       byte[] b)
                throws java.lang.Exception

The second call made in a series that will load n number of documents as a single load. This process is similar to the ODFolder.storeDocument(String, String, String, String[]) method in that documents are added in an ad-hoc fashion to be loaded. It differs, however, in that n number of documents may be added to a bundle using this method and the entire bundle will be loaded in a single call to the OnDemand server using the ODServer.loadCommit(String, String) method.

This method prepares a bundle of document(s) and index value(s) to be loaded into the OnDemand archive. It can be called n number of times, once for each document that is being added to the load. It must be called after the ODServer.loadInit() method.

Date and Date/Time (with and without TZ) formats must be standardized using the ISO format
The format to specify a Date in is %Y-%m-%d
  2014-11-13
The format to specify a Date/Time (with and without TZ) in is %Y-%m-%d %H:%M:%S.%F
  2014-11-13 14:07:00.000000

NOTE: The OnDemand Server must be at V9.5.0.0 or higher to support this functionality.

Parameters:

numPages - - The number of pages in the document that is being stored. This value will be ignored if an Application Group field of type "Page Count" is not defined in the Application Group.

idxs_vals - - Hashtable of Application Group fields (keys) and the corresponding values to store for this document.

b - The bytes to be added to the OnDemand archive.

Throws:

ODException - - An ODException will be thrown if the ODServer.loadInit() method has not yet been called. An ODException will also be thrown if the specified file cannot be found or is empty.

java.lang.Exception

See Also:

ODServer.hasPermToLoad(String, String), ODServer.loadInit(), ODServer.loadCommit(String, String), ODServer.loadReset()

loadCommit

public void loadCommit(java.lang.String agname,
                       java.lang.String appname)
                throws java.lang.Exception

The third call made in a series that will load n number of documents as a single load. This process is similar to the ODFolder.storeDocument(String, String, String, String[]) method in that documents are added in an ad-hoc fashion to be loaded. It differs, however, in that n number of documents may be added to a bundle using the ODServer.loadAddDoc(int, Hashtable, File) method and the entire bundle will be loaded in a single call to the OnDemand server using the ODServer.loadCommit(String, String) method.

This method is called when all documents have been added via the ODServer.loadAddDoc(int, Hashtable, File) method. It will call to the OnDemand server to perform the load into the archive. All documents that are added must be added for a single Application Group/Application combination.

Regardless of whether or not the operation completes successfully, the load operation (loadInit, loadAddDocs, loadCommit) will be reset back to the uninitialized state upon completion. If the load fails for any reason on the OnDemand server, none of the documents in the bundle will be loaded.

NOTE: The OnDemand Server must be at V9.5.0.0 or higher to support this functionality.

NOTE: There is no way to store data as Large Object using this load process. If the specified application is Large Object enabled, that attribute will be ignored.

Parameters:

agname - - The name of the Application Group to be used for the load

appname - - The name of the Application to be used for the load

Throws:

ODException - - An ODException will thrown if the ODServer.loadInit() method and the ODServer.loadAddDoc(int, Hashtable, File) methods have not been called first. Also, at least one document must be added to the bundle to be loaded before calling this method. If the load fails to complete for any reason on the OnDemand server, the details of the failure can be found in the System Log and an ODException will be thrown.

java.lang.Exception

See Also:

ODServer.hasPermToLoad(String, String), ODServer.loadInit(), ODServer.loadAddDoc(int, Hashtable, File), ODServer.loadAddDoc(int, Hashtable, byte[]), ODServer.loadReset()

loadReset

public void loadReset()

An optional utility call that will reset the load process state back to uninitialized.

NOTE: The OnDemand Server must be at V9.5.0.0 or higher to support this functionality.

See Also:

ODServer.hasPermToLoad(String, String), ODServer.loadInit(), ODServer.loadAddDoc(int, Hashtable, File), ODServer.loadAddDoc(int, Hashtable, byte[]), ODServer.loadCommit(String, String)

getServerVersion

public java.lang.String getServerVersion()
                                  throws java.lang.Exception

Get the OnDemand Server version string.

Returns:

String indicating the Release and PTF version of the Server.

Throws:

ODException - if the ODServer is not logged on.

java.lang.Exception

hasPermToLoad

public boolean hasPermToLoad(java.lang.String fldrName,
                             java.lang.String applGrpName)
                      throws java.lang.Exception

Determines if conditions are in place for the logged on user to perform the load operations through ODWEK. This function returns true when all of the following conditions are met:

• the logged-on user has document add permissions on the OnDemand Server for the Application Group specified
• the Server version is at 9.5 or later
• the Application Group is NOT one of the OnDemand System objects; for example, the System Log, System Migration, etc.
• the Folder does NOT contain a transaction field (folder field mapping type of Range)

Parameters:

fldrName -

applGrpName -

Returns:

boolean

Throws:

ODException - if the Application Group or Folder name is not valid

java.lang.Exception

See Also:

ODServer.loadInit(), ODServer.loadAddDoc(int, Hashtable, File), ODServer.loadAddDoc(int, Hashtable, byte[]), ODServer.loadCommit(String, String), ODServer.loadReset()

getHeaders

public java.util.Hashtable getHeaders()