com.filenet.wcm.toolkit.server.util.prefs
Class ControllerPrefs

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
      extended bycom.filenet.wcm.toolkit.server.util.prefs.ControllerPrefs
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class ControllerPrefs
extends WcmPrefsObject

See Also:
Serialized Form

Field Summary
static java.lang.String BOOTSTRAP_PAGE_KEY
           
static java.lang.String BOOTSTRAP_REQUIRED_KEY
           
static java.lang.String CONFIGURATION_NAME_KEY
           
static java.lang.String CONTROLLER_EVENTS_KEY
           
protected  java.util.Map controllerEvents
           
static java.lang.String DEFAULT_HOME_KEYWORD_KEY
           
static java.lang.String DEFAULT_PAGE_KEY
           
static java.lang.String DEFAULT_ROUTER_KEY
           
static java.lang.String ERROR_PAGE_KEY
           
static java.lang.String HEADER_MODULE_KEY
           
static java.lang.String HOME_PAGES_KEY
           
protected  java.util.Map homePages
           
protected  java.util.Map homePagesByName
           
protected  java.util.List homePagesList
           
static java.lang.String IGNORE_FILTER_CREDENTIALS
           
static java.lang.String INTERNAL_TOKENS_ENABLED
           
static java.lang.String PRE_CONTROLLER_EVENTS_KEY
           
protected  java.util.Map preControllerEvents
           
static java.lang.String PREFS_CONFIG_KEY
           
static java.lang.String SIGNIN_PAGE_KEY
           
static java.lang.String SIGNIN_POLICY_KEY
           
static java.lang.String SIGNIN_REQUIRED_KEY
           
static java.lang.String STATIC_INITIALIZER_KEY
           
static java.lang.String USER_TOKEN_POLICY_KEY
           
static java.lang.String WINDOW_ID_COMPATIBILITY
           
 
Constructor Summary
ControllerPrefs()
           
 
Method Summary
 java.lang.String getBootstrapPage()
           
 boolean getBootstrapRequired()
           
protected  java.lang.Class getClass(java.lang.String className, java.lang.Class defaultClass)
           
 java.lang.Class getConfigurationClass()
           
 java.lang.String getConfigurationName()
           
 java.lang.String[] getControllerEvents()
           
 java.lang.String getDefaultHomeKeyword()
           
 java.lang.String getDefaultPage()
           
 java.lang.String getDefaultRouter()
           
 java.lang.String getErrorPage()
           
 java.lang.Class getHeaderModuleClass()
           
 HomePagePrefs getHomePage(java.lang.String key)
           
 java.util.Iterator getHomePageKeys()
           
 java.util.List getHomePageList()
           
 boolean getInternalTokensEnabled()
           
 java.lang.String getKey()
           
 java.lang.String[] getPreControllerEvents()
           
 java.lang.String getSignInPage()
           
 java.lang.Class getSignInPolicyClass()
           
 boolean getSignInRequired()
           
 java.lang.Class getStaticInitializerClass()
           
 java.lang.Class getUserTokenPolicyClass()
           
 boolean getWindowIdCompatibility()
           
 boolean ignoreFilterCredentials()
           
protected  void initialize()
          In sub-classes, read the values from internal map using get methods into member variables.
 boolean isControllerEvent(java.lang.String eventName)
           
 boolean isPreControllerEvent(java.lang.String eventName)
           
 boolean isValidHome(boolean isGuest, java.lang.String pageName)
           
protected  void persist()
          In sub-classes, write the values from member variables into the internal map using put method.
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.prefs.WcmPrefsObject
clear, clearAttributes, clone, convertToBoolean, convertToBoolean, convertToInt, convertToLong, convertToPrefsLabel, convertToPrefsLabelArray, equals, get, getAttribute, getBoolean, getElementKey, getInt, getLabel, getLabelArray, getList, getLocalizedString, getString, getStringArray, getVersion, load, load, load, load, loadLabel, loadPreferences, loadPreferences, loadPreferences, put, put, put, put, put, put, put, put, registerKey, remove, removeAttribute, removeLocalizedString, saveToXML, setAttribute, setElementKey, setVersion, toByteArrayXML, toXML, writeEndSettingTag, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeSetting, writeStartSettingTag, writeStartSettingTag, writeXML, writeXML
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONFIGURATION_NAME_KEY

public static final java.lang.String CONFIGURATION_NAME_KEY
See Also:
Constant Field Values

SIGNIN_POLICY_KEY

public static final java.lang.String SIGNIN_POLICY_KEY
See Also:
Constant Field Values

USER_TOKEN_POLICY_KEY

public static final java.lang.String USER_TOKEN_POLICY_KEY
See Also:
Constant Field Values

HEADER_MODULE_KEY

public static final java.lang.String HEADER_MODULE_KEY
See Also:
Constant Field Values

STATIC_INITIALIZER_KEY

public static final java.lang.String STATIC_INITIALIZER_KEY
See Also:
Constant Field Values

PREFS_CONFIG_KEY

public static final java.lang.String PREFS_CONFIG_KEY
See Also:
Constant Field Values

BOOTSTRAP_PAGE_KEY

public static final java.lang.String BOOTSTRAP_PAGE_KEY
See Also:
Constant Field Values

DEFAULT_PAGE_KEY

public static final java.lang.String DEFAULT_PAGE_KEY
See Also:
Constant Field Values

SIGNIN_PAGE_KEY

public static final java.lang.String SIGNIN_PAGE_KEY
See Also:
Constant Field Values

ERROR_PAGE_KEY

public static final java.lang.String ERROR_PAGE_KEY
See Also:
Constant Field Values

BOOTSTRAP_REQUIRED_KEY

public static final java.lang.String BOOTSTRAP_REQUIRED_KEY
See Also:
Constant Field Values

SIGNIN_REQUIRED_KEY

public static final java.lang.String SIGNIN_REQUIRED_KEY
See Also:
Constant Field Values

DEFAULT_HOME_KEYWORD_KEY

public static final java.lang.String DEFAULT_HOME_KEYWORD_KEY
See Also:
Constant Field Values

PRE_CONTROLLER_EVENTS_KEY

public static final java.lang.String PRE_CONTROLLER_EVENTS_KEY
See Also:
Constant Field Values

CONTROLLER_EVENTS_KEY

public static final java.lang.String CONTROLLER_EVENTS_KEY
See Also:
Constant Field Values

HOME_PAGES_KEY

public static final java.lang.String HOME_PAGES_KEY
See Also:
Constant Field Values

DEFAULT_ROUTER_KEY

public static final java.lang.String DEFAULT_ROUTER_KEY
See Also:
Constant Field Values

INTERNAL_TOKENS_ENABLED

public static final java.lang.String INTERNAL_TOKENS_ENABLED
See Also:
Constant Field Values

WINDOW_ID_COMPATIBILITY

public static final java.lang.String WINDOW_ID_COMPATIBILITY
See Also:
Constant Field Values

IGNORE_FILTER_CREDENTIALS

public static final java.lang.String IGNORE_FILTER_CREDENTIALS
See Also:
Constant Field Values

homePagesList

protected java.util.List homePagesList

homePages

protected java.util.Map homePages

homePagesByName

protected java.util.Map homePagesByName

controllerEvents

protected java.util.Map controllerEvents

preControllerEvents

protected java.util.Map preControllerEvents
Constructor Detail

ControllerPrefs

public ControllerPrefs()
Method Detail

getKey

public java.lang.String getKey()

getConfigurationName

public java.lang.String getConfigurationName()

getSignInPolicyClass

public java.lang.Class getSignInPolicyClass()
                                     throws java.lang.ClassNotFoundException
Throws:
java.lang.ClassNotFoundException

getUserTokenPolicyClass

public java.lang.Class getUserTokenPolicyClass()
                                        throws java.lang.ClassNotFoundException
Throws:
java.lang.ClassNotFoundException

getHeaderModuleClass

public java.lang.Class getHeaderModuleClass()
                                     throws java.lang.ClassNotFoundException
Throws:
java.lang.ClassNotFoundException

getConfigurationClass

public java.lang.Class getConfigurationClass()
                                      throws java.lang.ClassNotFoundException
Throws:
java.lang.ClassNotFoundException

getStaticInitializerClass

public java.lang.Class getStaticInitializerClass()
                                          throws java.lang.ClassNotFoundException
Throws:
java.lang.ClassNotFoundException

getClass

protected java.lang.Class getClass(java.lang.String className,
                                   java.lang.Class defaultClass)
                            throws java.lang.ClassNotFoundException
Throws:
java.lang.ClassNotFoundException

getBootstrapPage

public java.lang.String getBootstrapPage()

getDefaultPage

public java.lang.String getDefaultPage()

getSignInPage

public java.lang.String getSignInPage()

getErrorPage

public java.lang.String getErrorPage()

getBootstrapRequired

public boolean getBootstrapRequired()

getSignInRequired

public boolean getSignInRequired()

getDefaultHomeKeyword

public java.lang.String getDefaultHomeKeyword()

getPreControllerEvents

public java.lang.String[] getPreControllerEvents()

getControllerEvents

public java.lang.String[] getControllerEvents()

getDefaultRouter

public java.lang.String getDefaultRouter()

getInternalTokensEnabled

public boolean getInternalTokensEnabled()

ignoreFilterCredentials

public boolean ignoreFilterCredentials()

getWindowIdCompatibility

public boolean getWindowIdCompatibility()

isPreControllerEvent

public boolean isPreControllerEvent(java.lang.String eventName)

isControllerEvent

public boolean isControllerEvent(java.lang.String eventName)

isValidHome

public boolean isValidHome(boolean isGuest,
                           java.lang.String pageName)
                    throws java.lang.Exception
Throws:
java.lang.Exception

getHomePage

public HomePagePrefs getHomePage(java.lang.String key)

getHomePageList

public java.util.List getHomePageList()

getHomePageKeys

public java.util.Iterator getHomePageKeys()

initialize

protected void initialize()
Description copied from class: WcmPrefsObject
In sub-classes, read the values from internal map using get methods into member variables.

Overrides:
initialize in class WcmPrefsObject

persist

protected void persist()
Description copied from class: WcmPrefsObject
In sub-classes, write the values from member variables into the internal map using put method. Do this if you are not overwriting saveToXML method.

Overrides:
persist in class WcmPrefsObject


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