|
||||||||||
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
com.filenet.wcm.toolkit.server.base.ConfigurableController
Nested Class Summary |
Nested classes inherited from class com.filenet.wcm.toolkit.server.base.WcmController |
WcmController.GetWriterResponse, WcmController.WcmEventRequest, WcmController.WindowProperties, WcmController.WorkplacePrintWriter |
Field Summary | |
protected static boolean |
attemptedLoadingP8ControllerPrefs
|
protected static java.lang.String |
BASE_CONFIGURATION_KEY
|
protected java.lang.String |
controllerConfigName
|
protected static AllControllerPrefs |
p8ControllerPrefs
|
Constructor Summary | |
ConfigurableController()
|
Method Summary | |
void |
configureHeaderModule()
Configures the default toolkit implementation - WcmHeaderModule. |
void |
configurePage(javax.servlet.ServletContext applicationValue,
javax.servlet.http.HttpServletRequest request,
long windowIdMode)
Call this before making any calls to registerModule. |
java.lang.String |
getBootstrapPage()
Return the name of the bootstrap page to go to if bootstrap is required. |
WcmConfigurationInterface |
getConfiguration()
Factory method. |
java.lang.String |
getConfiguredHome()
Return the configured home page. |
java.lang.String |
getControllerConfigName()
Return the currently set configuration name being used. |
ControllerPrefs |
getControllerPrefs()
Get the controller preferences based on the current configuration name. |
java.lang.String |
getDefaultPage()
Return the name of the default page. |
java.lang.String |
getErrorPage()
Return the name of the error page. |
java.util.Vector |
getRouters()
Implement this method to provide a list of the Process Engine routers that your application will be using - in the format "host:port". |
java.lang.String |
getSignInPage()
Return the name of the sign in page. |
WcmSignInPolicyInterface |
getSignInPolicy()
Factory method. |
StaticInitializerInterface |
getStaticInitializer()
getStaticInitializer. |
protected boolean |
getWindowIdCompatibility()
|
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). |
boolean |
isPreControllerEvent(java.lang.String eventName)
Return true if the named event is a valid "pre" controller event (optional). |
boolean |
isStickyPage(java.lang.String pageName)
Return true if the specified page is sticky. |
boolean |
isValidHome(java.lang.String pageName)
Return true if the specified page is a valid home page. |
void |
setControllerConfigName(java.lang.String name)
Sets the controller configuration name. |
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 |
protected java.lang.String controllerConfigName
protected static AllControllerPrefs p8ControllerPrefs
protected static boolean attemptedLoadingP8ControllerPrefs
protected static final java.lang.String BASE_CONFIGURATION_KEY
Constructor Detail |
public ConfigurableController()
Method Detail |
public ControllerPrefs getControllerPrefs()
public void setControllerConfigName(java.lang.String name)
name
- The configuration name.public java.lang.String getControllerConfigName()
public void configurePage(javax.servlet.ServletContext applicationValue, javax.servlet.http.HttpServletRequest request, long windowIdMode) throws java.lang.Exception
WcmController
configurePage
in class WcmController
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 configureHeaderModule() throws java.lang.Exception
WcmController
configureHeaderModule
in interface WcmControllerBehaviorInterface
configureHeaderModule
in class WcmController
java.lang.Exception
public boolean isPreControllerEvent(java.lang.String eventName)
WcmControllerBehaviorInterface
isPreControllerEvent
in interface WcmControllerBehaviorInterface
isPreControllerEvent
in class WcmController
public boolean isControllerEvent(java.lang.String eventName)
WcmControllerBehaviorInterface
isControllerEvent
in interface WcmControllerBehaviorInterface
isControllerEvent
in class WcmController
public boolean isValidHome(java.lang.String pageName) throws java.lang.Exception
WcmControllerBehaviorInterface
pageName
- The name of the page.
java.lang.Exception
public WcmSignInPolicyInterface getSignInPolicy() throws java.lang.Exception
WcmController
getSignInPolicy
in interface WcmControllerBehaviorInterface
getSignInPolicy
in class WcmController
java.lang.Exception
public StaticInitializerInterface getStaticInitializer() throws java.lang.Exception
WcmController
getStaticInitializer
in class WcmController
java.lang.Exception
public WcmConfigurationInterface getConfiguration() throws java.lang.Exception
WcmControllerBehaviorInterface
java.lang.Exception
public boolean isBootstrapRequired()
WcmController
getSignInPolicy
method. If you're not using a bootstrap page, implement the
getBootstrapPage
method to return null.
isBootstrapRequired
in interface WcmControllerBehaviorInterface
isBootstrapRequired
in class WcmController
public java.lang.String getBootstrapPage()
WcmControllerBehaviorInterface
public java.lang.String getDefaultPage() throws java.lang.Exception
WcmControllerBehaviorInterface
java.lang.Exception
public java.lang.String getErrorPage() throws java.lang.Exception
WcmControllerBehaviorInterface
java.lang.Exception
public java.lang.String getSignInPage()
WcmControllerBehaviorInterface
public java.lang.String getConfiguredHome() throws java.lang.Exception
WcmControllerBehaviorInterface
java.lang.Exception
public java.util.Vector getRouters() throws java.lang.Exception
WcmControllerBehaviorInterface
java.lang.Exception
public boolean isStickyPage(java.lang.String pageName)
WcmControllerBehaviorInterface
pageName
- The name of the page.protected boolean getWindowIdCompatibility()
getWindowIdCompatibility
in class WcmController
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |