|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmController
This is the framework controller base class. It is abstract, therefore
it must be subclassed and have the required methods implemented in order
to be useful.
Framework pages instantiate an implemented controller, and register their
modules with it and call the handleEvent method wich will in turn do the
following steps:
... <%-- CONTROLLER --%> <jsp:useBean id="controller" class="com.filenet.wcm.toolkit.server.controller.WcmWorkplaceController" scope="request"/> ... <% ... controller.configurePage(application, request); controller.registerModule(myBean); controller.registerModule(testBean); controller.handleEvent(application, request, response, true); %>
Nested Class Summary | |
protected class |
WcmController.GetWriterResponse
This is a wrapping of HttpServletResponse, so that we can intercept calls to sendRedirect. |
class |
WcmController.WcmEventRequest
This is a wrapping of HttpServletRequest so that we can intercept calls to getParameter... |
class |
WcmController.WindowProperties
This object provides access to the controller properties of the windowId that it was constructed for. |
class |
WcmController.WorkplacePrintWriter
This is a wrapping of PrintWriter, Special to add flush to write calls. |
Field Summary | |
protected static long |
ALL_FLAGS_MASK
|
protected javax.servlet.ServletContext |
application
|
protected static WcmBootstrapPrefs |
bootstrap
|
static java.lang.String |
BOOTSTRAP_PROPERTIES_KEY
|
protected static long |
COMPAT_FLAGS_MASK
|
protected static java.util.HashMap |
controllerEvents
|
static long |
CREATE_INLINE
For use as a WcmParameter.WINDOW_ID_MODE request parameter only. |
static java.lang.String |
CREATE_INLINE_KEY
|
static long |
CREATE_POPUP
For use as a WcmParameter.WINDOW_ID_MODE request parameter only. |
static java.lang.String |
CREATE_POPUP_KEY
|
protected static long |
CREATE_PRIVATE_FLAG
|
static long |
CREATE_WINDOW_ID
Deprecated. - use CREATE_POPUP as a windowIdMode request parameter. |
static java.lang.String |
CREDENTIALS_BEAN_KEY
|
static java.lang.String |
CURRENT_MODULE_KEY
Default value for heading mode. |
protected javax.servlet.http.HttpServletRequest |
currentRequest
|
protected javax.servlet.http.HttpServletResponse |
currentResponse
|
protected WcmDataStore |
dataStore
|
protected static java.lang.String |
DEFER_REWRITE_KEY
|
protected int |
deferPostThreshold
|
protected boolean |
deferRedirect
|
protected java.lang.String |
deferredURL
|
protected static boolean |
DISABLE_BROWSER_CACHING
|
protected static boolean |
DUMP_DATASTORE_KEYS
|
protected static java.lang.String |
FIRST_WINDOWID_KEY
Deprecated. Use get/setFirstWindowId signatures. |
protected static long |
FLAGS_MASK
|
protected static long |
HASH_PRIVATE_FLAG
|
static java.lang.String |
HEADER_MODULE
The name of the header rendering module |
static java.lang.String |
HEADER_MODULE_NAME
When an instance of WcmHeaderModuleInterface is registered with the controller, its module name is forced to this value. |
protected static java.lang.String |
HELP_CONTEXT_KEY
|
protected static java.lang.String |
HELP_PAGE_KEY
|
protected static WcmHelpMap |
helpMap
|
static java.lang.String |
HOME_KEY
Deprecated. use set/getHome signatures. |
static long |
IGNORE_WINDOW_ID
IGNORE_WINDOW_ID can be passed as a third parameter to configurePage. |
protected UserTokenPolicyInterface |
internalTokenPolicy
|
protected java.lang.Exception |
lastTokenException
|
protected boolean |
loginEnabled
|
static java.lang.String |
MAIN_WINDOW
Defines the default windowId value when not in a popup. |
static java.lang.String |
NAMED_CONTROLLERS_KEY
Defines an attribute key/value on the request object (HttpServletRequest) Where controllers will register themselves by name into a hash map to verify that no two are dups if multiple are created during the course of a single request. |
protected boolean |
newPageParams
|
static long |
NO_EXPIRE_FLAG
|
protected static long |
NO_REWRITE_PRIVATE_FLAG
|
static long |
NO_WINDOW_ID
NO_WINDOW_ID can be passed as a third parameter to configurePage. |
protected boolean |
noRequestParams
|
protected static WcmException |
noWindowIdError
|
protected boolean |
okToRedirect
|
protected boolean |
okToRegister
|
protected java.lang.String |
pageName
|
static long |
POPUP_FLAG
|
protected static java.lang.String |
POPUP_KEY
Deprecated. No longer used. |
protected static int |
popWindowIDCycleMax
|
protected static boolean |
popWindowIDUsePageName
|
protected static java.util.HashMap |
preControllerEvents
|
protected static long |
PRIVATE_FLAGS_MASK
|
static long |
PROPAGATE_WINDOW_ID
PROPOGATE_WINDOW_ID (DEFAULT) can be passed as a third parameter to configurePage. |
protected static long |
PROPOGATE_ID
|
protected static long |
PROPOGATE_MASK
|
protected static long |
PROPOGATE_NONE
|
static long |
PROPOGATE_WINDOW_ID
Deprecated. - use PROPAGATE_WINDOW_ID |
protected static long |
PUSH_PREV_PRIVATE_FLAG
|
protected static java.lang.String |
REDIRECT
|
protected static long |
REQUIRE_ID
|
protected static long |
REQUIRE_MASK
windowIdMode components... |
static long |
REQUIRE_WINDOW_ID
REQUIRE_WINDOW_ID can be passed as a third parameter to configurePage. |
protected boolean |
sendRedirectCalled
|
protected static java.lang.String |
SESSION_COUNT
|
protected WcmSignInPolicyInterface |
signInPolicy
|
static java.lang.String |
SSL_PROTOCOL
Defines the protocol portion of the URL for SSL. |
protected WcmSSLInfo |
sslInfo
|
protected java.util.Map |
tempProperties
|
protected WindowIDFactory |
widFactory
|
protected static java.lang.String |
WINDOW_SIGNED_IN_KEY
Deprecated. Use isPopupSignedIn. |
protected boolean |
windowIdAssigned
|
protected boolean |
windowIdCreated
|
protected long |
windowIdMode
|
protected java.lang.String[] |
windowIdParams
Deprecated. |
protected boolean |
windowIdRecovered
|
protected static WcmString |
wsPopupSessionExpired
|
Constructor Summary | |
WcmController()
|
Method Summary | |
protected void |
assignWindowId(WindowID newWindowId,
WindowID currentWindowId,
boolean popupCreated)
Assigns the window ID. |
protected boolean |
catchPopupExceptions()
Override to customize WcmController behavior. |
boolean |
checkLogin(java.lang.String currentUrl,
javax.servlet.http.HttpServletRequest request)
Checks to see if the session has valid credentials. |
protected void |
checkName(javax.servlet.http.HttpServletRequest request)
|
void |
cleanupWindowId(java.lang.String windowId)
Schedules a cleanup of the storage allocated to the specified windowId, to occur in one minute from the time the call is made. |
void |
cleanupWindowId(java.lang.String windowId,
long timeout)
Schedules a cleanup of the storage allocated to the specified windowId, to occur in specified interval. |
boolean |
closeWindow()
Call this method to close the current browser window. |
boolean |
closeWindow(javax.servlet.http.HttpServletResponse response)
Call this method to close the current browser window. |
void |
configureDataProviders()
No root-level data providers are defined in WcmWorkplaceController. |
void |
configureHeaderModule()
Configures the default toolkit implementation - WcmHeaderModule. |
void |
configurePage(javax.servlet.ServletContext applicationValue,
javax.servlet.http.HttpServletRequest request)
Call this before making any calls to registerModule. |
void |
configurePage(javax.servlet.ServletContext applicationValue,
javax.servlet.http.HttpServletRequest request,
boolean windowIdRequired)
Deprecated. Use configurePage(application, request, long windowIdMode). |
void |
configurePage(javax.servlet.ServletContext applicationValue,
javax.servlet.http.HttpServletRequest request,
int windowIdMode)
Deprecated. use configurePage(ServletContext, HttpServletRequest, long) |
void |
configurePage(javax.servlet.ServletContext applicationValue,
javax.servlet.http.HttpServletRequest request,
int windowIdMode,
java.lang.String[] windowIdParams)
Deprecated. |
void |
configurePage(javax.servlet.ServletContext applicationValue,
javax.servlet.http.HttpServletRequest request,
long windowIdMode)
Call this before making any calls to registerModule. |
protected void |
configurePageName(javax.servlet.http.HttpServletRequest request)
|
protected java.lang.String |
constructTargetUrl(javax.servlet.http.HttpServletRequest request,
boolean dropWindowId)
|
protected WindowID |
createWindowId(long createValue,
javax.servlet.http.HttpServletRequest request,
long flags)
|
java.lang.String |
encodeUserToken(java.lang.String url)
Appends user token to the url if tokens are enabled |
protected java.lang.String |
encodeWindowId(java.lang.String url)
|
protected java.lang.String |
executeModel(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
boolean skipEventProcessing,
java.lang.String eventTarget)
executeModel takes care of module initialization and event routing. |
protected boolean |
forceSignInToDefaultPage()
Override and return true to cause all logins to go to the configured default page. |
java.lang.String |
generateUserToken()
Generates user token if tokens are enabled. |
java.io.InputStream |
getApplicationResource(java.lang.String path)
|
protected java.lang.String |
getBaseURL()
Deprecated. - use getWebappRootURL() |
protected java.lang.String |
getBootstrapFile()
|
java.lang.String |
getClientCharacterEncoding()
Return the client's character encoding value for the current request. |
java.util.Locale |
getClientLocale()
Return the client locale value of the current request. |
java.util.TimeZone |
getClientTimeZone()
Gets the TimeZone object used to convert date values from ISO to UI display, and back to ISO again. |
protected javax.servlet.http.HttpServletRequest |
getCurrentRequest()
Returns the current HttpServletRequest object. |
WcmDataStore |
getDataStore()
Returns the instance of WcmDataStore. |
protected WcmDataStore |
getDataStore(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request)
Returns the instance of WcmDataStore. |
boolean |
getDebugTrace()
Returns true or false whether debug tracing is enabled in web.xml. |
java.lang.String |
getEncodedSessionId()
Get the Java/JSP session id. |
WcmErrorMessageBox |
getErrorMessageBox(java.lang.Throwable t)
Factory method. |
static boolean |
getErrorTrace()
Return whether or not error tracing is currently turned on. |
protected java.lang.String |
getEventBaseURL()
|
protected java.lang.String |
getFirstWindowId()
|
WcmHeaderModuleInterface |
getHeaderModule()
Get the registered header module. |
java.lang.String |
getHelpContext()
Get the supplemental help context value In the WcmController "Help" event, a help HTML file name is calculated based on the current page id, concatenated with the help context value in the form: http://docServer/helpRootPath/yourpageid [ _helpcontext ] .html |
java.lang.String |
getHelpPage()
Get the help page id value In the WcmController "Help" event, a help HTML file name is calculated based on the current page id (or user-defined value), concatenated with the help context value in the form: http://docServer/helpRootPath/ [ helppageid ] _helpcontext.html |
static java.lang.String |
getHelpURL(java.lang.String baseUrl,
java.lang.String helpPage,
java.lang.String helpContext)
Static method to get the context sensitive help URL for the current page. |
protected java.lang.String |
getHomeURL()
Get the home URL for the current controller windowId value. |
protected java.lang.String |
getHomeURL(java.lang.String windowId)
Get the home URL for the specified windowId value. |
protected java.lang.String |
getHomeURLKey(java.lang.String windowId)
Deprecated. Use the accessors instead. |
java.lang.String |
getInitParameter(java.lang.String key)
Gets an init parameter from the servlet Descriptor. |
boolean |
getInitParameter(java.lang.String key,
boolean defaultValue)
Gets an init parameter from the servlet Descriptor. |
long |
getInitParameter(java.lang.String key,
long defaultValue)
Gets an init parameter from the servlet Descriptor. |
java.lang.String |
getInitParameter(java.lang.String key,
java.lang.String defaultValue)
Gets an init parameter from the servlet Descriptor. |
boolean |
getInitParameterBoolean(java.lang.String key)
Gets an init parameter from the servlet Descriptor. |
UserTokenPolicyInterface |
getInternalTokenPolicy()
|
java.lang.Exception |
getLastTokenException()
|
java.lang.String |
getLocalIP()
Returns the local IP number for the machine where this page is running. |
java.lang.String |
getLoginRoutingInfo()
For thick clients, return the information necessary so that they know how to set credentials in the session. |
protected static java.lang.reflect.Method |
getMethod(java.lang.Class c,
java.lang.String methodName,
java.lang.Class[] paramList)
|
java.lang.String |
getName()
Get the controller name. |
java.lang.String |
getNewPageParameter(java.lang.String key)
When a page is loaded with a request string that specifies parameters but no eventTarget/eventName, the request parameters are stored away by the controller. |
java.lang.String |
getPageId()
Returns the current page ID relative to the application root, which is of the form [ [path/] path/ ]page.jsp. |
java.lang.String |
getPageName()
Returns the current page name relative to the application root, which is of the form [ [path/] path/ ]page.jsp. |
java.lang.String |
getPageParameter(java.lang.String key)
When a page is loaded with a request string that specifies parameters but no eventTarget/eventName, the request parameters are stored away by the controller. |
java.util.Enumeration |
getPageParameterNames()
|
java.util.Hashtable |
getPageParameters()
Gets a Hashtable instance containing a copy of all the current page parameters. |
java.lang.String[] |
getPageParameters(java.lang.String key)
When a page is loaded with a request string that specifies parameters but no eventTarget/eventName, the request parameters are stored away by the controller. |
java.lang.String |
getPageParameterString(java.lang.String key)
|
protected java.lang.String |
getParameter(java.util.Map map,
java.lang.String key)
|
protected java.lang.String[] |
getParameters(java.util.Map map,
java.lang.String key)
|
protected java.lang.Exception |
getPopupException(java.lang.Exception e)
Construct the popup wrapper exception. |
int |
getPOSTThreshold()
|
java.lang.Object |
getProperty(java.lang.String key)
Get the controller property - from the DataStore scoped to the page. |
java.lang.Object |
getRequestAttribute(java.lang.String key)
Get a request attribute from the request that this controller is referencing. |
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String path)
Get the request dispatcher from the ServletContext that this controller is referencing. |
java.util.Locale |
getRequestedClientLocale()
Return the primary locale of the current request. |
static java.lang.String |
getRequestHash(javax.servlet.http.HttpServletRequest request)
|
protected WcmServerCredentials |
getServerCredentials()
|
javax.servlet.ServletContext |
getServletContext()
Returns the ServletContext (application) |
java.lang.String |
getSessionId()
Get the Java™ or Java™Server Pages session id. |
WcmSignInPolicyInterface |
getSignInPolicy()
Factory method. |
protected WcmSSLInfo |
getSSLInfo()
Singleton factory method. |
StaticInitializerInterface |
getStaticInitializer()
getStaticInitializer. |
WcmSystem |
getSystemInfo()
Factory method. |
java.lang.Object |
getTemporaryProperty(java.lang.String key)
Gets a property that is scoped to this controller instance. |
static java.lang.String |
getTime(java.lang.String key)
Retrieves average time of execution of the specified instrumented segment of code. |
static java.lang.Object[] |
getTimerKeys()
Get an array of all of the timer keys currently present. |
java.lang.String |
getUIRoot()
Returns the relative path to the root location of the UI jsp's. |
UserAgent |
getUserAgent()
Return the UserAgent object for the current request. |
WcmUserInformationInterface |
getUserInfo()
Return the singleton instance of WcmUserInformationInterface if it is currently defined in the session. |
UserTokenPolicyInterface |
getUserTokenPolicy()
|
java.lang.String |
getWebappRootURL()
Gets the context root URL for the current user session. |
java.lang.String |
getWindowId()
Returns the current windowId hash value, or the keyword "mainWindow" if there is not a current windowId in effect. |
static java.lang.String |
getWindowId(javax.servlet.http.HttpServletRequest request)
Returns the windowId from the request, if present. |
protected boolean |
getWindowIdCompatibility()
|
protected WindowIDFactory |
getWindowIDFactory()
Get the widFactory instance to use to create a new window ID. |
static java.lang.String |
getWindowIdFromReferer(javax.servlet.http.HttpServletRequest request)
Retreives the window ID from the referer URL. |
static java.lang.String |
getWindowIdFromReferer(java.util.Map popups,
java.lang.String referer)
Deprecated. use getWindowIdFromURL(url, baseUrl) |
static java.lang.String |
getWindowIdFromURL(java.lang.String url,
java.lang.String baseUrl)
Returns a windowId based on the referer URL and the current popups list. |
protected long |
getWindowIdModeValue(java.lang.String symbolicMode)
|
protected long |
getWindowIdModeValue(java.lang.String symbolicMode,
boolean noExpireFlag)
|
WindowID |
getWindowIdObject()
Returns the current windowId hash value, or the keyword "mainWindow" if there is not a current windowId in effect. |
protected ControllerUtilities.PropertiesMap |
getWindowMap()
Returns an instance of the current windowMap. |
WcmController.WindowProperties |
getWindowProperties(java.lang.String windowId)
Get an instance of the controller window properties for the specified windowId. |
java.lang.Object |
getWindowProperty(java.lang.String key)
Get the controller property - from the DataStore scoped globally to the window. |
java.io.Writer |
getWriterAndStop()
|
boolean |
handleEvent(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
This is the base handleEvent method. |
void |
handleEvent(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
boolean autoRedirect)
This is the autoRedirect version of the handleEvent method. |
void |
handleEvent(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String uiPageName)
Like auto redirect, but redirect to the specified page. |
java.lang.String |
initializeModules(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
boolean thinClient,
boolean doCleanup)
Handles module initialization, credentials check and event routing. |
java.lang.String |
initializeModules(javax.servlet.ServletContext application,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
boolean skipPreControllerEvents,
boolean sendNotSignedInXML,
boolean skipEventProcessing,
boolean skipStartPageEvent,
boolean skipPrepareResponse,
boolean doCleanup)
Handles module initialization. |
void |
initializeStaticClasses()
Initializes static classes that require ServletContext information. |
static boolean |
invokeNamedEvent(java.lang.String eventName,
GlobalEventModule geModule,
GlobalEvent evt)
Invoke a global event handler on the specified UI module. |
static boolean |
invokeNamedEvent(java.lang.String eventName,
WcmUiModuleInterface uiModule,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Invoke an event handler on the specified UI module. |
boolean |
isBootstrapRequired()
Returns true if required bootstrap options have not already been set by an administrator. |
boolean |
isControllerEvent(java.lang.String eventName)
Return true if the named event is a valid controller event (optional). |
protected boolean |
isEventRequest()
|
static boolean |
isForcedToken(javax.servlet.http.HttpServletRequest request)
Check for user token being passed w/ WcmParameter.USER_TOKEN_FORCE set to true. |
protected boolean |
isGlobalEventRequest()
|
protected boolean |
isGuest()
Returns true if the current signed in user is a guest. |
protected boolean |
isNewWindowIdRequired(javax.servlet.http.HttpServletRequest request)
Deprecated. |
static boolean |
isNonReturnableBookmark(javax.servlet.http.HttpServletRequest req)
|
boolean |
isPopup()
Return whether or not this controller is running in popup mode (when windowId is being carried on the request). |
static boolean |
isPopup(javax.servlet.http.HttpServletRequest request)
Determine if this request represents a popup window. |
static boolean |
isPopup(java.lang.String windowId)
Determine if this request represents a popup window. |
boolean |
isPopupSignedIn()
Returns whether or not this pop-up went through sign-in. |
static boolean |
isPopupSignedIn(javax.servlet.http.HttpServletRequest request,
WcmDataStore ds)
Returns whether or not this pop-up went through sign-in. |
static boolean |
isPopupSignedIn(java.lang.String windowIdValue,
WcmDataStore ds)
Returns whether or not this pop-up went through sign-in. |
boolean |
isPreControllerEvent(java.lang.String eventName)
Return true if the named event is a valid "pre" controller event (optional). |
boolean |
isRegistered(WcmModuleInterface module)
Test to see if the module is registered. |
boolean |
isSSOConfigured()
|
static boolean |
isSSOConfigured(javax.servlet.http.HttpServletRequest request)
|
boolean |
isSSOFilterConfigured()
Returns true if an SSO filter is configured, regardless of whether or not it is true SSO or container-managed authentication. |
static boolean |
isSSOFilterConfigured(javax.servlet.http.HttpServletRequest request)
Returns true if an SSO filter is configured, regardless of whether or not it is true SSO or container-managed authentication. |
boolean |
onChangeApp(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The onChangePage controller event handler. |
boolean |
onChangePage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The onChangePage controller event handler. |
boolean |
onCloseWindow(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The onCloseWindow controller event handler. |
boolean |
onHelp(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The onHelp controller event handler. |
boolean |
onHome(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The onHome controller event handler. |
boolean |
onSignIn(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The onSignIn controller event handler. |
boolean |
onSignOut(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The onSignOut controller event handler. |
void |
openPopup(java.lang.String destinationUrl)
Use this to open a popup to a new page. |
void |
openPopup(java.lang.String destinationUrl,
java.lang.String windowName,
int width,
int height)
Use this to open a popup to a new page. |
void |
openPopup(java.lang.String destinationUrl,
java.lang.String windowName,
int width,
int height,
boolean showStatusBar)
Open a popup window with control over whether or not to show the status bar. |
void |
openPopupViaPOST(java.lang.String destinationUrl,
java.util.Map postParameters,
java.lang.String windowName,
int width,
int height,
boolean showStatusBar)
Open a popup window with control over whether or not to show the status bar. |
boolean |
peekEvent(WcmUiModule uiModule,
java.lang.String uiEventName)
Returns true if the targeted event is queued. |
boolean |
peekGlobalEvent(java.lang.String uiEventName)
Returns true if the targeted global event is queued. |
boolean |
peekNewPageParameters()
Returns true if there are new page parameters defined on the current request. |
boolean |
peekNoRequestParameters()
Returns true are no request parameters on the current request. |
java.lang.Object |
popPageParameter(java.lang.String key)
Allows a mechanism to discard page parameters. |
protected void |
postProcessWindowId(WindowID assignedWindowId,
WindowID requestWindowId,
WindowID refererWindowId,
boolean idCreated,
boolean idSet,
boolean idRecovered,
boolean isPopupMode,
boolean isStackedMode)
A subclass of WcmController may override this method if there is a need to track windowId related activity for application-specific purposes. |
static long |
postTime(java.lang.String key,
java.util.Date startTime,
java.util.Date endTime)
Call this method to record time intervals for areas of code to be instrumented. |
protected void |
prepareResponse(javax.servlet.http.HttpServletResponse response,
java.lang.String contentType,
boolean disableBrowserCaching)
Sets headers in the response object in preparation for rendering a page back to the browser. |
void |
registerGlobalEvent(java.lang.String eventName)
Deprecated. - Registering global events is no longer necessary. |
void |
registerModule(WcmModuleInterface module)
Register UI and DP modules with the controller. |
protected void |
registerModule(WcmModuleInterface module,
boolean initialize)
Overload of registerModule. |
void |
registerModule(WcmModuleInterface module,
java.lang.String name)
Register UI and DP modules with the controller. |
protected void |
sendCloseWindow(javax.servlet.http.HttpServletResponse response)
Writes some javascript to the browser telling it to close itself. |
boolean |
sendRedirect(javax.servlet.http.HttpServletResponse response,
java.lang.String baseURL,
java.lang.String targetURL,
int postThreshold)
Redirect to another page. |
boolean |
sendRedirect(java.lang.String destinationUrl)
Use this to do a framework page switch that cleans up the current page. |
boolean |
sendRedirect(java.lang.String destinationUrl,
int postThreshold)
Use this to do a framework page switch that cleans up the current page. |
void |
serverSideInclude(java.lang.String path,
java.io.Writer w)
Include the specified URL writing its output to the current Writer object. |
void |
setAutoFixWindowId(boolean value)
Deprecated. - use configurePage(servletContext, request, windowIdMode). |
void |
setException(java.lang.Throwable exc,
boolean redirect)
Specify an exception to be displayed by WcmError.jsp, and optionally re-direct to WcmError.jsp to show the error. |
protected void |
setFirstWindowId(java.lang.String wid)
|
void |
setHelpContext(java.lang.Object o)
Set a supplemental help context based on an object's unqualified class name. |
void |
setHelpContext(java.lang.String contextValue)
Set a supplemental help context string. |
void |
setHelpPage(java.lang.String pageValue)
Set a non-default help page value. |
protected void |
setHomeURL(ControllerUtilities.PropertiesMap windowIdMap,
java.lang.String url)
|
protected void |
setHomeURL(java.lang.String url)
Set the home URL for the current controller windowId value. |
protected void |
setHomeURL(java.lang.String windowId,
java.lang.String url)
Set the home URL for the specified windowId value. |
void |
setLocale(java.util.Locale locale)
Call setLocale to set the client locale. |
void |
setLoginEnabled(boolean value)
Set whether or not to auto-redirect to WcmSignIn.jsp, if WcmServerCredentials is not found in the DataStore. |
void |
setName(java.lang.String nameValue)
Set the name of the controller. |
void |
setProperty(java.lang.String key,
java.lang.Object value)
Set the controller property in the DataStore. |
java.lang.Object |
setRequestAttribute(java.lang.String key,
java.lang.Object value)
Set a request attribute on the request that this controller is referencing. |
java.lang.Object |
setTemporaryProperty(java.lang.String key,
java.lang.Object value)
Sets a property that lives for the duration of this controller instance. |
void |
setWindowIDFactory(WindowIDFactory widFactory)
Specify the windowId factory instance to use here... |
void |
setWindowProperty(java.lang.String key,
java.lang.Object value)
Set the controller property in the DataStore, scoped globally to the current windowId. |
protected void |
subscribeGlobalEvent(GlobalEventModule eventModule,
java.lang.String eventName)
|
protected void |
subscribeGlobalEvent(GlobalEventModule eventModule,
java.lang.String eventName,
boolean register)
Deprecated. - Use subscribeGlobalEvent(eventModule, eventName) |
protected java.util.Hashtable |
transferPageParameters(javax.servlet.http.HttpServletRequest request)
transferPageParameters - retrieves the page parameters from the request object and copies them to a new hashtable. |
protected boolean |
tryEncodedCredentials(javax.servlet.http.HttpServletRequest request)
|
void |
unRegisterModule(WcmModuleInterface module)
Un-register the module from the controller's internal hashtable. |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer |
addDataProvider, addDataProvider, queryDataProvider |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmControllerBehaviorInterface |
getBootstrapPage, getConfiguration, getConfiguredHome, getDefaultPage, getErrorPage, getRouters, getSignInPage, isStickyPage, isValidHome |
Field Detail |
public static final java.lang.String BOOTSTRAP_PROPERTIES_KEY
protected static final WcmString wsPopupSessionExpired
protected java.lang.String pageName
protected WcmDataStore dataStore
protected javax.servlet.http.HttpServletRequest currentRequest
protected javax.servlet.http.HttpServletResponse currentResponse
protected javax.servlet.ServletContext application
protected WcmSignInPolicyInterface signInPolicy
protected UserTokenPolicyInterface internalTokenPolicy
protected WcmSSLInfo sslInfo
protected boolean newPageParams
protected boolean noRequestParams
protected boolean loginEnabled
protected boolean okToRegister
protected boolean okToRedirect
protected boolean deferRedirect
protected java.lang.String deferredURL
protected int deferPostThreshold
protected boolean sendRedirectCalled
protected long windowIdMode
protected boolean windowIdAssigned
protected boolean windowIdRecovered
protected boolean windowIdCreated
protected WindowIDFactory widFactory
protected java.lang.String[] windowIdParams
protected java.util.Map tempProperties
protected static WcmBootstrapPrefs bootstrap
protected static WcmHelpMap helpMap
protected static int popWindowIDCycleMax
protected static boolean popWindowIDUsePageName
protected java.lang.Exception lastTokenException
public static final java.lang.String NAMED_CONTROLLERS_KEY
public static final java.lang.String SSL_PROTOCOL
public static final java.lang.String MAIN_WINDOW
public static final java.lang.String HOME_KEY
public static final java.lang.String HEADER_MODULE
public static final java.lang.String CURRENT_MODULE_KEY
public static final java.lang.String HEADER_MODULE_NAME
protected static final long REQUIRE_MASK
protected static final long REQUIRE_ID
protected static final long PROPOGATE_MASK
protected static final long PROPOGATE_ID
protected static final long PROPOGATE_NONE
protected static final long PRIVATE_FLAGS_MASK
protected static final long FLAGS_MASK
protected static final long PUSH_PREV_PRIVATE_FLAG
protected static final long CREATE_PRIVATE_FLAG
protected static final long HASH_PRIVATE_FLAG
protected static final long NO_REWRITE_PRIVATE_FLAG
public static final long POPUP_FLAG
public static final long NO_EXPIRE_FLAG
protected static final long ALL_FLAGS_MASK
protected static final long COMPAT_FLAGS_MASK
public static final long NO_WINDOW_ID
public static final long IGNORE_WINDOW_ID
public static final long PROPAGATE_WINDOW_ID
public static final long PROPOGATE_WINDOW_ID
public static final long REQUIRE_WINDOW_ID
public static final long CREATE_WINDOW_ID
public static final long CREATE_POPUP
public static final java.lang.String CREATE_POPUP_KEY
public static final long CREATE_INLINE
public static final java.lang.String CREATE_INLINE_KEY
protected static final java.lang.String POPUP_KEY
protected static final java.lang.String FIRST_WINDOWID_KEY
protected static final java.lang.String SESSION_COUNT
protected static final java.lang.String HELP_PAGE_KEY
protected static final java.lang.String HELP_CONTEXT_KEY
protected static final java.lang.String WINDOW_SIGNED_IN_KEY
protected static final boolean DISABLE_BROWSER_CACHING
protected static final boolean DUMP_DATASTORE_KEYS
protected static final java.lang.String REDIRECT
public static final java.lang.String CREDENTIALS_BEAN_KEY
protected static java.util.HashMap preControllerEvents
protected static java.util.HashMap controllerEvents
protected static final WcmException noWindowIdError
protected static final java.lang.String DEFER_REWRITE_KEY
Constructor Detail |
public WcmController()
Method Detail |
public void setAutoFixWindowId(boolean value)
public void setName(java.lang.String nameValue)
nameValue
- - The name to use.public java.lang.String getName()
public void setLocale(java.util.Locale locale) throws java.lang.Exception
setLocale
in interface WcmControllerBehaviorInterface
locale
- The client locale.
java.lang.Exception
public static long postTime(java.lang.String key, java.util.Date startTime, java.util.Date endTime)
key
- - A key value uniquely identifying your timer.startTime
- - Timestamp representing the start of the code being timed.endTime
- - Timestamp representing the end of the code being timed.
public static java.lang.String getTime(java.lang.String key)
key
- - A key value uniquely identifying your timer.
public static java.lang.Object[] getTimerKeys()
protected boolean isEventRequest()
protected boolean isGlobalEventRequest()
public java.lang.String getWebappRootURL()
protected java.lang.String getBaseURL()
protected java.lang.String getFirstWindowId()
protected void setFirstWindowId(java.lang.String wid)
protected java.lang.String encodeWindowId(java.lang.String url)
protected java.lang.String getEventBaseURL() throws java.lang.Exception
java.lang.Exception
protected void sendCloseWindow(javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public java.lang.Object setRequestAttribute(java.lang.String key, java.lang.Object value)
key
- - The attribute key.value
- - The attribute value.
public java.lang.Object getRequestAttribute(java.lang.String key)
key
- - The attribute key.
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
path
- - The URL path that this dispatcher will reference.
public boolean closeWindow() throws java.lang.Exception
WcmException;
- closeIllegalState - If the close is attempted after onStartPage.
java.lang.Exception
public boolean closeWindow(javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
WcmException;
- closeIllegalState - If the close is attempted after onStartPage.
java.lang.Exception
public void openPopup(java.lang.String destinationUrl) throws java.lang.Exception
destinationUrl
- The destination URL.
WcmException;
- closeIllegalState - If the close is attempted after onStartPage.
java.lang.Exception
public void openPopup(java.lang.String destinationUrl, java.lang.String windowName, int width, int height) throws java.lang.Exception
destinationUrl
- The destination URL.windowName
- The browser window name to use. If it contains blanks, they will be changed to '_'width
- height
-
WcmException;
- closeIllegalState - If the close is attempted after onStartPage.
java.lang.Exception
public java.io.Writer getWriterAndStop() throws java.lang.Exception
java.lang.Exception
public void openPopup(java.lang.String destinationUrl, java.lang.String windowName, int width, int height, boolean showStatusBar) throws java.lang.Exception
destinationUrl
- The destination URL.windowName
- The browser window name to use. If it contains blanks, they will be changed to '_'width
- height
- showStatusBar
-
java.lang.Exception
public void openPopupViaPOST(java.lang.String destinationUrl, java.util.Map postParameters, java.lang.String windowName, int width, int height, boolean showStatusBar) throws java.lang.Exception
destinationUrl
- The destination URL.postParameters
- The parameters to be used in the POST action.windowName
- The browser window name to use. If it contains blanks, they will be changed to '_'width
- height
- showStatusBar
-
java.lang.Exception
public boolean sendRedirect(java.lang.String destinationUrl) throws java.lang.Exception
destinationUrl
- The destination URL.
WcmException;
- closeIllegalState - If the close is attempted after onStartPage.
java.lang.Exception
public java.lang.String getInitParameter(java.lang.String key)
key
-
public java.lang.String getInitParameter(java.lang.String key, java.lang.String defaultValue)
key
- defaultValue
-
public boolean getInitParameter(java.lang.String key, boolean defaultValue)
key
- defaultValue
-
public long getInitParameter(java.lang.String key, long defaultValue)
key
- defaultValue
-
public boolean getInitParameterBoolean(java.lang.String key)
key
-
public int getPOSTThreshold()
public boolean sendRedirect(java.lang.String destinationUrl, int postThreshold) throws java.lang.Exception
destinationUrl
- The destination URL.postThreshold
- Specify the post threshold. If 0 or less is specified, this method will never redirect via POST.
WcmException;
- closeIllegalState - If the close is attempted after onStartPage.
java.lang.Exception
public boolean sendRedirect(javax.servlet.http.HttpServletResponse response, java.lang.String baseURL, java.lang.String targetURL, int postThreshold) throws java.io.IOException
response
- baseURL
- targetURL
- postThreshold
- Specify the post threshold. If 0 or less is specified, this method will never redirect via POST.
java.io.IOException
public void setException(java.lang.Throwable exc, boolean redirect) throws java.lang.Exception
exc
- The exception to display.redirect
- Set to true to re-direct immediately to WcmError.jsp.
java.lang.Exception
public void setLoginEnabled(boolean value)
value
- true or false.public java.lang.String getPageName()
public java.lang.String getPageId()
public java.lang.String getWindowId()
public WindowID getWindowIdObject()
public java.lang.String getSessionId()
public java.lang.String getEncodedSessionId()
public void registerGlobalEvent(java.lang.String eventName) throws java.lang.Exception
java.lang.Exception
protected void subscribeGlobalEvent(GlobalEventModule eventModule, java.lang.String eventName) throws java.lang.Exception
java.lang.Exception
protected void subscribeGlobalEvent(GlobalEventModule eventModule, java.lang.String eventName, boolean register) throws java.lang.Exception
java.lang.Exception
public void registerModule(WcmModuleInterface module) throws java.lang.Exception
module
- A reference to a module (Java Bean)
java.lang.Exception
public void registerModule(WcmModuleInterface module, java.lang.String name) throws java.lang.Exception
module
- A reference to a module (Java Bean)name
- The name to use to register this module
java.lang.Exception
protected void registerModule(WcmModuleInterface module, boolean initialize) throws java.lang.Exception
java.lang.Exception
public boolean isRegistered(WcmModuleInterface module)
module
- The module to check
public boolean isPopup()
public static boolean isNonReturnableBookmark(javax.servlet.http.HttpServletRequest req) throws java.lang.Exception
java.lang.Exception
public static boolean getErrorTrace()
public void unRegisterModule(WcmModuleInterface module) throws java.lang.Exception
module
- a reference to the module to un-register.
java.lang.Exception
protected java.util.Hashtable transferPageParameters(javax.servlet.http.HttpServletRequest request)
request
-
public java.lang.Object popPageParameter(java.lang.String key)
key
- - key identifier for the parameter to be removed
public static java.lang.String getWindowIdFromReferer(javax.servlet.http.HttpServletRequest request)
request
-
public static java.lang.String getWindowIdFromReferer(java.util.Map popups, java.lang.String referer)
public static java.lang.String getWindowIdFromURL(java.lang.String url, java.lang.String baseUrl)
url
- The URL.baseUrl
- The base URL for the current running webapp.
public static java.lang.String getWindowId(javax.servlet.http.HttpServletRequest request)
request
-
protected void configurePageName(javax.servlet.http.HttpServletRequest request)
protected boolean isNewWindowIdRequired(javax.servlet.http.HttpServletRequest request)
public static java.lang.String getRequestHash(javax.servlet.http.HttpServletRequest request)
protected WindowID createWindowId(long createValue, javax.servlet.http.HttpServletRequest request, long flags) throws WcmException
WcmException
protected WindowIDFactory getWindowIDFactory()
public void setWindowIDFactory(WindowIDFactory widFactory)
protected void assignWindowId(WindowID newWindowId, WindowID currentWindowId, boolean popupCreated)
newWindowId
- currentWindowId
- popupCreated
- protected long getWindowIdModeValue(java.lang.String symbolicMode) throws WcmException
WcmException
protected long getWindowIdModeValue(java.lang.String symbolicMode, boolean noExpireFlag) throws WcmException
WcmException
protected void postProcessWindowId(WindowID assignedWindowId, WindowID requestWindowId, WindowID refererWindowId, boolean idCreated, boolean idSet, boolean idRecovered, boolean isPopupMode, boolean isStackedMode) throws java.lang.Exception
assignedWindowId
- - The currently set windowId.requestWindowId
- - The windowId that was found on the request (if any).refererWindowId
- - The windowId that was found on the referer (if any).idCreated
- - True if a new windowId was created.idSet
- - True if a new windowId was defined via the setWindowId request parameter.idRecovered
- - True if a windowId was dropped, and will be rewritten to the URL as part of this request.isPopupMode
- - True if a new popup windowId was created.isStackedMode
- - True if a new stacked windowId was created.
WcmException
java.lang.Exception
public void configurePage(javax.servlet.ServletContext applicationValue, javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
applicationValue
- The current ServletContext object.request
- The current HttpServletRequest.
java.lang.Exception
public void configurePage(javax.servlet.ServletContext applicationValue, javax.servlet.http.HttpServletRequest request, int windowIdMode, java.lang.String[] windowIdParams) throws java.lang.Exception
java.lang.Exception
protected boolean getWindowIdCompatibility()
protected void checkName(javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
java.lang.Exception
public void configurePage(javax.servlet.ServletContext applicationValue, javax.servlet.http.HttpServletRequest request, boolean windowIdRequired) throws java.lang.Exception
configurePage
in interface WcmControllerBehaviorInterface
applicationValue
- The current ServletContext object.request
- The current HttpServletRequest.windowIdRequired
- This page requires a window ID in the request string.
java.lang.Exception
public void configurePage(javax.servlet.ServletContext applicationValue, javax.servlet.http.HttpServletRequest request, int windowIdMode) throws java.lang.Exception
java.lang.Exception
public void configurePage(javax.servlet.ServletContext applicationValue, javax.servlet.http.HttpServletRequest request, long windowIdMode) throws java.lang.Exception
applicationValue
- The current ServletContext object.request
- The current HttpServletRequest.windowIdMode
- The window ID mode - NO_WINDOW_ID, PROPOGATE_WINDOW_ID (default), REQUIRE_WINDOW_ID, or NEW_WINDOW_ID.
java.lang.Exception
public void cleanupWindowId(java.lang.String windowId)
windowId
- public void cleanupWindowId(java.lang.String windowId, long timeout)
windowId
- timeout
- long new window timeout intervalprotected java.lang.String getHomeURLKey(java.lang.String windowId)
protected void setHomeURL(java.lang.String url) throws WcmException
url
-
WcmException
protected void setHomeURL(java.lang.String windowId, java.lang.String url) throws FrameworkException, WcmException
windowId
- url
-
WcmException
FrameworkException
protected void setHomeURL(ControllerUtilities.PropertiesMap windowIdMap, java.lang.String url) throws WcmException
WcmException
protected java.lang.String getHomeURL(java.lang.String windowId) throws FrameworkException, WcmException
windowId
-
FrameworkException
WcmException
protected java.lang.String getHomeURL()
public WcmHeaderModuleInterface getHeaderModule()
getHeaderModule
in interface WcmControllerBehaviorInterface
protected java.lang.String getBootstrapFile()
public void initializeStaticClasses() throws java.lang.Exception
initializeStaticClasses
in interface WcmControllerBehaviorInterface
java.lang.Exception
public StaticInitializerInterface getStaticInitializer() throws java.lang.Exception
java.lang.Exception
public void configureHeaderModule() throws java.lang.Exception
configureHeaderModule
in interface WcmControllerBehaviorInterface
java.lang.Exception
public void configureDataProviders() throws java.lang.Exception
configureDataProviders
in interface WcmControllerBehaviorInterface
java.lang.Exception
public java.lang.Exception getLastTokenException()
protected boolean tryEncodedCredentials(javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
java.lang.Exception
public boolean checkLogin(java.lang.String currentUrl, javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
currentUrl
- - The URL for the current page.request
- - The HttpServletRequest for the current page.
java.lang.Exception
protected boolean forceSignInToDefaultPage()
public static boolean isPopup(java.lang.String windowId)
windowId
- The window ID represented by WcmParameter.WINDOW_ID on the request.
public static boolean isPopup(javax.servlet.http.HttpServletRequest request)
request
- A reference to the current HttpServletRequest.
public static boolean isPopupSignedIn(javax.servlet.http.HttpServletRequest request, WcmDataStore ds)
request
- - The HttpServletRequest that represents the popup.ds
- - The associated session data store.
public static boolean isPopupSignedIn(java.lang.String windowIdValue, WcmDataStore ds)
windowIdValue
- - The windowId to check on.ds
- - The associated session data store.
public void handleEvent(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean autoRedirect) throws java.io.IOException, javax.servlet.ServletException, java.lang.Exception
application
- The JSP application objectrequest
- The JSP request objectresponse
- The JSP response objectautoRedirect
- When set to true, calculate UI jsp and server-side include to it if appropriate.
java.io.IOException
javax.servlet.ServletException
java.lang.Exception
public void handleEvent(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String uiPageName) throws java.io.IOException, javax.servlet.ServletException, java.lang.Exception
application
- The JSP application objectrequest
- The JSP request objectresponse
- The JSP response objectuiPageName
- The ui JSP page name relative to <java.io.IOException
javax.servlet.ServletException
java.lang.Exception
public boolean handleEvent(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.io.IOException, javax.servlet.ServletException, java.lang.Exception
application
- The JSP application objectrequest
- The JSP request objectresponse
- The JSP response object
java.io.IOException
javax.servlet.ServletException
java.lang.Exception
public java.lang.String getLoginRoutingInfo() throws java.lang.Exception
java.lang.Exception
public java.lang.String initializeModules(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean thinClient, boolean doCleanup) throws java.io.IOException, javax.servlet.ServletException, java.lang.Exception
Possible return values | ||
---|---|---|
Return Value | thinClient==true | thinClient==false |
null | all went well | |
non-null | Credentials are required. XML is returned describing the parameters needed to connect to the credentials servlet. | The keyword WcmController.REDIRECT to indicate that a redirect to WcmController.LOGIN_URL was performed. |
application
- The JSP application objectrequest
- The JSP request objectresponse
- The JSP response objectthinClient
- Set to "false" if you are not a web browser.doCleanup
- Set to "true" if you want to persist/cleanup the configured Modules.
java.io.IOException
javax.servlet.ServletException
java.lang.Exception
protected boolean catchPopupExceptions()
protected java.lang.Exception getPopupException(java.lang.Exception e)
e
-
public java.lang.String initializeModules(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean skipPreControllerEvents, boolean sendNotSignedInXML, boolean skipEventProcessing, boolean skipStartPageEvent, boolean skipPrepareResponse, boolean doCleanup) throws java.io.IOException, javax.servlet.ServletException, java.lang.Exception
application
- The JSP application objectrequest
- The JSP request objectresponse
- The JSP response objectskipPreControllerEvents
- Specify whether or not to ignore pre-controller events.sendNotSignedInXML
- If true, return XML for signin. Otherwise perfrom the signin process as defined by the sign-in policy.skipEventProcessing
- Specify whether or not to process events (other than pre-controller events).skipStartPageEvent
- Specify whether or not to broadcast the StartPage event to all modules (indicating that rendering will follow).skipPrepareResponse
- Specify whether or not to call prepareResponse to set headers for content type and caching.doCleanup
- Set to "true" if you want to persist/cleanup the configured Modules.
java.io.IOException
javax.servlet.ServletException
java.lang.Exception
protected void prepareResponse(javax.servlet.http.HttpServletResponse response, java.lang.String contentType, boolean disableBrowserCaching)
response
- The current response object.contentType
- The content type header value to use (ex: text/html;charset=UTF-8)disableBrowserCaching
- Specify boolean true to tell the browser not to cache the page.protected java.lang.String executeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean skipEventProcessing, java.lang.String eventTarget) throws java.io.IOException, javax.servlet.ServletException, java.lang.Exception
request
- response
- skipEventProcessing
- eventTarget
-
java.io.IOException
javax.servlet.ServletException
java.lang.Exception
protected java.lang.String constructTargetUrl(javax.servlet.http.HttpServletRequest request, boolean dropWindowId) throws java.lang.Exception
java.lang.Exception
public void setHelpPage(java.lang.String pageValue) throws java.lang.Exception
pageValue
- the help context String value, or null to use the current page name.
java.lang.Exception
public void setHelpContext(java.lang.String contextValue) throws java.lang.Exception
contextValue
- the help context String value.
java.lang.Exception
public void setHelpContext(java.lang.Object o) throws java.lang.Exception
o
- the object whose class name to use
java.lang.Exception
public boolean isPopupSignedIn()
public java.lang.String getUIRoot()
public boolean getDebugTrace()
public java.util.Locale getClientLocale()
public java.util.Locale getRequestedClientLocale()
public java.util.TimeZone getClientTimeZone() throws java.lang.Exception
java.lang.Exception
public java.io.InputStream getApplicationResource(java.lang.String path)
public java.lang.String getClientCharacterEncoding()
public UserAgent getUserAgent()
public java.lang.String getHelpContext() throws java.lang.Exception
java.lang.Exception
public java.lang.String getHelpPage() throws java.lang.Exception
java.lang.Exception
public static java.lang.String getHelpURL(java.lang.String baseUrl, java.lang.String helpPage, java.lang.String helpContext)
baseUrl
- - The documentation server URL, either the local machine, or as configured in bootstrap.properties.helpPage
- - The pageId of the page for which context sensitive help is desired.helpContext
- - The help context (based on what's currently being displayed on the page) if specified or null.
public boolean onHome(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- - The current HttpServletRequest.response
- - The current HttpServletResponse.
java.lang.Exception
public boolean onChangePage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- - The current HttpServletRequest.response
- - The current HttpServletResponse.
java.lang.Exception
public boolean onChangeApp(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- - The current HttpServletRequest.response
- - The current HttpServletResponse.
java.lang.Exception
public java.lang.String generateUserToken() throws java.lang.Exception
java.lang.Exception
public java.lang.String encodeUserToken(java.lang.String url) throws java.lang.Exception
url
-
java.lang.Exception
public boolean onHelp(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- - The current HttpServletRequest.response
- - The current HttpServletResponse.
java.lang.Exception
public boolean onSignIn(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- - The current HttpServletRequest.response
- - The current HttpServletResponse.
java.lang.Exception
public boolean onSignOut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- - The current HttpServletRequest.response
- - The current HttpServletResponse.
java.lang.Exception
public boolean onCloseWindow(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- - The current HttpServletRequest.response
- - The current HttpServletResponse.
java.lang.Exception
public boolean isPreControllerEvent(java.lang.String eventName)
WcmControllerBehaviorInterface
isPreControllerEvent
in interface WcmControllerBehaviorInterface
eventName
- The name of the event.public boolean isControllerEvent(java.lang.String eventName)
WcmControllerBehaviorInterface
isControllerEvent
in interface WcmControllerBehaviorInterface
eventName
- The name of the event.public static boolean invokeNamedEvent(java.lang.String eventName, WcmUiModuleInterface uiModule, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
eventName
- The event name to invoke (ex: "Click" would invoke the method named "onClick(...)".uiModule
- The UI module to invoke the event on.request
- The current HttpServletRequest instance.response
- The current HttpServletResponse instance.
java.lang.Exception
public static boolean invokeNamedEvent(java.lang.String eventName, GlobalEventModule geModule, GlobalEvent evt) throws java.lang.Exception
eventName
- The event name to invoke (ex: "Click" would invoke the method named "onClick(...)".geModule
- The UI module to invoke the event on.evt
- The global event object
java.lang.Exception
protected static java.lang.reflect.Method getMethod(java.lang.Class c, java.lang.String methodName, java.lang.Class[] paramList) throws java.lang.Exception
java.lang.Exception
public void setProperty(java.lang.String key, java.lang.Object value) throws java.lang.Exception
key
- The key to store a value into.value
- The value to store.
java.lang.Exception
public java.lang.Object setTemporaryProperty(java.lang.String key, java.lang.Object value)
key
- value
-
public java.lang.Object getTemporaryProperty(java.lang.String key)
key
-
public java.lang.Object getProperty(java.lang.String key) throws java.lang.Exception
key
- The key to retrieve a value for.
java.lang.Exception
public void setWindowProperty(java.lang.String key, java.lang.Object value) throws java.lang.Exception
key
- The key to store a value into.value
- The value to store.
java.lang.Exception
public java.lang.Object getWindowProperty(java.lang.String key) throws java.lang.Exception
key
- The key to retrieve a value for.
java.lang.Exception
public java.lang.String getPageParameter(java.lang.String key)
key
- The key to retrieve a value for.
public java.lang.String getPageParameterString(java.lang.String key)
public java.lang.String[] getPageParameters(java.lang.String key)
key
- The key to retrieve a value for.
public java.util.Enumeration getPageParameterNames()
protected java.lang.String getParameter(java.util.Map map, java.lang.String key)
protected java.lang.String[] getParameters(java.util.Map map, java.lang.String key)
public java.util.Hashtable getPageParameters()
public java.lang.String getNewPageParameter(java.lang.String key)
key
- The key to retrieve a value for.
public boolean peekGlobalEvent(java.lang.String uiEventName)
uiEventName
- The event name to invoke (ex: "Click" would invoke the method named "onClick(GlobalEvent e)".
public boolean peekEvent(WcmUiModule uiModule, java.lang.String uiEventName)
uiModule
- The UI module to invoke the event on.uiEventName
- The event name to invoke (ex: "Click" would invoke the method named "onClick(...)".
public java.lang.String getLocalIP() throws java.lang.Exception
java.lang.Exception
public boolean peekNewPageParameters()
public boolean peekNoRequestParameters()
protected ControllerUtilities.PropertiesMap getWindowMap()
public WcmDataStore getDataStore()
public boolean isSSOFilterConfigured()
public boolean isSSOConfigured()
public static boolean isSSOFilterConfigured(javax.servlet.http.HttpServletRequest request)
public static boolean isSSOConfigured(javax.servlet.http.HttpServletRequest request)
public static boolean isForcedToken(javax.servlet.http.HttpServletRequest request)
request
-
protected WcmDataStore getDataStore(javax.servlet.ServletContext application, javax.servlet.http.HttpServletRequest request)
public javax.servlet.ServletContext getServletContext()
protected javax.servlet.http.HttpServletRequest getCurrentRequest()
public WcmErrorMessageBox getErrorMessageBox(java.lang.Throwable t)
t
- - instance of Throwable
public WcmSignInPolicyInterface getSignInPolicy() throws java.lang.Exception
getSignInPolicy
in interface WcmControllerBehaviorInterface
java.lang.Exception
public UserTokenPolicyInterface getInternalTokenPolicy() throws java.lang.Exception
java.lang.Exception
public UserTokenPolicyInterface getUserTokenPolicy() throws java.lang.Exception
java.lang.Exception
public WcmUserInformationInterface getUserInfo() throws java.lang.Exception
WcmControllerBehaviorInterface
getUserInfo
in interface WcmControllerBehaviorInterface
java.lang.Exception
public boolean isBootstrapRequired()
getSignInPolicy
method. If you're not using a bootstrap page, implement the
getBootstrapPage
method to return null.
isBootstrapRequired
in interface WcmControllerBehaviorInterface
protected boolean isGuest() throws java.lang.Exception
java.lang.Exception
protected WcmServerCredentials getServerCredentials() throws java.lang.Exception
java.lang.Exception
protected WcmSSLInfo getSSLInfo() throws java.lang.Exception
java.lang.Exception
public WcmSystem getSystemInfo() throws java.lang.Exception
getSystemInfo
in interface WcmControllerBehaviorInterface
java.lang.Exception
public void serverSideInclude(java.lang.String path, java.io.Writer w) throws java.io.IOException, javax.servlet.ServletException
path
- - The path to the URL to include.w
- - The Writer which will be flushed prior to the include.
java.io.IOException
javax.servlet.ServletException
public WcmController.WindowProperties getWindowProperties(java.lang.String windowId) throws java.lang.Exception
windowId
-
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |