Oracle Entitlements Server for Java API Reference: Class ResponseContextCollector

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Oracle Entitlements Server for Java API Reference

com.bea.security
Class ResponseContextCollector

java.lang.Object
  |
  +--com.bea.security.ResponseContextCollector

Direct Known Subclasses:: SimpleResponseContextCollector

public abstract class ResponseContextCollector
extends java.lang.Object

The ResponseContextCollector abstract base class is a simple interface for collecting a set of response contexts. This may be used to collect extended decision data from the authorization system. Extended authorization data may be appended to the collector by the configured authorization providers. To request extended decision data from the authorization system, you must include a ResponseContextCollector within the request context supplied to the AuthorizationService.isAccessAllowed call. The element must be specified with the name in ResponseContextCollector.CONTEXT_ATTR_NAME, and a value that is an implementation of this class.

NOTE: The SimpleResponseContextCollector class provides concrete a concrete implementation of a ResponseContextCollector abstract base class.

Author:: Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

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

Constructor Summary
`ResponseContextCollector()`

Method Summary
`abstract void`	`appendContext(AppContext context)` Add a response context to the collector.
`abstract AppContext[]`	`getContexts()` Gets an array containing all response `AppContext` which have been appended into the collector.

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 ResponseContextCollector 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 ResponseContextCollector inside of a request context.

CONTEXT_ATTR_NAME

public static final java.lang.String CONTEXT_ATTR_NAME

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

Constructor Detail

ResponseContextCollector

public ResponseContextCollector()

Method Detail

appendContext

public abstract void appendContext(AppContext context)

Add a response context to the collector. The authorization service will call this method to append contexts into the collector.

Parameters:: context - An AppContext object to be added to the collector.

getContexts

public abstract AppContext[] getContexts()

Gets an array containing all response AppContext which have been appended into the collector.

Returns:: Returns an array of AppContext objects held within the collector.