- java.lang.Object
-
- javax.xml.crypto.KeySelector
-
public abstract class KeySelector extends Object
A selector that finds and returns a key using the data contained in aKeyInfo
object. An example of an implementation of this class is one that searchs aKeyStore
for trusted keys that match information contained in aKeyInfo
.Whether or not the returned key is trusted and the mechanisms used to determine that is implementation-specific.
- Since:
- 1.6
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
KeySelector.Purpose
The purpose of the key that is to be selected.
-
Constructor Summary
Constructors Modifier Constructor and Description protected
KeySelector()
Default no-args constructor; intended for invocation by subclasses only.
-
Method Summary
Methods Modifier and Type Method and Description abstract KeySelectorResult
select(KeyInfo keyInfo, KeySelector.Purpose purpose, AlgorithmMethod method, XMLCryptoContext context)
Attempts to find a key that satisfies the specified constraints.static KeySelector
singletonKeySelector(Key key)
Returns aKeySelector
that always selects the specified key, regardless of theKeyInfo
passed to it.
-
-
-
Constructor Detail
-
KeySelector
protected KeySelector()
Default no-args constructor; intended for invocation by subclasses only.
-
-
Method Detail
-
select
public abstract KeySelectorResult select(KeyInfo keyInfo, KeySelector.Purpose purpose, AlgorithmMethod method, XMLCryptoContext context) throws KeySelectorException
Attempts to find a key that satisfies the specified constraints.- Parameters:
keyInfo
- aKeyInfo
(may benull
)purpose
- the key's purpose (KeySelector.Purpose.SIGN
,KeySelector.Purpose.VERIFY
,KeySelector.Purpose.ENCRYPT
, orKeySelector.Purpose.DECRYPT
)method
- the algorithm method that this key is to be used for. Only keys that are compatible with the algorithm and meet the constraints of the specified algorithm should be returned.context
- anXMLCryptoContext
that may contain useful information for finding an appropriate key. If this key selector supports resolvingRetrievalMethod
types, the context'sbaseURI
anddereferencer
parameters (if specified) should be used by the selector to resolve and dereference the URI.- Returns:
- the result of the key selector
- Throws:
KeySelectorException
- if an exceptional condition occurs while attempting to find a key. Note that an inability to find a key is not considered an exception (null
should be returned in that case). However, an error condition (ex: network communications failure) that prevented theKeySelector
from finding a potential key should be considered an exception.ClassCastException
- if the data type ofmethod
is not supported by this key selector
-
singletonKeySelector
public static KeySelector singletonKeySelector(Key key)
Returns aKeySelector
that always selects the specified key, regardless of theKeyInfo
passed to it.- Parameters:
key
- the sole key to be stored in the key selector- Returns:
- a key selector that always selects the specified key
- Throws:
NullPointerException
- ifkey
isnull
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
19/12/2024 11:53:42 Cette version de la page est en cache (à la date du 19/12/2024 11:53:42) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/crypto/KeySelector.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.