com.filenet.wcm.toolkit.server.base

Class ConfigurableController

  1. java.lang.Object
  2. extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
  3. extended bycom.filenet.wcm.toolkit.server.base.WcmController
  4. extended bycom.filenet.wcm.toolkit.server.base.ConfigurableController
All implemented interfaces:
WcmControllerBehaviorInterface
  1. public class ConfigurableController
  2. extends WcmController

Nested Class Summary

Nested classes/interfaces inherited from class com.filenet.wcm.toolkit.server.base.WcmController
WcmController.GetWriterResponse, WcmController.WcmEventRequest, WcmController.WindowProperties, WcmController.WorkplacePrintWriter

Field Summary

Modifier and Type Field and Description
  1. protected static
  2. boolean
 attemptedLoadingP8ControllerPrefs
  1. protected static
  2. java.lang.String
 BASE_CONFIGURATION_KEY
  1. protected
  2. java.lang.String
 controllerConfigName
  1. protected static
  2. AllControllerPrefs
 p8ControllerPrefs
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
ConfigurableController()

Method Summary

Modifier and Type Method and Description
  1. void
 configureHeaderModule()
  1. void
 configurePage(javax.servlet.ServletContext applicationValue,javax.servlet.http.HttpServletRequest request,long windowIdMode)
  1. java.lang.String
 getBootstrapPage()
  1. WcmConfigurationInterface
 getConfiguration()
  1. java.lang.String
 getConfiguredHome()
  1. java.lang.String
 getControllerConfigName()
Return the currently set configuration name being used.
  1. ControllerPrefs
 getControllerPrefs()
Get the controller preferences based on the current configuration name.
  1. java.lang.String
 getDefaultPage()
  1. java.lang.String
 getErrorPage()
  1. java.util.Vector
 getRouters()
  1. java.lang.String
 getSignInPage()
  1. WcmSignInPolicyInterface
 getSignInPolicy()
  1. StaticInitializerInterface
 getStaticInitializer()
  1. protected
  2. boolean
 getWindowIdCompatibility()
  1. boolean
 isBootstrapRequired()
  1. boolean
 isControllerEvent(java.lang.String eventName)
  1. boolean
 isPreControllerEvent(java.lang.String eventName)
  1. boolean
 isStickyPage(java.lang.String pageName)
  1. boolean
 isValidHome(java.lang.String pageName)
  1. void
 setControllerConfigName(java.lang.String name)
Sets the controller configuration name.
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmController
assignWindowId, catchPopupExceptions, checkLogin, checkName, cleanupWindowId, cleanupWindowId, closeWindow, closeWindow, configureDataProviders, 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, getSystemInfo, getTemporaryProperty, getTime, getTimerKeys, getUIRoot, getUserAgent, getUserInfo, getUserTokenPolicy, getWebappRootURL, getWindowId, getWindowId, getWindowIDFactory, getWindowIdFromReferer, getWindowIdFromReferer, getWindowIdFromURL, getWindowIdModeValue, getWindowIdModeValue, getWindowIdObject, getWindowMap, getWindowProperties, getWindowProperty, getWriterAndStop, handleEvent, handleEvent, handleEvent, initializeModules, initializeModules, initializeStaticClasses, invokeNamedEvent, invokeNamedEvent, isEventRequest, isForcedToken, isGlobalEventRequest, isGuest, isNewWindowIdRequired, isNonReturnableBookmark, isPopup, isPopup, isPopup, isPopupSignedIn, isPopupSignedIn, isPopupSignedIn, 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

Field Detail

controllerConfigName

  1. protected java.lang.String controllerConfigName

p8ControllerPrefs

  1. protected static AllControllerPrefs p8ControllerPrefs

attemptedLoadingP8ControllerPrefs

  1. protected static boolean attemptedLoadingP8ControllerPrefs

BASE_CONFIGURATION_KEY

  1. protected static final java.lang.String BASE_CONFIGURATION_KEY
See Also:
Constant Field Values

Constructor Detail

ConfigurableController

  1. public ConfigurableController()

Method Detail

getControllerPrefs

  1. public ControllerPrefs getControllerPrefs( )
Get the controller preferences based on the current configuration name.
Returns:
Teh controllerPrefs object.

setControllerConfigName

  1. public void setControllerConfigName( java.lang.String name)
Sets the controller configuration name. This name is used to find the configuration to use from p8controller.xml. The name is matched against the configuration name setting ex: <setting key="name">
Parameters:
name - The configuration name.

getControllerConfigName

  1. public java.lang.String getControllerConfigName( )
Return the currently set configuration name being used.
Returns:

configurePage

  1. public void configurePage(javax.servlet.ServletContext applicationValue,
  2. javax.servlet.http.HttpServletRequest request,
  3. long windowIdMode)
  4. throws java.lang.Exception
Description copied from class: WcmController
Call this before making any calls to registerModule. This call performs initialization on DataStore globals, as well as initialization of the Controller.
Overrides:
configurePage in class WcmController
Parameters:
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.
Throws:
java.lang.Exception

configureHeaderModule

  1. public void configureHeaderModule( )
  2. throws java.lang.Exception
Description copied from class: WcmController
Configures the default toolkit implementation - WcmHeaderModule.
Specified by:
configureHeaderModule in interface WcmControllerBehaviorInterface
Overrides:
configureHeaderModule in class WcmController
Throws:
java.lang.Exception

isPreControllerEvent

  1. public boolean isPreControllerEvent( java.lang.String eventName)
Description copied from interface: WcmControllerBehaviorInterface
Return true if the named event is a valid "pre" controller event (optional).
Specified by:
isPreControllerEvent in interface WcmControllerBehaviorInterface
Overrides:
isPreControllerEvent in class WcmController
Parameters:
eventName - The name of the event.

isControllerEvent

  1. public boolean isControllerEvent( java.lang.String eventName)
Description copied from interface: WcmControllerBehaviorInterface
Return true if the named event is a valid controller event (optional).
Specified by:
isControllerEvent in interface WcmControllerBehaviorInterface
Overrides:
isControllerEvent in class WcmController
Parameters:
eventName - The name of the event.

isValidHome

  1. public boolean isValidHome(java.lang.String pageName)
  2. throws java.lang.Exception
Description copied from interface: WcmControllerBehaviorInterface
Return true if the specified page is a valid home page.
Parameters:
pageName - The name of the page.
Throws:
java.lang.Exception

getSignInPolicy

  1. public WcmSignInPolicyInterface getSignInPolicy( )
  2. throws java.lang.Exception
Description copied from class: WcmController
Factory method. Returns the singleton instance of WcmSignInPolicyInterface used with this controller implementation.
Specified by:
getSignInPolicy in interface WcmControllerBehaviorInterface
Overrides:
getSignInPolicy in class WcmController
Returns:
The instance of WcmSignInPolicyInterface.
Throws:
java.lang.Exception

getStaticInitializer

  1. public StaticInitializerInterface getStaticInitializer( )
  2. throws java.lang.Exception
Description copied from class: WcmController
getStaticInitializer. Optionally returns an instance of static initializer interface. If non-null is returned, this is called instead of calling controller.initializeStaticClasses() to initialize static classes. The base implementation returns null.
Overrides:
getStaticInitializer in class WcmController
Throws:
java.lang.Exception

getConfiguration

  1. public WcmConfigurationInterface getConfiguration( )
  2. throws java.lang.Exception
Description copied from interface: WcmControllerBehaviorInterface
Factory method. Return the singleton instance of WcmConfiguration that implements the configuration object for your controller.
Throws:
java.lang.Exception

isBootstrapRequired

  1. public boolean isBootstrapRequired( )
Description copied from class: WcmController
Returns true if required bootstrap options have not already been set by an administrator. This method is called by the getSignInPolicy method. If you're not using a bootstrap page, implement the getBootstrapPage method to return null.
Specified by:
isBootstrapRequired in interface WcmControllerBehaviorInterface
Overrides:
isBootstrapRequired in class WcmController
Returns:
boolean true or false.

getBootstrapPage

  1. public java.lang.String getBootstrapPage( )
Description copied from interface: WcmControllerBehaviorInterface
Return the name of the bootstrap page to go to if bootstrap is required.

getDefaultPage

  1. public java.lang.String getDefaultPage( )
  2. throws java.lang.Exception
Description copied from interface: WcmControllerBehaviorInterface
Return the name of the default page. This should be a fixed value.
Throws:
java.lang.Exception

getErrorPage

  1. public java.lang.String getErrorPage( )
  2. throws java.lang.Exception
Description copied from interface: WcmControllerBehaviorInterface
Return the name of the error page. This should be a fixed value.
Throws:
java.lang.Exception

getSignInPage

  1. public java.lang.String getSignInPage( )
Description copied from interface: WcmControllerBehaviorInterface
Return the name of the sign in page. This should be a fixed value.

getConfiguredHome

  1. public java.lang.String getConfiguredHome( )
  2. throws java.lang.Exception
Description copied from interface: WcmControllerBehaviorInterface
Return the configured home page. This may be set via a preferences mechanism, or, could be role based.
Throws:
java.lang.Exception

getRouters

  1. public java.util.Vector getRouters( )
  2. throws java.lang.Exception
Description copied from interface: WcmControllerBehaviorInterface
Implement this method to provide a list of the Process Engine routers that your application will be using - in the format "host:port".
Throws:
java.lang.Exception

isStickyPage

  1. public boolean isStickyPage(java.lang.String pageName)
Description copied from interface: WcmControllerBehaviorInterface
Return 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.

getWindowIdCompatibility

  1. protected boolean getWindowIdCompatibility( )
Overrides:
getWindowIdCompatibility in class WcmController