com.ibm.b2bi.im
Class Preferences

java.lang.Object
  |
  +--com.ibm.b2bi.im.Preferences

public final class Preferences
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
static java.lang.String AMS_SERVICES_PROVIDER
           
static java.lang.String AUDIT_HOOK
           
static java.lang.String BFM_SERVICES_PROVIDER
           
static java.lang.String copyrightNotice
           
static boolean EXCEPTIONS
           
static boolean LOGGING
           
static int REFRESH_INTERVAL
           
static boolean TRACE
           
static java.lang.String WORKFLOW_SERVICES_PROVIDER
           
 
Constructor Summary
Preferences()
           
 
Method Summary
static DirectoryServices getDirectory()
          Returns an instance of DirectoryServices class.
static void sendException(java.lang.String errorCode, java.lang.String source, java.lang.Throwable error, java.lang.String info)
          Sends the exception information to the Exception Manager through the exception manager client object.
static void sendTraceMsg(long type, java.lang.String className, java.lang.String methodName, java.lang.String msgKey, java.lang.Object param)
          Helps to insert trace messages.
static void setAwareletData()
          Initializes Inbox configuration information during startup.
static void setImData()
          Loads configuration information for Interaction Manager from various sources at startup time.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyrightNotice

public static final java.lang.String copyrightNotice

TRACE

public static boolean TRACE

EXCEPTIONS

public static boolean EXCEPTIONS

LOGGING

public static boolean LOGGING

AUDIT_HOOK

public static java.lang.String AUDIT_HOOK

REFRESH_INTERVAL

public static int REFRESH_INTERVAL

AMS_SERVICES_PROVIDER

public static java.lang.String AMS_SERVICES_PROVIDER

BFM_SERVICES_PROVIDER

public static java.lang.String BFM_SERVICES_PROVIDER

WORKFLOW_SERVICES_PROVIDER

public static java.lang.String WORKFLOW_SERVICES_PROVIDER
Constructor Detail

Preferences

public Preferences()
Method Detail

getDirectory

public static DirectoryServices getDirectory()
Returns an instance of DirectoryServices class.

sendException

public static void sendException(java.lang.String errorCode,
                                 java.lang.String source,
                                 java.lang.Throwable error,
                                 java.lang.String info)
Sends the exception information to the Exception Manager through the exception manager client object.
Parameters:
errorCode - Error number with in IME/IMW sequence
source - Class::Method name which is throwing the exception
error - Instance of Throwable object containing exception information. If it is null, the info parameter is used to build the exception message.
info - Additional error information not contained in the exception object.

sendTraceMsg

public static void sendTraceMsg(long type,
                                java.lang.String className,
                                java.lang.String methodName,
                                java.lang.String msgKey,
                                java.lang.Object param)
Helps to insert trace messages.
Parameters:
type - Error type. Values should be 1/2/3 only.
className - Class name that is logging the trace.
methodName - Method name that is logging the trace.
msgKey - Key code of the message as specified in the messages propery file of IM module.
paramList - List of values as parameters to standard messages.

setAwareletData

public static void setAwareletData()
                            throws IMException
Initializes Inbox configuration information during startup.

setImData

public static void setImData()
                      throws IMException,
                             DirectoryServicesException
Loads configuration information for Interaction Manager from various sources at startup time. This is called only once during the life time of a servlet engine. So, any updates to the configuration requires, restarting of the web application/web application server in which base IM services are hosted.