XML Security API - KeyResolver

Overview

Package

Class

Tree

Deprecated

Index

Help

Home

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  org.apache.xml.security.keys.keyresolver.KeyResolver

public class KeyResolver
extends java.lang.Object

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

Version:: %I%, %G%
Author:: $Author: blautenb $

Field Summary
`protected KeyResolverSpi`	`_resolverSpi` Field _resolverSpi
`protected StorageResolver`	`_storage` Field _storage

Method Summary
`boolean`	`canResolve(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)` Method canResolve
`static KeyResolver`	`getInstance(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)` Method getInstance
`java.lang.String`	`getProperty(java.lang.String key)` Method getProperty
`java.lang.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(java.lang.String className)` This method is used for registering `KeyResolverSpi`s which are available to all `KeyInfo` objects.
`static void`	`registerAtStart(java.lang.String className)` This method is used for registering `KeyResolverSpi`s which are available to all `KeyInfo` objects.
`java.security.PublicKey`	`resolvePublicKey(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)` Method resolve
`java.lang.String`	`resolverClassName()` Method resolverClassName
`javax.crypto.SecretKey`	`resolveSecretKey(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)`
`static java.security.PublicKey`	`resolveStatic(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)` Method resolveStatic
`java.security.cert.X509Certificate`	`resolveX509Certificate(org.w3c.dom.Element element, java.lang.String BaseURI, StorageResolver storage)` Method resolveX509Certificate
`void`	`setProperty(java.lang.String key, java.lang.String value)` Method setProperty
`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

_resolverSpi

protected KeyResolverSpi _resolverSpi

Field _resolverSpi

_storage

protected StorageResolver _storage

Field _storage

Method Detail

length

public static int length()

Method length

item

public static KeyResolver item(int i)
                        throws KeyResolverException

Method item

Parameters:: i -
Throws:: KeyResolverException

getInstance

public static final KeyResolver getInstance(org.w3c.dom.Element element,
                                            java.lang.String BaseURI,
                                            StorageResolver storage)
                                     throws KeyResolverException

Method getInstance

Parameters:: element -; BaseURI -; storage -
Throws:: KeyResolverException

init

public static void init()

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

register

public static void register(java.lang.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.

Parameters:: className -

registerAtStart

public static void registerAtStart(java.lang.String className)

Parameters:: className -

resolveStatic

public static java.security.PublicKey resolveStatic(org.w3c.dom.Element element,
                                                    java.lang.String BaseURI,
                                                    StorageResolver storage)
                                             throws KeyResolverException

Method resolveStatic

Parameters:: element -; BaseURI -; storage -
Throws:: KeyResolverException

resolvePublicKey

public java.security.PublicKey resolvePublicKey(org.w3c.dom.Element element,
                                                java.lang.String BaseURI,
                                                StorageResolver storage)
                                         throws KeyResolverException

Method resolve

Parameters:: element -; BaseURI -; storage -
Throws:: KeyResolverException

resolveX509Certificate

public java.security.cert.X509Certificate resolveX509Certificate(org.w3c.dom.Element element,
                                                                 java.lang.String BaseURI,
                                                                 StorageResolver storage)
                                                          throws KeyResolverException

Method resolveX509Certificate

Parameters:: element -; BaseURI -; storage -
Throws:: KeyResolverException

resolveSecretKey

public javax.crypto.SecretKey resolveSecretKey(org.w3c.dom.Element element,
                                               java.lang.String BaseURI,
                                               StorageResolver storage)
                                        throws KeyResolverException

Throws:: KeyResolverException

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Method setProperty

Parameters:: key -; value -

getProperty

public java.lang.String getProperty(java.lang.String key)

Method getProperty

Parameters:: key -

getPropertyKeys

public java.lang.String[] getPropertyKeys()

Method getPropertyKeys

understandsProperty

public boolean understandsProperty(java.lang.String propertyToTest)

Method understandsProperty

Parameters:: propertyToTest -

canResolve

public boolean canResolve(org.w3c.dom.Element element,
                          java.lang.String BaseURI,
                          StorageResolver storage)

Method canResolve

Parameters:: element -; BaseURI -; storage -

resolverClassName

public java.lang.String resolverClassName()

Method resolverClassName