javax.xml.crypto

Class KeySelector

Contents

  • public abstract class KeySelector
extends Object
    A selector that finds and returns a key using the data contained in a KeyInfo object. An example of an implementation of this class is one that searchs a KeyStore for trusted keys that match information contained in a KeyInfo.

    Whether or not the returned key is trusted and the mechanisms used to determine that is implementation-specific.

    Since:
    1.6

    • 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 - a KeyInfo (may be null)
        purpose - the key's purpose (KeySelector.Purpose.SIGN, KeySelector.Purpose.VERIFY, KeySelector.Purpose.ENCRYPT, or KeySelector.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 - an XMLCryptoContext that may contain useful information for finding an appropriate key. If this key selector supports resolving RetrievalMethod types, the context's baseURI and dereferencer 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 the KeySelector from finding a potential key should be considered an exception.
        ClassCastException - if the data type of method is not supported by this key selector

      • singletonKeySelector

        public static KeySelector singletonKeySelector(Key key)
        Returns a KeySelector that always selects the specified key, regardless of the KeyInfo 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 - if key is null

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/crypto/KeySelector.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut