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.

Constructor Summary

Constructors

Constructor and Description
KeyResolver()

Method Summary

Modifier and Type	Method and Description
static PublicKey	getPublicKey(Element element, String baseURI, StorageResolver storage, boolean secureValidation) Method getPublicKey
static X509Certificate	getX509Certificate(Element element, String baseURI, StorageResolver storage, boolean secureValidation) Method getX509Certificate
static Iterator<KeyResolverSpi>	iterator()
static int	length() Method length
static void	register(KeyResolverSpi keyResolverSpi, boolean start) This method is used for registering KeyResolverSpis which are available to all KeyInfo objects.
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.
static void	registerClassNames(List<String> classNames) This method is used for registering KeyResolverSpis which are available to all KeyInfo objects.
static void	registerDefaultResolvers() This method registers the default resolvers.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyResolver

public KeyResolver()

Method Detail

length

public static int length()

Method length

Returns:

the length of resolvers registered

getX509Certificate

public static final X509Certificate getX509Certificate(Element element,
                                                       String baseURI,
                                                       StorageResolver storage,
                                                       boolean secureValidation)
                                                throws KeyResolverException

Method getX509Certificate

Parameters:

element -

baseURI -

storage -

secureValidation -

Returns:

The certificate represented by the element.

Throws:

KeyResolverException

getPublicKey

public static final PublicKey getPublicKey(Element element,
                                           String baseURI,
                                           StorageResolver storage,
                                           boolean secureValidation)
                                    throws KeyResolverException

Method getPublicKey

Parameters:

element -

baseURI -

storage -

secureValidation -

Returns:

the public key contained in the element

Throws:

KeyResolverException

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). Please note that this method will create a new copy of the underlying array, as the underlying collection is a CopyOnWriteArrayList.

Parameters:

className -

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

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

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). Please note that this method will create a new copy of the underlying array, as the underlying collection is a CopyOnWriteArrayList.

Parameters:

className -

Throws:

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

register

public static void register(KeyResolverSpi keyResolverSpi,
                            boolean start)

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). Please note that this method will create a new copy of the underlying array, as the underlying collection is a CopyOnWriteArrayList.

Parameters:

keyResolverSpi - a KeyResolverSpi instance to register

start - whether to register the KeyResolverSpi at the start of the list or not

Throws:

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

registerClassNames

public static void registerClassNames(List<String> classNames)
                               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). The KeyResolverSpi instances are not registered as a global resolver.

Parameters:

classNames -

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

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

registerDefaultResolvers

public static void registerDefaultResolvers()

This method registers the default resolvers.

iterator

public static Iterator<KeyResolverSpi> iterator()