com.filenet.wcm.apps.server.controller
Class WcmISController

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmController
          extended bycom.filenet.wcm.apps.server.controller.WcmISController
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmControllerBehaviorInterface

public class WcmISController
extends com.filenet.wcm.toolkit.server.base.WcmController

This is the IS controller implementation. Any framework page should instantiate the controller, register all modules with it, and call the handleEvent method which will in turn do the following steps:

  1. Call the initialize() method in each module (pseudo constructor).
  2. If eventTarget and eventName are defined in the request string, dispatch the event to its target UI module.
  3. Broadcast the "StartPage" event to all UI modules.
Sample:

(This would be a code fragment from pageEvent.jsp)
      ...
      <%-- CONTROLLER --%>
      <jsp:useBean
         id="controller"
         class="com.filenet.wcm.apps.server.controller.WcmISController"
         scope="request"/>
      ...
      <%
      ...
      controller.configurePage(application, request);
      controller.registerModule(myBean);
      controller.registerModule(testBean);
      controller.handleEvent(application, request, response, true);
      %>
    


Nested Class Summary
 
Nested classes inherited from class com.filenet.wcm.toolkit.server.base.WcmController
com.filenet.wcm.toolkit.server.base.WcmController.GetWriterResponse, com.filenet.wcm.toolkit.server.base.WcmController.WcmEventRequest, com.filenet.wcm.toolkit.server.base.WcmController.WindowProperties, com.filenet.wcm.toolkit.server.base.WcmController.WorkplacePrintWriter
 
Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmController
ALL_FLAGS_MASK, application, bootstrap, BOOTSTRAP_PROPERTIES_KEY, COMPAT_FLAGS_MASK, controllerEvents, CREATE_INLINE, CREATE_INLINE_KEY, CREATE_POPUP, CREATE_POPUP_KEY, CREATE_PRIVATE_FLAG, CREATE_WINDOW_ID, CREDENTIALS_BEAN_KEY, CURRENT_MODULE_KEY, currentRequest, currentResponse, dataStore, DEFER_REWRITE_KEY, deferPostThreshold, deferRedirect, deferredURL, DISABLE_BROWSER_CACHING, DUMP_DATASTORE_KEYS, FIRST_WINDOWID_KEY, FLAGS_MASK, HASH_PRIVATE_FLAG, HEADER_MODULE, HEADER_MODULE_NAME, HELP_CONTEXT_KEY, HELP_PAGE_KEY, helpMap, HOME_KEY, IGNORE_WINDOW_ID, internalTokenPolicy, lastTokenException, loginEnabled, MAIN_WINDOW, NAMED_CONTROLLERS_KEY, newPageParams, NO_EXPIRE_FLAG, NO_REWRITE_PRIVATE_FLAG, NO_WINDOW_ID, noRequestParams, noWindowIdError, okToRedirect, okToRegister, pageName, POPUP_FLAG, POPUP_KEY, popWindowIDCycleMax, popWindowIDUsePageName, preControllerEvents, PRIVATE_FLAGS_MASK, PROPAGATE_WINDOW_ID, PROPOGATE_ID, PROPOGATE_MASK, PROPOGATE_NONE, PROPOGATE_WINDOW_ID, PUSH_PREV_PRIVATE_FLAG, REDIRECT, REQUIRE_ID, REQUIRE_MASK, REQUIRE_WINDOW_ID, sendRedirectCalled, SESSION_COUNT, signInPolicy, SSL_PROTOCOL, sslInfo, tempProperties, widFactory, WINDOW_SIGNED_IN_KEY, windowIdAssigned, windowIdCreated, windowIdMode, windowIdParams, windowIdRecovered, wsPopupSessionExpired
 
Constructor Summary
WcmISController()
           
 
Method Summary
 void configureHeaderModule()
          Instantiates and registers a WcmHeaderModule.
 java.lang.String getBootstrapPage()
           
 com.filenet.wcm.toolkit.server.base.WcmConfigurationInterface getConfiguration()
           
 java.lang.String getConfiguredHome()
          Return the configured home page, based on the preferences configuration.
 java.lang.String getDefaultPage()
          Returns the name of the default page.
 java.lang.String getErrorPage()
          Returns the name of the error page.
 java.util.Vector getRouters()
           
 java.lang.String getSignInPage()
          Returns the name of the sign in page.
 com.filenet.wcm.toolkit.server.base.WcmSignInPolicyInterface getSignInPolicy()
          Factory method.
 boolean isBootstrapRequired()
           
 boolean isStickyPage(java.lang.String pageName)
          Returns true if the specified page is sticky.
 boolean isValidHome(java.lang.String pageName)
          Returns true if the specified page is a valid home page.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmController
assignWindowId, catchPopupExceptions, checkLogin, checkName, cleanupWindowId, cleanupWindowId, closeWindow, closeWindow, configureDataProviders, configurePage, configurePage, configurePage, configurePage, configurePage, configurePageName, constructTargetUrl, createWindowId, encodeUserToken, encodeWindowId, executeModel, forceSignInToDefaultPage, generateUserToken, getApplicationResource, getBaseURL, getBootstrapFile, getClientCharacterEncoding, getClientLocale, getClientTimeZone, getCurrentRequest, getDataStore, getDataStore, getDebugTrace, getEncodedSessionId, getErrorMessageBox, getErrorTrace, getEventBaseURL, getFirstWindowId, getHeaderModule, getHelpContext, getHelpPage, getHelpURL, getHomeURL, getHomeURL, getHomeURLKey, getInitParameter, getInitParameter, getInitParameter, getInitParameter, getInitParameterBoolean, getInternalTokenPolicy, getLastTokenException, getLocalIP, getLoginRoutingInfo, getMethod, getName, getNewPageParameter, getPageId, getPageName, getPageParameter, getPageParameterNames, getPageParameters, getPageParameters, getPageParameterString, getParameter, getParameters, getPopupException, getPOSTThreshold, getProperty, getRequestAttribute, getRequestDispatcher, getRequestedClientLocale, getRequestHash, getServerCredentials, getServletContext, getSessionId, getSSLInfo, getStaticInitializer, getSystemInfo, getTemporaryProperty, getTime, getTimerKeys, getUIRoot, getUserAgent, getUserInfo, getUserTokenPolicy, getWebappRootURL, getWindowId, getWindowId, getWindowIdCompatibility, getWindowIDFactory, getWindowIdFromReferer, getWindowIdFromReferer, getWindowIdFromURL, getWindowIdModeValue, getWindowIdModeValue, getWindowIdObject, getWindowMap, getWindowProperties, getWindowProperty, getWriterAndStop, handleEvent, handleEvent, handleEvent, initializeModules, initializeModules, initializeStaticClasses, invokeNamedEvent, invokeNamedEvent, isControllerEvent, isEventRequest, isForcedToken, isGlobalEventRequest, isGuest, isNewWindowIdRequired, isNonReturnableBookmark, isPopup, isPopup, isPopup, isPopupSignedIn, isPopupSignedIn, isPopupSignedIn, isPreControllerEvent, isRegistered, isSSOConfigured, isSSOConfigured, isSSOFilterConfigured, isSSOFilterConfigured, onChangeApp, onChangePage, onCloseWindow, onHelp, onHome, onSignIn, onSignOut, openPopup, openPopup, openPopup, openPopupViaPOST, peekEvent, peekGlobalEvent, peekNewPageParameters, peekNoRequestParameters, popPageParameter, postProcessWindowId, postTime, prepareResponse, registerGlobalEvent, registerModule, registerModule, registerModule, sendCloseWindow, sendRedirect, sendRedirect, sendRedirect, serverSideInclude, setAutoFixWindowId, setException, setFirstWindowId, setHelpContext, setHelpContext, setHelpPage, setHomeURL, setHomeURL, setHomeURL, setLocale, setLoginEnabled, setName, setProperty, setRequestAttribute, setTemporaryProperty, setWindowIDFactory, setWindowProperty, subscribeGlobalEvent, subscribeGlobalEvent, transferPageParameters, tryEncodedCredentials, unRegisterModule
 
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
 

Constructor Detail

WcmISController

public WcmISController()
Method Detail

getBootstrapPage

public java.lang.String getBootstrapPage()

getConfiguration

public com.filenet.wcm.toolkit.server.base.WcmConfigurationInterface getConfiguration()
                                                                               throws java.lang.Exception
Throws:
java.lang.Exception

getConfiguredHome

public java.lang.String getConfiguredHome()
                                   throws java.lang.Exception
Return the configured home page, based on the preferences configuration.

Returns:
The configured home page relative to the application root.
Throws:
java.lang.Exception

getDefaultPage

public java.lang.String getDefaultPage()
                                throws java.lang.Exception
Returns the name of the default page.

Returns:
The default page relative to the application root.
Throws:
java.lang.Exception

getErrorPage

public java.lang.String getErrorPage()
                              throws java.lang.Exception
Returns the name of the error page.

Returns:
The error page relative to the application root.
Throws:
java.lang.Exception

getRouters

public java.util.Vector getRouters()
                            throws java.lang.Exception
Throws:
java.lang.Exception

getSignInPage

public java.lang.String getSignInPage()
Returns the name of the sign in page.

Returns:
The sign in page name relative to the application root.

isStickyPage

public boolean isStickyPage(java.lang.String pageName)
Returns true if the specified page is sticky. This means that when a user signs out from this page, when they sign in, they are returned to it.

Parameters:
pageName - The name of the page relative to the application root.
Returns:
boolean true or false.

isValidHome

public boolean isValidHome(java.lang.String pageName)
                    throws java.lang.Exception
Returns true if the specified page is a valid home page.

Parameters:
pageName - The name of the page.
Returns:
boolean true or false.
Throws:
java.lang.Exception

getSignInPolicy

public com.filenet.wcm.toolkit.server.base.WcmSignInPolicyInterface getSignInPolicy()
                                                                             throws java.lang.Exception
Factory method. Returns the singleton instance of WcmSignInPolicyInterface used with this controller implementation.

Returns:
The instance of WcmSignInPolicyInterface.
Throws:
java.lang.Exception

isBootstrapRequired

public boolean isBootstrapRequired()

configureHeaderModule

public void configureHeaderModule()
                           throws java.lang.Exception
Instantiates and registers a WcmHeaderModule. This module is responsible for rendering the HTML headers onto the page.

Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.