com.uwyn.rife.authentication.elements
Class RoleUserAuthenticated

java.lang.Object
  extended by com.uwyn.rife.engine.ElementSupport
      extended by com.uwyn.rife.engine.Element
          extended by com.uwyn.rife.authentication.elements.Identified
              extended by com.uwyn.rife.authentication.elements.Authenticated
                  extended by com.uwyn.rife.authentication.elements.RoleUserAuthenticated
All Implemented Interfaces:
SessionAttributes, ContinuableObject, ElementAware, Cloneable
Direct Known Subclasses:
DatabaseAuthenticated, FactoryPropertyAuthenticated, MemoryAuthenticated, MixedAuthenticated, PurgingDatabaseAuthenticated, PurgingMemoryAuthenticated, PurgingMixedAuthenticated

public abstract class RoleUserAuthenticated
extends Authenticated

Extends the generic Authenticated element with support for a role property that will be used together with RoleUserCredentials credentials to only allow people with that role to access the child page.

Since:
1.0
Version:
$Revision: 3643 $
Author:
Geert Bevin (gbevin[remove] at uwyn dot com)

Field Summary
 
Fields inherited from class com.uwyn.rife.authentication.elements.Authenticated
mTemplateName
 
Fields inherited from class com.uwyn.rife.authentication.elements.Identified
IDENTITY_ATTRIBUTE_NAME
 
Constructor Summary
RoleUserAuthenticated()
           
 
Method Summary
 String getAttribute(String key)
          Retrieves the value of a particular attribute.
 boolean hasAttribute(String key)
          Checks if a certain attribute is present.
protected  void validatedCredentials(Credentials credentials)
          Hook method that is called on login form submission when the credentials are validated without errors
 
Methods inherited from class com.uwyn.rife.authentication.elements.Authenticated
acceptedCredentials, authenticated, childTriggered, createAuthenticationRequestAttributeName, entrance, getAuthElement, getAuthenticatedElementId, getCredentialsClass, getSessionValidator, initializeAuthentication, processElement, refusedCredentials, sessionCreationError, sessionNotValid, setTemplateName, unvalidatedCredentials
 
Methods inherited from class com.uwyn.rife.authentication.elements.Identified
getAuthElementId, getIdentity, setIdentityAttribute
 
Methods inherited from class com.uwyn.rife.engine.Element
clone, noticeElement
 
Methods inherited from class com.uwyn.rife.engine.ElementSupport
addDateHeader, addHeader, addIntHeader, addOutputValue, addOutputValue, addOutputValue, addOutputValue, addOutputValue, addOutputValue, addOutputValue, addOutputValue, addOutputValue, addOutputValues, answer, answer, call, child, clearBuffer, clearNamedOutputBean, clearOutput, clearOutputBean, clearOutputBean, cloneContinuations, containsHeader, defer, duringStepBack, enableTextBuffer, encodeHtml, encodeXml, evaluateExpressionRoleUserTags, exit, fillSubmissionBean, fillSubmissionBean, fillSubmissionBean, fillSubmissionBean, flush, forward, generateEmptyForm, generateEmptyForm, generateForm, generateForm, getContentType, getContinuationId, getCookie, getCookieValue, getCookieValue, getCookieValueBoolean, getCookieValueBoolean, getCookieValueDouble, getCookieValueDouble, getCookieValueFloat, getCookieValueFloat, getCookieValueInt, getCookieValueInt, getCookieValueLong, getCookieValueLong, getCookieValues, getDateHeader, getDeclarationName, getDeployer, getDeploymentClass, getElementContext, getElementInfo, getEmbedData, getEmbedDifferentiator, getEmbeddingElement, getEmbeddingTemplate, getEmbedProperties, getEmbedValue, getExitFormParameters, getExitFormParameters, getExitFormParametersJavascript, getExitFormUrl, getExitFormUrl, getExitQueryUrl, getExitQueryUrl, getExitQueryUrl, getExitQueryUrl, getHeader, getHeaderNames, getHeaders, getHtmlTemplate, getHtmlTemplate, getHtmlTemplate, getHtmlTemplate, getHtmlTemplate, getHttpServletRequest, getHttpServletResponse, getInitConfig, getInput, getInput, getInputBean, getInputBean, getInputBoolean, getInputBoolean, getInputDate, getInputDate, getInputDouble, getInputDouble, getInputFloat, getInputFloat, getInputInt, getInputInt, getInputLong, getInputLong, getInputSerializable, getInputSerializable, getInputValues, getIntHeader, getMethod, getNamedInputBean, getNamedSubmissionBean, getNamedSubmissionBean, getOutput, getOutputStream, getParameter, getParameter, getParameterBoolean, getParameterBoolean, getParameterDouble, getParameterDouble, getParameterDoubleValues, getParameterFloat, getParameterFloat, getParameterFloatValues, getParameterInt, getParameterInt, getParameterIntValues, getParameterLong, getParameterLong, getParameterLongValues, getParameterNames, getParameterNames, getParameterValues, getPathInfo, getProperty, getProperty, getPropertyString, getPropertyString, getPropertyTyped, getPropertyTyped, getProtocol, getRemoteAddr, getRemoteHost, getRemoteUser, getRequestAttribute, getRequestAttributeNames, getRequestCharacterEncoding, getRequestLocale, getRequestLocales, getResponseCharacterEncoding, getResponseLocale, getScheme, getServerName, getServerPort, getServerRootUrl, getServletContext, getSite, getSourceName, getSubmission, getSubmissionBean, getSubmissionBean, getSubmissionBean, getSubmissionBean, getSubmissionFormParameters, getSubmissionFormParameters, getSubmissionFormParametersJavascript, getSubmissionFormUrl, getSubmissionFormUrl, getSubmissionQueryUrl, getSubmissionQueryUrl, getSubmissionQueryUrl, getSubmissionQueryUrl, getTarget, getTxtTemplate, getTxtTemplate, getTxtTemplate, getTxtTemplate, getTxtTemplate, getUploadedFile, getUploadedFileNames, getUploadedFileNames, getUploadedFiles, getWebappRootUrl, getXhtmlTemplate, getXhtmlTemplate, getXhtmlTemplate, getXhtmlTemplate, getXhtmlTemplate, getXmlTemplate, getXmlTemplate, getXmlTemplate, getXmlTemplate, getXmlTemplate, hasCookie, hasEmbedData, hasEmbedValue, hasInputValue, hasParameterValue, hasProperty, hasRequestAttribute, hasSubmission, hasSubmission, hasUploadedFile, initialize, isEmbedded, isFileEmpty, isInputEmpty, isParameterEmpty, isPropertyEmpty, isSecure, isTextBufferEnabled, pause, preventCaching, print, print, processEmbeddedElement, processEmbeddedElement, processEmbeddedElement, processEmbeddedElement, processTemplate, prohibitRawAccess, redirect, removeForm, removeForm, removeRequestAttribute, selectInputParameter, selectParameter, selectSubmissionParameter, selectSubmissionParameter, sendError, sendError, sendRedirect, setChildTrigger, setCloneContinuations, setContentLength, setContentType, setCookie, setDateHeader, setDeploymentClass, setElementContext, setExitForm, setExitForm, setExitForm, setExitForm, setExitQuery, setExitQuery, setExitQuery, setExitQuery, setHeader, setInitializer, setIntHeader, setNamedOutputBean, setOutput, setOutput, setOutput, setOutput, setOutput, setOutput, setOutput, setOutput, setOutput, setOutput, setOutputBean, setOutputBean, setProhibitRawAccess, setRequestAttribute, setResponseLocale, setStatus, setSubmissionBean, setSubmissionBean, setSubmissionForm, setSubmissionForm, setSubmissionForm, setSubmissionForm, setSubmissionQuery, setSubmissionQuery, setSubmissionQuery, setSubmissionQuery, stepBack
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoleUserAuthenticated

public RoleUserAuthenticated()
Method Detail

hasAttribute

public boolean hasAttribute(String key)
Description copied from interface: SessionAttributes
Checks if a certain attribute is present.

Parameters:
key - The key that identifies the attribute.
Returns:
true if the attribute was present; or

false otherwise.

See Also:
SessionAttributes.getAttribute(String)

getAttribute

public String getAttribute(String key)
Description copied from interface: SessionAttributes
Retrieves the value of a particular attribute.

Parameters:
key - The key that identifies the attribute.
Returns:
A String instance with the value of the requested attribute; or

null if the attribute couldn't be found.

See Also:
SessionAttributes.hasAttribute(String)

validatedCredentials

protected void validatedCredentials(Credentials credentials)
Description copied from class: Authenticated
Hook method that is called on login form submission when the credentials are validated without errors

Overrides:
validatedCredentials in class Authenticated
Parameters:
credentials - the credentials object that was valid


Copyright © 2001-2007 Uwyn sprl/bvba. All Rights Reserved.