Class ResourceResolverSpi
java.lang.Object
org.apache.xml.security.utils.resolver.ResourceResolverSpi
- Direct Known Subclasses:
ResolverAnonymous
,ResolverDirectHTTP
,ResolverFragment
,ResolverLocalFilesystem
,ResolverXPointer
During reference validation, we have to retrieve resources from somewhere.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
engineAddProperies
(Map<String, String> newProperties) abstract boolean
This method helps theResourceResolver
to decide whether aResourceResolverSpi
is able to perform the requested action.engineGetProperty
(String key) Method engineGetPropertyString[]
Method engineGetPropertyKeysboolean
Tells if the implementation does can be reused by several threads safely.abstract XMLSignatureInput
engineResolveURI
(ResourceResolverContext context) This is the workhorse method used to resolve resources.void
engineSetProperty
(String key, String value) Method engineSetPropertystatic String
Fixes a platform dependent filename to standard URI form.boolean
understandsProperty
(String propertyToTest) Method understandsProperty
-
Field Details
-
properties
Field properties
-
-
Constructor Details
-
ResourceResolverSpi
public ResourceResolverSpi()
-
-
Method Details
-
engineResolveURI
public abstract 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
Method engineSetProperty- Parameters:
key
-value
-
-
engineGetProperty
Method engineGetProperty- Parameters:
key
-- Returns:
- the value of the property
-
engineAddProperies
- 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 and engineResolve invocations. Or it maintains all member info in ThreadLocal methods. -
engineCanResolveURI
This method helps theResourceResolver
to decide whether aResourceResolverSpi
is able to perform the requested action.- Parameters:
context
- Context in which to do resolution.- Returns:
- true if the engine can resolve the uri
-
engineGetPropertyKeys
Method engineGetPropertyKeys- Returns:
- the property keys
-
understandsProperty
Method understandsProperty- Parameters:
propertyToTest
-- Returns:
- true if understands the property
-
fixURI
Fixes a platform dependent filename to standard URI form.- Parameters:
str
- The string to fix.- Returns:
- Returns the fixed URI string.
-