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

java.lang.Object
  |
  +--org.apache.xml.security.utils.resolver.ResourceResolverSpi

public abstract class ResourceResolverSpi
extends java.lang.Object

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

Author:
$Author: vdkoogh $

Field Summary
protected  java.util.Map _properties
          Field _properties
 
Constructor Summary
ResourceResolverSpi()
           
 
Method Summary
 void engineAddProperies(java.util.Map properties)
           
abstract  boolean engineCanResolve(org.w3c.dom.Attr uri, java.lang.String BaseURI)
          This method helps the ResourceResolver to decide whether a ResourceResolverSpi is able to perform the requested action.
 java.lang.String engineGetProperty(java.lang.String key)
          Method engineGetProperty
 java.lang.String[] engineGetPropertyKeys()
          Method engineGetPropertyKeys
abstract  XMLSignatureInput engineResolve(org.w3c.dom.Attr uri, java.lang.String BaseURI)
          This is the workhorse method used to resolve resources.
 void engineSetProperty(java.lang.String key, java.lang.String value)
          Method engineSetProperty
static java.lang.String expandSystemId(java.lang.String systemId, java.lang.String currentSystemId)
          Expands a system id and returns the system id as a URL, if it can be expanded.
static java.lang.String fixURI(java.lang.String str)
          Fixes a platform dependent filename to standard URI form.
static java.lang.String makeFilesystemToURI(java.lang.String str)
          Method makeFilesystemToURI
 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

_properties

protected java.util.Map _properties
Field _properties

Constructor Detail

ResourceResolverSpi

public ResourceResolverSpi()
Method Detail

engineResolve

public abstract XMLSignatureInput engineResolve(org.w3c.dom.Attr uri,
                                                java.lang.String BaseURI)
                                         throws ResourceResolverException
This is the workhorse method used to resolve resources.

Parameters:
uri -
BaseURI -
Throws:
ResourceResolverException

engineSetProperty

public void engineSetProperty(java.lang.String key,
                              java.lang.String value)
Method engineSetProperty

Parameters:
key -
value -

engineGetProperty

public java.lang.String engineGetProperty(java.lang.String key)
Method engineGetProperty

Parameters:
key -

engineAddProperies

public void engineAddProperies(java.util.Map properties)

engineCanResolve

public abstract boolean engineCanResolve(org.w3c.dom.Attr uri,
                                         java.lang.String BaseURI)
This method helps the ResourceResolver to decide whether a ResourceResolverSpi is able to perform the requested action.

Parameters:
uri -
BaseURI -

engineGetPropertyKeys

public java.lang.String[] engineGetPropertyKeys()
Method engineGetPropertyKeys


understandsProperty

public boolean understandsProperty(java.lang.String propertyToTest)
Method understandsProperty

Parameters:
propertyToTest -

expandSystemId

public static java.lang.String expandSystemId(java.lang.String systemId,
                                              java.lang.String currentSystemId)
                                       throws java.lang.Exception
Expands a system id and returns the system id as a URL, if it can be expanded. A return value of null means that the identifier is already expanded. An exception thrown indicates a failure to expand the id.

Parameters:
systemId - The systemId to be expanded.
currentSystemId -
Returns:
Returns the URL object representing the expanded system identifier. A null value indicates that the given system identifier is already expanded.
Throws:
java.lang.Exception

makeFilesystemToURI

public static java.lang.String makeFilesystemToURI(java.lang.String str)
Method makeFilesystemToURI

Parameters:
str -

fixURI

public static java.lang.String fixURI(java.lang.String str)
Fixes a platform dependent filename to standard URI form.

Parameters:
str - The string to fix.
Returns:
Returns the fixed URI string.