org.opensaml.profile.action.impl

Class CheckAccess

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.impl.CheckAccess

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, ProfileAction

public class CheckAccess
extends AbstractProfileAction

This action validates that a request comes from an authorized client, based on an injected service and policy parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
private java.lang.String	operation Operation.
private java.lang.String	policyName Policy name.
private java.lang.String	resource Resource.
private net.shibboleth.utilities.java.support.security.AccessControlService	service Access control service.

Constructor Summary

Constructors

Constructor and Description
CheckAccess()

Method Summary

Modifier and Type	Method and Description
void	doExecute(ProfileRequestContext profileRequestContext) Performs this action.
protected void	doInitialize()
boolean	doPreExecute(ProfileRequestContext profileRequestContext) Called prior to execution, actions may override this method to perform pre-processing for a request.
void	setAccessControlService(net.shibboleth.utilities.java.support.security.AccessControlService acs) Set the service to use.
void	setOperation(java.lang.String op) Set operation.
void	setPolicyName(java.lang.String name) Set policy name.
void	setResource(java.lang.String res) Set resource.

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

service

@NonnullAfterInit
private net.shibboleth.utilities.java.support.security.AccessControlService service

Access control service.

policyName

@NonnullAfterInit
private java.lang.String policyName

Policy name.

operation

@Nullable
private java.lang.String operation

Operation.

resource

@Nullable
private java.lang.String resource

Resource.

Constructor Detail

CheckAccess

public CheckAccess()

Method Detail

setAccessControlService

public void setAccessControlService(@Nonnull
                                    net.shibboleth.utilities.java.support.security.AccessControlService acs)

Set the service to use.

Parameters:

acs - service to use

setPolicyName

public void setPolicyName(@Nonnull
                          java.lang.String name)

Set policy name.

Parameters:

name - policy name

setOperation

public void setOperation(@Nonnull
                         java.lang.String op)

Set operation.

Parameters:

op - operation

setResource

public void setResource(@Nonnull
                        java.lang.String res)

Set resource.

Parameters:

res - resource

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doPreExecute

public boolean doPreExecute(@Nonnull
                            ProfileRequestContext profileRequestContext)

Called prior to execution, actions may override this method to perform pre-processing for a request.

If false is returned, execution will not proceed, and the action should attach an EventContext to the context tree to signal how to continue with overall workflow processing.

If returning successfully, the last step should be to return the result of the superclass version of this method.

Overrides:

doPreExecute in class AbstractProfileAction

Parameters:

profileRequestContext - the current IdP profile request context

Returns:

true iff execution should proceed

doExecute

public void doExecute(@Nonnull
                      ProfileRequestContext profileRequestContext)

Performs this action. Actions must override this method to perform their work.

Overrides:

doExecute in class AbstractProfileAction

Parameters:

profileRequestContext - the current IdP profile request context