Package org.apache.xml.security.utils.resolver

Class ResourceResolver

java.lang.Object

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

public class ResourceResolver
extends 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).

Constructor Summary

Constructors

Constructor	Description
ResourceResolver(ResourceResolverSpi resourceResolver)	Constructor ResourceResolver

Method Summary

Modifier and Type	Method	Description
void	addProperties(Map<String,String> properties)	Method addProperties
static ResourceResolver	getInstance(Attr uriAttr, String baseURI, boolean secureValidation)	Method getInstance
static ResourceResolver	getInstance(Attr uri, String baseURI, List<ResourceResolver> individualResolvers)	Method getInstance
static ResourceResolver	getInstance(Attr uri, String baseURI, List<ResourceResolver> individualResolvers, boolean secureValidation)	Method getInstance
String	getProperty(String key)	Method getProperty
String[]	getPropertyKeys()	Method getPropertyKeys
static void	register(Class<? extends ResourceResolverSpi> className, boolean start)	Registers a ResourceResolverSpi class.
static void	register(String className)	Registers a ResourceResolverSpi class.
static void	register(ResourceResolverSpi resourceResolverSpi, boolean start)	Registers a ResourceResolverSpi instance.
static void	registerAtStart(String className)	Registers a ResourceResolverSpi class at the beginning of the provider list.
static void	registerDefaultResolvers()	This method registers the default resolvers.
XMLSignatureInput	resolve(Attr uri, String baseURI, boolean secureValidation)	Method resolve
void	setProperty(String key, String value)	Method setProperty
boolean	understandsProperty(String propertyToTest)	Method understandsProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceResolver

public ResourceResolver(ResourceResolverSpi resourceResolver)

Constructor ResourceResolver

Parameters:

resourceResolver -

Method Detail

getInstance

public static final ResourceResolver getInstance(Attr uriAttr,
                                                 String baseURI,
                                                 boolean secureValidation)
                                          throws ResourceResolverException

Method getInstance

Parameters:

uriAttr -

baseURI -

secureValidation -

Returns:

the instance

Throws:

ResourceResolverException

getInstance

public static ResourceResolver getInstance(Attr uri,
                                           String baseURI,
                                           List<ResourceResolver> individualResolvers)
                                    throws ResourceResolverException

Method getInstance

Parameters:

uri -

baseURI -

individualResolvers -

Returns:

the instance

Throws:

ResourceResolverException

getInstance

public static ResourceResolver getInstance(Attr uri,
                                           String baseURI,
                                           List<ResourceResolver> individualResolvers,
                                           boolean secureValidation)
                                    throws ResourceResolverException

Method getInstance

Parameters:

uri -

baseURI -

individualResolvers -

secureValidation -

Returns:

the instance

Throws:

ResourceResolverException

register

public static void register(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

Throws:

SecurityException - if a security manager is installed and the caller does not have permission to register a resource resolver

registerAtStart

public static void registerAtStart(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

Throws:

SecurityException - if a security manager is installed and the caller does not have permission to register a resource resolver

register

public static void register(Class<? extends ResourceResolverSpi> className,
                            boolean start)

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

Parameters:

className -

start -

Throws:

SecurityException - if a security manager is installed and the caller does not have permission to register a resource resolver

register

public static void register(ResourceResolverSpi resourceResolverSpi,
                            boolean start)

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

Parameters:

resourceResolverSpi -

start -

Throws:

SecurityException - if a security manager is installed and the caller does not have permission to register a resource resolver

registerDefaultResolvers

public static void registerDefaultResolvers()

This method registers the default resolvers.

resolve

public XMLSignatureInput resolve(Attr uri,
                                 String baseURI,
                                 boolean secureValidation)
                          throws ResourceResolverException

Method resolve

Parameters:

uri -

baseURI -

Returns:

the resource

Throws:

ResourceResolverException

setProperty

public void setProperty(String key,
                        String value)

Method setProperty

Parameters:

key -

value -

getProperty

public String getProperty(String key)

Method getProperty

Parameters:

key -

Returns:

the value of the property

addProperties

public void addProperties(Map<String,String> properties)

Method addProperties

Parameters:

properties -

getPropertyKeys

public String[] getPropertyKeys()

Method getPropertyKeys

Returns:

all property keys.

understandsProperty

public boolean understandsProperty(String propertyToTest)

Method understandsProperty

Parameters:

propertyToTest -

Returns:

true if the resolver understands the property