Package org.apache.xml.security.algorithms

Class JCEMapper

  • Direct Known Subclasses:
    JCEAlgorithmMapper
    public class JCEMapper
extends java.lang.Object
    This class maps algorithm identifier URIs to JAVA JCE class names.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JCEMapper.Algorithm
      Represents the Algorithm xml element

    • Constructor Summary

      Constructors 
      Constructor Description
      JCEMapper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static JCEMapper.Algorithm getAlgorithm​(java.lang.String algorithmURI)
      Method getAlgorithm
      static java.lang.String getAlgorithmClassFromURI​(java.lang.String algorithmURI)
      Method getAlgorithmClassFromURI
      static int getIVLengthFromURI​(java.lang.String algorithmURI)  
      static java.lang.String getJCEKeyAlgorithmFromURI​(java.lang.String algorithmURI)
      Method getJCEKeyAlgorithmFromURI
      static java.lang.String getJCEProviderFromURI​(java.lang.String algorithmURI)
      Method getJCEProviderFromURI
      static int getKeyLengthFromURI​(java.lang.String algorithmURI)
      Returns the keylength in bits for a particular algorithm.
      static java.lang.String getProviderId()
      Gets the default Provider for obtaining the security algorithms
      static void register​(java.lang.String id, JCEMapper.Algorithm algorithm)
      Method register
      static void registerDefaultAlgorithms()
      This method registers the default algorithms.
      static void setProviderId​(java.lang.String provider)
      Sets the default Provider for obtaining the security algorithms
      static java.lang.String translateURItoJCEID​(java.lang.String algorithmURI)
      Method translateURItoJCEID

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • LOG

        private static final org.slf4j.Logger LOG

      • algorithmsMap

        private static java.util.Map<java.lang.String,​JCEMapper.Algorithm> algorithmsMap

      • providerName

        private static java.lang.String providerName

    • Constructor Detail

      • JCEMapper

        public JCEMapper()

    • Method Detail

      • register

        public static void register​(java.lang.String id,
                            JCEMapper.Algorithm algorithm)
        Method register
        Parameters:
        id -
        algorithm -
        Throws:
        java.lang.SecurityException - if a security manager is installed and the caller does not have permission to register the JCE algorithm

      • registerDefaultAlgorithms

        public static void registerDefaultAlgorithms()
        This method registers the default algorithms.

      • translateURItoJCEID

        public static java.lang.String translateURItoJCEID​(java.lang.String algorithmURI)
        Method translateURItoJCEID
        Parameters:
        algorithmURI -
        Returns:
        the JCE standard name corresponding to the given URI

      • getAlgorithmClassFromURI

        public static java.lang.String getAlgorithmClassFromURI​(java.lang.String algorithmURI)
        Method getAlgorithmClassFromURI
        Parameters:
        algorithmURI -
        Returns:
        the class name that implements this algorithm

      • getKeyLengthFromURI

        public static int getKeyLengthFromURI​(java.lang.String algorithmURI)
        Returns the keylength in bits for a particular algorithm.
        Parameters:
        algorithmURI -
        Returns:
        The length of the key used in the algorithm

      • getIVLengthFromURI

        public static int getIVLengthFromURI​(java.lang.String algorithmURI)

      • getJCEKeyAlgorithmFromURI

        public static java.lang.String getJCEKeyAlgorithmFromURI​(java.lang.String algorithmURI)
        Method getJCEKeyAlgorithmFromURI
        Parameters:
        algorithmURI -
        Returns:
        The KeyAlgorithm for the given URI.

      • getJCEProviderFromURI

        public static java.lang.String getJCEProviderFromURI​(java.lang.String algorithmURI)
        Method getJCEProviderFromURI
        Parameters:
        algorithmURI -
        Returns:
        The JCEProvider for the given URI.

      • getAlgorithm

        private static JCEMapper.Algorithm getAlgorithm​(java.lang.String algorithmURI)
        Method getAlgorithm
        Parameters:
        algorithmURI -
        Returns:
        The Algorithm object for the given URI.

      • getProviderId

        public static java.lang.String getProviderId()
        Gets the default Provider for obtaining the security algorithms
        Returns:
        the default providerId.

      • setProviderId

        public static void setProviderId​(java.lang.String provider)
        Sets the default Provider for obtaining the security algorithms
        Parameters:
        provider - the default providerId.
        Throws:
        java.lang.SecurityException - if a security manager is installed and the caller does not have permission to register the JCE algorithm