org.opensaml.xmlsec.algorithm

Class AlgorithmRegistry

java.lang.Object

org.opensaml.xmlsec.algorithm.AlgorithmRegistry

public class AlgorithmRegistry
extends Object

A registry of AlgorithmDescriptor instances, to support various use cases for working with algorithm URIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AlgorithmRegistry.SignatureAlgorithmIndex Class used as index key for signature algorithm lookup.

Constructor Summary

Constructors

Constructor and Description
AlgorithmRegistry() Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all registered algorithms.
void	deregister(AlgorithmDescriptor descriptor) Deregister an algorithm.
void	deregister(String uri) Deregister an algorithm.
AlgorithmDescriptor	get(String algorithmURI) Get the algorithm descriptor instance associated with the specified algorithm URI.
DigestAlgorithm	getDigestAlgorithm(String digestMethod) Lookup a digest method algorithm descriptor by the JCA digest method ID.
SignatureAlgorithm	getSignatureAlgorithm(String keyType, String digestMethod) Lookup a signature algorithm descriptor by the JCA key algorithm and digest method IDs.
boolean	isRuntimeSupported(String algorithmURI) Retrieve indication of whether the runtime environment supports the algorithm.
void	register(AlgorithmDescriptor descriptor) Register an algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmRegistry

public AlgorithmRegistry()

Constructor.

Method Detail

get

@Nullable
public AlgorithmDescriptor get(@Nullable
                                         String algorithmURI)

Get the algorithm descriptor instance associated with the specified algorithm URI.

Parameters:

algorithmURI - the algorithm URI to resolve

Returns:

the resolved algorithm descriptor or null

isRuntimeSupported

public boolean isRuntimeSupported(@Nullable
                                  String algorithmURI)

Retrieve indication of whether the runtime environment supports the algorithm.

This evaluation is performed dynamically when the algorithm is registered.

Parameters:

algorithmURI - the algorithm URI to evaluate

Returns:

true if the algorithm is supported by the current runtime environment, false otherwise

clear

public void clear()

Clear all registered algorithms.

register

public void register(@Nonnull
                     AlgorithmDescriptor descriptor)

Register an algorithm.

Parameters:

descriptor - the algorithm

deregister

public void deregister(@Nonnull
                       AlgorithmDescriptor descriptor)

Deregister an algorithm.

Parameters:

descriptor - the algorithm

deregister

public void deregister(@Nonnull
                       String uri)

Deregister an algorithm.

Parameters:

uri - the algorithm URI

getDigestAlgorithm

@Nullable
public DigestAlgorithm getDigestAlgorithm(@Nonnull
                                                    String digestMethod)

Lookup a digest method algorithm descriptor by the JCA digest method ID.

Parameters:

digestMethod - the JCA digest method ID.

Returns:

the algorithm descriptor, or null

getSignatureAlgorithm

@Nullable
public SignatureAlgorithm getSignatureAlgorithm(@Nonnull
                                                          String keyType,
                                                          @Nonnull
                                                          String digestMethod)

Lookup a signature algorithm descriptor by the JCA key algorithm and digest method IDs.

Parameters:

keyType - the JCA key algorithm ID.

digestMethod - the JCA digest method ID.

Returns:

the algorithm descriptor, or null