Package com.sun.identity.config.util

Class ProtectedPage

java.lang.Object

org.openidentityplatform.openam.click.Page

com.sun.identity.config.util.AjaxPage

com.sun.identity.config.util.ProtectedPage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DefaultSummary, LDAPStoreWizardPage, Step1, Step2, Step4, Step5, Step6, Step7, Wizard

public class ProtectedPage
extends AjaxPage

Any page that needs to be protected post OpenAM setup should extend this class, for example, all the Config Wizard pages.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sun.identity.config.util.AjaxPage

checkPasswordsLink, configLocale, debug, OLD_RESPONSE_TEMPLATE, rb, RB_NAME, resetSessionAttributesLink, RESPONSE_TEMPLATE, responseString, validateInputLink

Fields inherited from class org.openidentityplatform.openam.click.Page

controls, format, forward, headElements, headers, includeControlHeadElements, messages, model, PAGE_ACTION, PAGE_MESSAGES, pageImports, path, redirect, stateful, template

Constructor Summary

Constructors

Constructor	Description
ProtectedPage()

Method Summary

Modifier and Type	Method	Description
boolean	onSecurityCheck()	The on Security Check event handler.

Methods inherited from class com.sun.identity.config.util.AjaxPage

checkPasswords, getAttribute, getAvailablePort, getBaseDir, getConnection, getCookieDomain, getHostName, getHostName, getLocalizedString, getQuoteEscapedLocalizedString, getServerPort, initializeResourceBundle, isRendering, onInit, resetSessionAttributes, toBoolean, toInt, toString, validateInput, writeErrorToResponse, writeInvalid, writeJsonResponse, writeJsonResponse, writeToResponse, writeValid, writeValid

Methods inherited from class org.openidentityplatform.openam.click.Page

addControl, addModel, getContentType, getContext, getControls, getFormat, getForward, getHeadElements, getHeaders, getHtmlImports, getMessage, getMessage, getMessages, getModel, getPageImports, getPath, getRedirect, getTemplate, hasControls, hasHeaders, isIncludeControlHeadElements, isStateful, onDestroy, onGet, onPost, onRender, removeControl, setFormat, setForward, setForward, setForward, setHeader, setHeaders, setIncludeControlHeadElements, setPageImports, setPath, setRedirect, setRedirect, setRedirect, setRedirect, setStateful, setTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtectedPage

public ProtectedPage()

Method Detail

onSecurityCheck

public boolean onSecurityCheck()

Description copied from class: org.openidentityplatform.openam.click.Page

The on Security Check event handler. This event handler is invoked after the pages constructor has been called and all the page properties have been set.

Security check provides the Page an opportunity to check the users security credentials before processing the Page.

If security check returns true the Page is processed as normal. If the method returns then no other event handlers are invoked (except onDestroy() and no page controls are processed.

If the method returns false, the forward or redirect property should be set to send the request to another Page.

By default this method returns true, subclass may override this method to provide their security authorization/authentication mechanism.

Overrides:

onSecurityCheck in class org.openidentityplatform.openam.click.Page

Returns:

true by default, subclasses may override this method