org.apache.xml.security.utils.resolver

Class ResourceResolver

java.lang.Object

org.apache.xml.security.utils.resolver.ResourceResolver

public class ResourceResolver
extends java.lang.Object

During reference validation, we have to retrieve resources from somewhere. This is done by retrieving a Resolver. The resolver needs two arguments: The URI in which the link to the new resource is defined and the BaseURI of the file/entity in which the URI occurs (the BaseURI is the same as the SystemId.

• Verschiedene Implementierungen k??nnen sich als Resolver registrieren.
• Standardm????ig werden erste Implementierungen auf dem XML config file registrirt.
• Der Benutzer kann bei Bedarf Implementierungen voranstellen oder anf??gen.
• Implementierungen k??nnen mittels Features customized werden ?? (z.B. um Proxy-Passworter ??bergeben zu k??nnen).
• Jede Implementierung bekommt das URI Attribut und den Base URI ??bergeben und muss antworten, ob sie aufl??sen kann.
• Die erste Implementierung, die die Aufgabe erf??llt, f??hrt die Aufl??sung durch.

Author:

$Author: coheigea $

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceResolverSpi	_resolverSpi Field transformSpi

Constructor Summary

Constructors

Constructor and Description
ResourceResolver(ResourceResolverSpi resourceResolver) Constructor ResourceResolver

Method Summary

Methods

Modifier and Type	Method and Description
void	addProperties(java.util.Map properties) Method addProperties
static ResourceResolver	getInstance(org.w3c.dom.Attr uri, java.lang.String BaseURI) Method getInstance
static ResourceResolver	getInstance(org.w3c.dom.Attr uri, java.lang.String BaseURI, java.util.List individualResolvers) Method getInstance
java.lang.String	getProperty(java.lang.String key) Method getProperty
java.lang.String[]	getPropertyKeys() Method getPropertyKeys
static void	init() The init() function is called by org.apache.xml.security.Init.init()
static void	register(java.lang.String className) Registers a ResourceResolverSpi class.
static void	registerAtStart(java.lang.String className) Registers a ResourceResolverSpi class at the beginning of the provider list.
XMLSignatureInput	resolve(org.w3c.dom.Attr uri, java.lang.String BaseURI) Method resolve
static XMLSignatureInput	resolveStatic(org.w3c.dom.Attr uri, java.lang.String BaseURI) Method resolve
void	setProperty(java.lang.String key, java.lang.String value) Method setProperty
boolean	understandsProperty(java.lang.String propertyToTest) Method understandsProperty

Methods inherited from class java.lang.Object

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

Field Detail

_resolverSpi

protected ResourceResolverSpi _resolverSpi

Field transformSpi

Constructor Detail

ResourceResolver

public ResourceResolver(ResourceResolverSpi resourceResolver)

Constructor ResourceResolver

Parameters:

resourceResolver -

Method Detail

getInstance

public static final ResourceResolver getInstance(org.w3c.dom.Attr uri,
                           java.lang.String BaseURI)
                                          throws ResourceResolverException

Method getInstance

Parameters:

uri -

BaseURI -

Returns:

the instnace

Throws:

ResourceResolverException

getInstance

public static final ResourceResolver getInstance(org.w3c.dom.Attr uri,
                           java.lang.String BaseURI,
                           java.util.List individualResolvers)
                                          throws ResourceResolverException

Method getInstance

Parameters:

uri -

BaseURI -

individualResolvers -

Returns:

the instance

Throws:

ResourceResolverException

init

public static void init()

The init() function is called by org.apache.xml.security.Init.init()

register

public static void register(java.lang.String className)

Registers a ResourceResolverSpi class. This method logs a warning if the class cannot be registered.

Parameters:

className - the name of the ResourceResolverSpi class to be registered

registerAtStart

public static void registerAtStart(java.lang.String className)

Registers a ResourceResolverSpi class at the beginning of the provider list. This method logs a warning if the class cannot be registered.

Parameters:

className - the name of the ResourceResolverSpi class to be registered

resolveStatic

public static XMLSignatureInput resolveStatic(org.w3c.dom.Attr uri,
                              java.lang.String BaseURI)
                                       throws ResourceResolverException

Method resolve

Parameters:

uri -

BaseURI -

Returns:

the resource

Throws:

ResourceResolverException

resolve

public XMLSignatureInput resolve(org.w3c.dom.Attr uri,
                        java.lang.String BaseURI)
                          throws ResourceResolverException

Method resolve

Parameters:

uri -

BaseURI -

Returns:

the resource

Throws:

ResourceResolverException

setProperty

public void setProperty(java.lang.String key,
               java.lang.String value)

Method setProperty

Parameters:

key -

value -

getProperty

public java.lang.String getProperty(java.lang.String key)

Method getProperty

Parameters:

key -

Returns:

the value of the property

addProperties

public void addProperties(java.util.Map properties)

Method addProperties

Parameters:

properties -

getPropertyKeys

public java.lang.String[] getPropertyKeys()

Method getPropertyKeys

Returns:

all property keys.

understandsProperty

public boolean understandsProperty(java.lang.String propertyToTest)

Method understandsProperty

Parameters:

propertyToTest -

Returns:

true if the resolver understands the property