Package org.apache.xml.security.keys.keyresolver

Class KeyResolver

java.lang.Object

org.apache.xml.security.keys.keyresolver.KeyResolver

public class KeyResolver
extends Object

KeyResolver is factory class for subclass of KeyResolverSpi that represent child element of KeyInfo.

Version:

%I%, %G%

Author:

$Author$

Field Summary

Fields

Modifier and Type	Field	Description
protected KeyResolverSpi	_resolverSpi	Field _resolverSpi
protected StorageResolver	_storage	Field _storage

Method Summary

Modifier and Type	Method	Description
boolean	canResolve(Element element, String BaseURI, StorageResolver storage)	Method canResolve
static final KeyResolver	getInstance(Element element, String BaseURI, StorageResolver storage)	Method getInstance
String	getProperty(String key)	Method getProperty
String[]	getPropertyKeys()	Method getPropertyKeys
static void	init()	The init() function is called by org.apache.xml.security.Init.init()
static KeyResolver	item(int i)	Method item
static int	length()	Method length
static void	register(String className)	This method is used for registering KeyResolverSpis which are available to all KeyInfo objects.
static void	registerAtStart(String className)	This method is used for registering KeyResolverSpis which are available to all KeyInfo objects.
PublicKey	resolvePublicKey(Element element, String BaseURI, StorageResolver storage)	Method resolve
String	resolverClassName()	Method resolverClassName
SecretKey	resolveSecretKey(Element element, String BaseURI, StorageResolver storage)
static PublicKey	resolveStatic(Element element, String BaseURI, StorageResolver storage)	Method resolveStatic
X509Certificate	resolveX509Certificate(Element element, String BaseURI, StorageResolver storage)	Method resolveX509Certificate
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

Field Details

_resolverSpi

protected KeyResolverSpi _resolverSpi

Field _resolverSpi

_storage

protected StorageResolver _storage

Field _storage

Method Details

length

public static int length()

Method length

Returns:

the length of resolvers registed

item

public static KeyResolver item(int i)
                        throws KeyResolverException

Method item

Parameters:

i -

Returns:

the number i resolver registerd

Throws:

KeyResolverException

getInstance

public static final KeyResolver getInstance(Element element,
 String BaseURI,
 StorageResolver storage)
                                     throws KeyResolverException

Method getInstance

Parameters:

element -

BaseURI -

storage -

Returns:

the instance that happends to implement the thing.

Throws:

KeyResolverException

init

public static void init()

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

register

public static void register(String className)
                     throws ClassNotFoundException,
IllegalAccessException,
InstantiationException

This method is used for registering KeyResolverSpis which are available to all KeyInfo objects. This means that personalized KeyResolverSpis should only be registered directly to the KeyInfo using KeyInfo.registerInternalKeyResolver(org.apache.xml.security.keys.keyresolver.KeyResolverSpi).

Parameters:

className -

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

registerAtStart

public static void registerAtStart(String className)

This method is used for registering KeyResolverSpis which are available to all KeyInfo objects. This means that personalized KeyResolverSpis should only be registered directly to the KeyInfo using KeyInfo.registerInternalKeyResolver(org.apache.xml.security.keys.keyresolver.KeyResolverSpi).

Parameters:

className -

resolveStatic

public static PublicKey resolveStatic(Element element,
 String BaseURI,
 StorageResolver storage)
                               throws KeyResolverException

Method resolveStatic

Parameters:

element -

BaseURI -

storage -

Returns:

resolve from the static register an element

Throws:

KeyResolverException

resolvePublicKey

public PublicKey resolvePublicKey(Element element,
 String BaseURI,
 StorageResolver storage)
                           throws KeyResolverException

Method resolve

Parameters:

element -

BaseURI -

storage -

Returns:

resolved public key from the registered from the elements

Throws:

KeyResolverException

resolveX509Certificate

public X509Certificate resolveX509Certificate(Element element,
 String BaseURI,
 StorageResolver storage)
                                       throws KeyResolverException

Method resolveX509Certificate

Parameters:

element -

BaseURI -

storage -

Returns:

resolved X509certificate key from the registered from the elements

Throws:

KeyResolverException

resolveSecretKey

public SecretKey resolveSecretKey(Element element,
 String BaseURI,
 StorageResolver storage)
                           throws KeyResolverException

Parameters:

element -

BaseURI -

storage -

Returns:

resolved SecretKey key from the registered from the elements

Throws:

KeyResolverException

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 property setted for this resolver

getPropertyKeys

public String[] getPropertyKeys()

Method getPropertyKeys

Returns:

the properties key registerd in this resolver

understandsProperty

public boolean understandsProperty(String propertyToTest)

Method understandsProperty

Parameters:

propertyToTest -

Returns:

true if the resolver understands property propertyToTest

canResolve

public boolean canResolve(Element element,
 String BaseURI,
 StorageResolver storage)

Method canResolve

Parameters:

element -

BaseURI -

storage -

Returns:

true if can resolve the key in the element

resolverClassName

public String resolverClassName()

Method resolverClassName

Returns:

the name of the resolver.