|
||||||||||
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.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmSignInModule
UI module that renders Sign In screen
Field Summary | |
protected WcmController |
controller
|
static WcmString |
CREDENTIALS_EXCEPTION
|
static WcmString |
ERR_LABEL
|
static WcmString |
GUEST_LABEL
|
protected boolean |
guestAllowed
|
protected java.lang.String |
guestPassword
|
protected java.lang.String |
guestUserName
|
static WcmString |
HELP_LABEL
|
protected boolean |
isClientTimeZoneDefined
|
protected java.lang.Boolean |
isLocal
|
static WcmString |
PASSWORD_LABEL
|
static WcmString |
RESET_LABEL
|
protected java.util.HashMap |
signInParameters
|
protected WcmSignInProcessor |
signInProcessor
|
static WcmString |
SUBMIT_LABEL
|
protected java.lang.String |
targetHelpUrl
|
static java.lang.String |
TYPE_GUEST
|
static WcmString |
USER_LABEL
|
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmSignInModule()
|
Method Summary | |
static boolean |
areRequiredParametersPresent(WcmController controller,
javax.servlet.http.HttpServletRequest request)
|
java.lang.String |
getErrorMessage()
If the last sign-in was unsuccessful, this method will return the error message string related to the exception that was caught. |
java.lang.String |
getErrorPage()
|
java.lang.String |
getFormName()
Returns the form name used by WcmSignInModule. |
protected void |
getGuestConfiguration()
Override, initializes guest information |
java.lang.String |
getHiddenFields()
Return a set of hidden fields that can optionally be written into the sign-in form. |
java.lang.String |
getLastUser()
If the last sign-in was unsuccessful, this method will return the username that signin was attempted on - assuming it wasn't a guest sign-in. |
int |
getMaxErrorLength()
Returns the recommended maximimum length of the error message's length to show on the sign-in page. |
java.util.HashMap |
getSignInParameters(javax.servlet.http.HttpServletRequest request)
|
protected WcmSignInProcessor |
getSignInProcessor(javax.servlet.http.HttpServletRequest request)
|
java.lang.String |
getTargetBase()
Get the value of the target base. |
java.lang.String |
getTargetUrl()
Get the value of the target URL. |
void |
initialize()
Override, and initialize this UI module. |
boolean |
isGuestAllowed()
Return true or false value that specifies whether or not this application is configured to allow guest sign ins. |
boolean |
isSessionLocal()
|
boolean |
isSessionLocal(javax.servlet.http.HttpServletRequest request)
Returns true if the session is local |
boolean |
isTokenException()
|
void |
onGuestSignIn(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event handler for GuestSignIn event. |
void |
onReset(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event handler for the Reset event, which causes any displayed error messages to be cleared, causes "getErrorMessage()" to return null. |
void |
onSignIn(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event handler for SignIn event - when the user has entered credentials, and submits the form. |
void |
onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event handler for the Reset event, which causes any displayed error messages to be cleared, causes "getErrorMessage()" to return null. |
void |
render(java.io.Writer w)
Renders the module |
protected void |
returnToPage()
Redirect to the start page as specified either by targetBase and targetUrl. |
protected void |
setErrorMessage(java.lang.String value)
|
protected void |
setErrorPage(java.lang.String value)
|
protected void |
setLastUser(java.lang.String value)
|
protected void |
setTokenException(boolean value)
|
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule |
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP |
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule |
subscribeGlobalEvent |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer |
addDataProvider, addDataProvider |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Field Detail |
public static final java.lang.String TYPE_GUEST
public static final WcmString SUBMIT_LABEL
public static final WcmString RESET_LABEL
public static final WcmString GUEST_LABEL
public static final WcmString HELP_LABEL
public static final WcmString USER_LABEL
public static final WcmString PASSWORD_LABEL
public static final WcmString ERR_LABEL
public static final WcmString CREDENTIALS_EXCEPTION
protected boolean guestAllowed
protected java.lang.String guestUserName
protected java.lang.String guestPassword
protected java.lang.String targetHelpUrl
protected WcmSignInProcessor signInProcessor
protected java.lang.Boolean isLocal
protected WcmController controller
protected java.util.HashMap signInParameters
protected boolean isClientTimeZoneDefined
Constructor Detail |
public WcmSignInModule()
Method Detail |
public void initialize() throws java.lang.Exception
initialize
in interface WcmModuleInterface
initialize
in class WcmModule
java.lang.Exception
public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
onStartPage
in interface WcmUiModuleInterface
onStartPage
in class GlobalEventModule
request
- HttpServletRequestresponse
- HttpServletResponse
java.lang.Exception
public boolean isSessionLocal()
public boolean isSessionLocal(javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
request
-
java.lang.Exception
public java.lang.String getFormName()
getFormName
in interface WcmUiModuleInterface
getFormName
in class WcmUiModule
public int getMaxErrorLength()
public java.lang.String getHiddenFields()
protected void getGuestConfiguration() throws java.lang.Exception
java.lang.Exception
public java.util.HashMap getSignInParameters(javax.servlet.http.HttpServletRequest request)
protected WcmSignInProcessor getSignInProcessor(javax.servlet.http.HttpServletRequest request) throws java.lang.Exception
java.lang.Exception
public static boolean areRequiredParametersPresent(WcmController controller, javax.servlet.http.HttpServletRequest request)
public boolean isGuestAllowed()
public java.lang.String getTargetBase()
public java.lang.String getTargetUrl()
protected void returnToPage() throws java.lang.Exception
java.lang.Exception
public void onSignIn(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequestresponse
- HttpServletResponse
java.lang.Exception
public void onGuestSignIn(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequestresponse
- HttpServletResponse
java.lang.Exception
public void onReset(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequestresponse
- HttpServletResponse
java.lang.Exception
public java.lang.String getLastUser() throws java.lang.Exception
java.lang.Exception
protected void setLastUser(java.lang.String value) throws java.lang.Exception
java.lang.Exception
public java.lang.String getErrorMessage() throws java.lang.Exception
java.lang.Exception
protected void setErrorMessage(java.lang.String value) throws java.lang.Exception
java.lang.Exception
public java.lang.String getErrorPage() throws java.lang.Exception
java.lang.Exception
protected void setErrorPage(java.lang.String value) throws java.lang.Exception
java.lang.Exception
public boolean isTokenException() throws java.lang.Exception
java.lang.Exception
protected void setTokenException(boolean value) throws java.lang.Exception
java.lang.Exception
public void render(java.io.Writer w) throws java.lang.Exception
render
in interface WcmUiModuleInterface
render
in class WcmUiModule
w
-
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |