BEA AquaLogic Enterprise Security Provider SSPI 2.5 API Reference

com.bea.security.spi
Class AccessResponseCollector

java.lang.Object
  |
  +--com.bea.security.spi.AccessResponseCollector

public class AccessResponseCollector

extends java.lang.Object

This class is used to collect AccessResponse objects from authorization providers. Authorization providers capable of returning extended authorization data can detect that it has been requested by detecting a special element in the ContextHandler passed to the provider during authorization. The special element is named using AccessResponseCollector.CONTEXT_ATTR_NAME and contains a AccessResponseCollector value which the provider may append an AccessResponse object into. Not all AccessResponse objects appended into the collector will necessarily be returned to the caller. The adjudication provider may apply an AccessResponseFilter to the collector to remove particular AccessResponse objects based on the final authorization decision.

Author:

Copyright © 2004 BEA Systems, Inc. All Rights Reserved.

Field Summary

static java.lang.String	CONTEXT_ATTR_NAME The element name used when storing a AccessResponseCollector inside of a request context.
static java.lang.String	CONTEXT_ATTR_NAMESPACE The reserved namespace used when storing a AccessResponseCollector inside of a request context.
static java.lang.String	CONTEXT_ATTR_UNQUALIFIED_NAME The unqualified element name used when storing a AccessResponseCollector inside of a request context.

Constructor Summary

AccessResponseCollector()
Construct a new AccessResponseCollector.

Method Summary

void	appendAccessResponse(AccessResponse response) Add a response to the collector.
void	applyFilter() Filter responses based on installed filter.
ContextHandler[]	getResponseContexts() Get an array of all response Contexts in the collector.
void	installFilter(AccessResponseFilter filter) Sets the response filter to be used with this collector.
static ContextElement	makeContextElement() Construct a ContextElement containing a AccessResponseCollector, and the appropriate name and namespace

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_ATTR_NAMESPACE

public static final java.lang.String CONTEXT_ATTR_NAMESPACE

The reserved namespace used when storing a AccessResponseCollector inside of a request context.

CONTEXT_ATTR_UNQUALIFIED_NAME

public static final java.lang.String CONTEXT_ATTR_UNQUALIFIED_NAME

The unqualified element name used when storing a AccessResponseCollector inside of a request context.

CONTEXT_ATTR_NAME

public static final java.lang.String CONTEXT_ATTR_NAME

The element name used when storing a AccessResponseCollector inside of a request context.

Constructor Detail

AccessResponseCollector

public AccessResponseCollector()

Construct a new AccessResponseCollector.

Method Detail

makeContextElement

public static ContextElement makeContextElement()

Construct a ContextElement containing a AccessResponseCollector, and the appropriate name and namespace

Returns:

A ContextElement with name and namespace filled in.

appendAccessResponse

public void appendAccessResponse(AccessResponse response)

Add a response to the collector. This method is called by authorization providers which have extended data to return.

Parameters:

response - An AccessResponse object to be added to the collector.

installFilter

public void installFilter(AccessResponseFilter filter)

Sets the response filter to be used with this collector. This method may be called by the adjudicator to specify a filter.

Parameters:

filter - The filter to be used, null indicates that no filtering will be performed

applyFilter

public void applyFilter()

Filter responses based on installed filter. This method is called by the authorization service once the adjudicator has provided the final authorization result.

getResponseContexts

public ContextHandler[] getResponseContexts()

Get an array of all response Contexts in the collector. null is returned if the filter has not been applied.

Returns:

An array of ContextHandler objects held within the collector.