Package org.forgerock.openig.resolver

Class HeadersResolver

java.lang.Object

org.forgerock.openig.resolver.HeadersResolver

All Implemented Interfaces:

Resolver, Indexed<Class>

public class HeadersResolver
extends Object
implements Resolver

Resolves Headers objects.

Field Summary

Fields inherited from interface org.forgerock.openig.resolver.Resolver

UNRESOLVED

Constructor Summary

Constructors

Constructor	Description
HeadersResolver()

Method Summary

Modifier and Type	Method	Description
Object	get(Object object, Object element)	Attempts to resolve an element of an object.
Class<?>	getKey()	Returns the type of object that the resolver supports.
Object	put(Object object, Object element, Object value)	Attempts to set the value of an element of an object.

Methods inherited from class java.lang.Object

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

Constructor Details

HeadersResolver

public HeadersResolver()

Method Details

getKey

public Class<?> getKey()

Description copied from interface: Resolver

Returns the type of object that the resolver supports. This does not necessarily guarantee that the resolver will provide resolution; rather this is how a resolver specifies what type of object it may resolve. Resolvers for more specific classes and interfaces are called earlier than those of more general classes and interfaces.

Specified by:

getKey in interface Indexed<Class>

Specified by:

getKey in interface Resolver

Returns:

the type of object that the resolver supports.

get

public Object get(Object object,
 Object element)

Description copied from interface: Resolver

Attempts to resolve an element of an object. The object argument references an object for which a named or indexed element is being requested. The element argument specifies the element that is being requested from the referenced object.

The element argument can be either a String or an Integer object. A string represents a named element of an associative array; an integer represents the index of an ordered array.

If the resolver cannot resolve the requested element, then Resolver.UNRESOLVED should be returned. This allows other resovlers of more generic classes or interfaces to potentially resolve the requested element.

Specified by:

get in interface Resolver

Parameters:

object - the object in which to resolve the specified element.

element - the element to resolve within the specified object.

Returns:

the value of the resolved element, or Resolver.UNRESOLVED if it cannot be resolved.

put

public Object put(Object object,
 Object element,
 Object value)

Description copied from interface: Resolver

Attempts to set the value of an element of an object. The object argument references an object for which a named or indexed element is to be set. The element argument specifies which element value is to be set. The value argument specifies the value to be set.

The element argument can be either a String or an Integer object. A string represents a named element of an associative array; an integer represents the index of an ordered array.

If the resolver cannot resolve the requested element or set its value, then Resolver.UNRESOLVED should be returned. This allows other resovlers of more generic classes or interfaces to potentially resolve the requested element.

Specified by:

put in interface Resolver

Parameters:

object - the object in which to resolve the specified element.

element - the element within the specified object whose value is to be set.

value - the value to set the element to.

Returns:

the previous value of the element, null if no previous value, or Resolver.UNRESOLVED if it cannot be resolved.