com.filenet.wcm.apps.server.controller

Class WcmISController

1. java.lang.Object
2. com.filenet.wcm.toolkit.server.base.WcmDpContainer
3. com.filenet.wcm.toolkit.server.base.WcmController
4. com.filenet.wcm.apps.server.controller.WcmISController

---

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

Represents the IS controller implementation. A framework page must instantiate the controller, register all modules with it, and call the handleEvent method, which then:

1. Calls the initialize() method in each module (pseudo constructor).
2. If the eventTarget and eventName parameters are defined in the request string, dispatches the event to its target UI module.
3. Broadcasts the StartPage event to all UI modules.

Sample:

The following example provides a code fragment from the page Event.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/interfaces 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

Constructor and Description
WcmISController()

Method Summary

Modifier and Type	Method and Description
void	configureHeaderModule() Instantiates and registers a WcmHeaderModule object that is used to render the HTML headers on this page.
java.lang.String	getBootstrapPage()
com.filenet.wcm.toolkit.server.base.WcmConfigurationInterface	getConfiguration()
java.lang.String	getConfiguredHome() Returns 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() Returns the WcmSignInPolicyInterface object that is used with this controller implementation.
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, validateSession

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

1. public WcmISController()

Method Detail

getBootstrapPage

1. public java.lang.String getBootstrapPage( )

---

getConfiguration

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

---

getConfiguredHome

1. public java.lang.String getConfiguredHome( )
2. throws java.lang.Exception

---

getDefaultPage

1. public java.lang.String getDefaultPage( )
2. throws java.lang.Exception

---

getErrorPage

1. public java.lang.String getErrorPage( )
2. throws java.lang.Exception

---

getRouters

1. public java.util.Vector getRouters( )
2. throws java.lang.Exception

---

getSignInPage

1. public java.lang.String getSignInPage( )

---

isStickyPage

1. public boolean isStickyPage(java.lang.String pageName)

---

isValidHome

1. public boolean isValidHome(java.lang.String pageName)
2. throws java.lang.Exception

---

getSignInPolicy

1. public com.filenet.wcm.toolkit.server.base.WcmSignInPolicyInterface getSignInPolicy( )
2. throws java.lang.Exception

---

isBootstrapRequired

1. public boolean isBootstrapRequired( )

---

configureHeaderModule

1. public void configureHeaderModule( )
2. throws java.lang.Exception