com.ibm.workflow.servlet.client
Class ApplicationContextProxy

java.lang.Object
  |
  +--com.ibm.workflow.servlet.client.ApplicationContextProxy
All Implemented Interfaces:
ApplicationContext
Direct Known Subclasses:
LogonContext, SessionContextProxy

public class ApplicationContextProxy
extends java.lang.Object
implements ApplicationContext


Constructor Summary
ApplicationContextProxy()
           
 
Method Summary
 java.lang.String formatDate(java.util.Date date)
           
 java.lang.String formatTime(java.util.Date date)
           
 com.ibm.workflow.api.Agent getAgent()
          Query the Web Client's agent.
 BuiltinHandler getBuiltinHandler()
          This method allows to access the builtin command handler.
 Config getConfig()
          This method allows to access the Web Client's configuration.
 java.lang.String getDocumentRoot()
          Query the Web Client's document root directory.
 java.lang.String getJavaApiVersionInfo()
           
 java.lang.String getRealPath(java.lang.String file)
           
 java.lang.String getRootURI()
          Query the Web Client's root URI.
 java.lang.String getServerInfo()
           
 java.lang.String getServletVersion()
           
 java.lang.String getTriggerTagFor(int list, RequestContext context)
           
 java.lang.String getURL(java.lang.String file)
          Convert a URL relative to the servlet's root URI.
 boolean isDebugEnabled()
          Query the level of tracing set in the WebClient.properties file.
 boolean isUsingJNDI()
          Check if the deprecated locator policy JNDI_Locator is active.
 void log(java.lang.String logEntry, boolean log)
           
 void log(java.lang.String logEntry, java.lang.Throwable xcpt)
           
 boolean useQueryResultSize()
          Checks if the Web Client should use the queryResultSize() API call.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ApplicationContextProxy

public ApplicationContextProxy()
Method Detail

getServerInfo

public final java.lang.String getServerInfo()
Specified by:
getServerInfo in interface ApplicationContext

getServletVersion

public final java.lang.String getServletVersion()
Specified by:
getServletVersion in interface ApplicationContext

getJavaApiVersionInfo

public final java.lang.String getJavaApiVersionInfo()
Specified by:
getJavaApiVersionInfo in interface ApplicationContext

getTriggerTagFor

public final java.lang.String getTriggerTagFor(int list,
                                               RequestContext context)
                                        throws com.ibm.workflow.api.FmcException
Specified by:
getTriggerTagFor in interface ApplicationContext

getConfig

public final Config getConfig()
Description copied from interface: ApplicationContext
This method allows to access the Web Client's configuration.
Specified by:
getConfig in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Returns:
The configuration

getBuiltinHandler

public final BuiltinHandler getBuiltinHandler()
Description copied from interface: ApplicationContext
This method allows to access the builtin command handler.
Specified by:
getBuiltinHandler in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Returns:
The builtin command handler

log

public final void log(java.lang.String logEntry,
                      java.lang.Throwable xcpt)
Specified by:
log in interface ApplicationContext

log

public final void log(java.lang.String logEntry,
                      boolean log)
Specified by:
log in interface ApplicationContext

getURL

public java.lang.String getURL(java.lang.String file)
Description copied from interface: ApplicationContext
Convert a URL relative to the servlet's root URI. to an absolute URL. For example,
context.getURL("{_HTMLDir_}/images/myImage.gif");
might result in
/MQWFClient/images/myImage.gif
Specified by:
getURL in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Parameters:
file - A relative URL.
Returns:
An absolute URL.

getRootURI

public final java.lang.String getRootURI()
Description copied from interface: ApplicationContext
Query the Web Client's root URI.
Specified by:
getRootURI in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Returns:
The root URI.

getDocumentRoot

public final java.lang.String getDocumentRoot()
Description copied from interface: ApplicationContext
Query the Web Client's document root directory.
Specified by:
getDocumentRoot in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Returns:
The document root directory.

getRealPath

public final java.lang.String getRealPath(java.lang.String file)
Specified by:
getRealPath in interface ApplicationContext

formatDate

public final java.lang.String formatDate(java.util.Date date)
Specified by:
formatDate in interface ApplicationContext

formatTime

public final java.lang.String formatTime(java.util.Date date)
Specified by:
formatTime in interface ApplicationContext

getAgent

public final com.ibm.workflow.api.Agent getAgent()
                                          throws java.beans.PropertyVetoException
Description copied from interface: ApplicationContext
Query the Web Client's agent. This agent can be used to locate ExecutionService objects and to log on.
Specified by:
getAgent in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Parameters:
context - the request context
Returns:
The Agent object.
Throws:
java.beans.PropertyVetoException - if an error occured.

isDebugEnabled

public final boolean isDebugEnabled()
Description copied from interface: ApplicationContext
Query the level of tracing set in the WebClient.properties file.
Specified by:
isDebugEnabled in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Returns:
true if 'debugMode' is set to true in WebClient.properties.

isUsingJNDI

public final boolean isUsingJNDI()
Description copied from interface: ApplicationContext
Check if the deprecated locator policy JNDI_Locator is active.
Specified by:
isUsingJNDI in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Returns:
true if 'Agent_Locator' is set to JNDI_LOCATOR in WebClient.properties

useQueryResultSize

public boolean useQueryResultSize()
Description copied from interface: ApplicationContext
Checks if the Web Client should use the queryResultSize() API call.
Specified by:
useQueryResultSize in interface ApplicationContext
Following copied from interface: com.ibm.workflow.servlet.client.ApplicationContext
Returns:
true if 'useQueryResultSize' is set to 'true' in WebClient.properties


© Copyright IBM Corporation 1999, 2008. All Rights Reserved.