com.atlassian.crowd.openid.server.action.secure.interaction

Class AllowAuthentication

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.crowd.openid.server.action.BaseAction

com.atlassian.crowd.openid.server.action.secure.interaction.AllowAuthentication

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

public class AllowAuthentication
extends BaseAction

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.crowd.openid.server.action.BaseAction

actionMessageAlertColor, ALERT_BLUE, ALERT_RED, ALERT_YELLOW, openIDAuthenticationManager, openIDPropertyManager, profileManager, siteManager, userManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
AllowAuthentication()

Method Summary

Modifier and Type	Method and Description
String	allow() Allow OpenID authentication to a client site (RP).
String	allowAlways() Always allow OpenID authentication to a client site (RP).
String	deny() Deny OpenID authentication to a client site (RP).
String	execute() Display the Allow/Disallow authentication screen.
Profile	getCurrentProfile()
String	getIdentifier()
Collection	getOptionalAttributes()
ProfileAttributesHelper	getProfileAttributesHelper()
long	getProfileID()
String	getRequestingSite()
Collection	getRequiredAttributes()
SREGAttributes	getSregAttributes()
User	getUser()
void	setCurrentProfile(Profile currentProfile)
void	setIdentifier(String identifier)
void	setOptionalAttributes(Collection optionalAttributes)
void	setProfileID(long profileID)
void	setRequestingSite(String requestingSite)
void	setRequiredAttributes(Collection requiredAttributes)
void	setSregAttributes(SREGAttributes sregAttributes)
void	setUser(User user)

Methods inherited from class com.atlassian.crowd.openid.server.action.BaseAction

addActionMessage, baseUrl, containsActionMessages, getActionMessageAlertColor, getBaseURL, getCrowdClient, getCrowdHttpAuthenticator, getPrincipalName, getRemotePrincipal, getRequest, getSession, getXsrfToken, getXsrfTokenName, isAdministrator, isAuthenticated, setCrowdClient, setCrowdHttpAuthenticator, setOpenIDAuthenticationManager, setProfileManager, setPropertyManager, setSiteManager, setUserManager, setXsrfTokenGenerator

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocale, getLocaleProvider, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

AllowAuthentication

public AllowAuthentication()

Method Detail

execute

public String execute()
               throws Exception

Display the Allow/Disallow authentication screen. The profile selected will be a 'remembered' profile from previous 'allow' authentication actions, or, the user's default profile (if the user hasn't previously allowed authentication to the site). If the user has previously 'always allowed' verification to the requesting site, this screen is bypassed and the default profile associated with the site will be used for attribute values.

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Returns:

ERROR if there is no authentication request message in session, otherwise INPUT.

Throws:

Exception

allow

public String allow()
             throws Exception

Allow OpenID authentication to a client site (RP). The profile selected (when the user clicks AllowAuthentication) will be 'remembered' for next time.

Returns:

SUCCESS

Throws:

Exception

allowAlways

public String allowAlways()
                   throws Exception

Always allow OpenID authentication to a client site (RP). The profile selected (when the user clicks AllowAuthentication) will be 'remembered' for next time. All following authentications with this site will occur automatically.

Returns:

SUCCESS

Throws:

Exception

deny

public String deny()
            throws Exception

Deny OpenID authentication to a client site (RP).

Returns:

SUCCESS

Throws:

Exception

getRequestingSite

public String getRequestingSite()

setRequestingSite

public void setRequestingSite(String requestingSite)

getIdentifier

public String getIdentifier()

Overrides:

getIdentifier in class BaseAction

setIdentifier

public void setIdentifier(String identifier)

getRequiredAttributes

public Collection getRequiredAttributes()

setRequiredAttributes

public void setRequiredAttributes(Collection requiredAttributes)

getOptionalAttributes

public Collection getOptionalAttributes()

setOptionalAttributes

public void setOptionalAttributes(Collection optionalAttributes)

getUser

public User getUser()

setUser

public void setUser(User user)

getProfileID

public long getProfileID()

setProfileID

public void setProfileID(long profileID)

getCurrentProfile

public Profile getCurrentProfile()

setCurrentProfile

public void setCurrentProfile(Profile currentProfile)

getSregAttributes

public SREGAttributes getSregAttributes()

setSregAttributes

public void setSregAttributes(SREGAttributes sregAttributes)

getProfileAttributesHelper

public ProfileAttributesHelper getProfileAttributesHelper()