org.apache.xml.security.utils.resolver

Class ResourceResolverSpi

java.lang.Object

org.apache.xml.security.utils.resolver.ResourceResolverSpi

Direct Known Subclasses:

ResolverAnonymous, ResolverDirectHTTP, ResolverFragment, ResolverLocalFilesystem, ResolverXPointer

public abstract class ResourceResolverSpi
extends Object

During reference validation, we have to retrieve resources from somewhere.

Author:

$Author$

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	properties Field properties
protected boolean	secureValidation Deprecated. Secure validation flag is now passed to methods.

Constructor Summary

Constructors

Constructor and Description
ResourceResolverSpi()

Method Summary

Modifier and Type	Method and Description
void	engineAddProperies(Map<String,String> newProperties)
boolean	engineCanResolve(Attr uri, String BaseURI) Deprecated. See engineCanResolveURI(ResourceResolverContext)
boolean	engineCanResolveURI(ResourceResolverContext context) This method helps the ResourceResolver to decide whether a ResourceResolverSpi is able to perform the requested action.
String	engineGetProperty(String key) Method engineGetProperty
String[]	engineGetPropertyKeys() Method engineGetPropertyKeys
boolean	engineIsThreadSafe() Tells if the implementation does can be reused by several threads safely.
XMLSignatureInput	engineResolve(Attr uri, String BaseURI) Deprecated. New clients should override engineResolveURI(ResourceResolverContext)
XMLSignatureInput	engineResolveURI(ResourceResolverContext context) This is the workhorse method used to resolve resources.
void	engineSetProperty(String key, String value) Method engineSetProperty
static String	fixURI(String str) Fixes a platform dependent filename to standard URI form.
boolean	understandsProperty(String propertyToTest) Method understandsProperty

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected Map<String,String> properties

Field properties

secureValidation

protected final boolean secureValidation

Deprecated. Secure validation flag is now passed to methods.

Deprecated - used to carry state about whether resolution was being done in a secure fashion, but was not thread safe, so the resolution information is now passed as parameters to methods.

See Also:

Constant Field Values

Constructor Detail

ResourceResolverSpi

public ResourceResolverSpi()

Method Detail

engineResolve

public XMLSignatureInput engineResolve(Attr uri,
                                       String BaseURI)
                                throws ResourceResolverException

Deprecated. New clients should override engineResolveURI(ResourceResolverContext)

This is the workhorse method used to resolve resources.

Parameters:

uri -

BaseURI -

Returns:

the resource wrapped around a XMLSignatureInput

Throws:

ResourceResolverException

engineResolveURI

public XMLSignatureInput engineResolveURI(ResourceResolverContext context)
                                   throws ResourceResolverException

This is the workhorse method used to resolve resources.

Parameters:

context - Context to use to resolve resources.

Returns:

the resource wrapped around a XMLSignatureInput

Throws:

ResourceResolverException

engineSetProperty

public void engineSetProperty(String key,
                              String value)

Method engineSetProperty

Parameters:

key -

value -

engineGetProperty

public String engineGetProperty(String key)

Method engineGetProperty

Parameters:

key -

Returns:

the value of the property

engineAddProperies

public void engineAddProperies(Map<String,String> newProperties)

Parameters:

newProperties -

engineIsThreadSafe

public boolean engineIsThreadSafe()

Tells if the implementation does can be reused by several threads safely. It normally means that the implementation does not have any member, or there is member change between engineCanResolve & engineResolve invocations. Or it maintains all member info in ThreadLocal methods.

engineCanResolve

public boolean engineCanResolve(Attr uri,
                                String BaseURI)

Deprecated. See engineCanResolveURI(ResourceResolverContext)

This method helps the ResourceResolver to decide whether a ResourceResolverSpi is able to perform the requested action.

Parameters:

uri -

BaseURI -

Returns:

true if the engine can resolve the uri

engineCanResolveURI

public boolean engineCanResolveURI(ResourceResolverContext context)

This method helps the ResourceResolver to decide whether a ResourceResolverSpi is able to perform the requested action.

New clients should override this method, and not override engineCanResolve(Attr, String)

Parameters:

context - Context in which to do resolution.

Returns:

true if the engine can resolve the uri

engineGetPropertyKeys

public String[] engineGetPropertyKeys()

Method engineGetPropertyKeys

Returns:

the property keys

understandsProperty

public boolean understandsProperty(String propertyToTest)

Method understandsProperty

Parameters:

propertyToTest -

Returns:

true if understands the property

fixURI

public static String fixURI(String str)

Fixes a platform dependent filename to standard URI form.

Parameters:

str - The string to fix.

Returns:

Returns the fixed URI string.