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.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.ACCESS_DENIED

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CheckAccess()

Method Summary

Methods

Modifier and Type	Method and Description
void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setAccessControlService(net.shibboleth.utilities.java.support.security.AccessControlService acs) Set the service to use.
void	setOperation(String op) Set operation.
void	setPolicyName(String name) Set policy name.
void	setResource(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 Logger log

Class logger.

service

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

Access control service.

policyName

@NonnullAfterInit
private String policyName

Policy name.

operation

@Nullable
private String operation

Operation.

resource

@Nullable
private 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
                 String name)

Set policy name.

Parameters:

name - policy name

setOperation

public void setOperation(@Nonnull
                String op)

Set operation.

Parameters:

op - operation

setResource

public void setResource(@Nonnull
               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)

Overrides:

doPreExecute in class AbstractProfileAction

doExecute

public void doExecute(@Nonnull
             ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction