org.jose4j.jca

Class ProviderContext.Context

java.lang.Object

org.jose4j.jca.ProviderContext.Context

Enclosing class:

ProviderContext

public class ProviderContext.Context
extends Object

Allows for a provider to be named for various operations. Not all operations are relevant in any particular JOSE context.

Constructor Summary

Constructors

Constructor and Description
Context()

Method Summary

Modifier and Type	Method and Description
String	getCipherProvider() Gets the the JCA provider to be used for relevant Cipher operations.
String	getGeneralProvider() Gets the general JCA provider to be used for all relevant operations when a more specific one isn't set.
String	getKeyAgreementProvider() Gets the the JCA provider to be used for relevant KeyAgreement operations.
String	getKeyFactoryProvider() Gets the the JCA provider to be used for relevant KeyFactory operations.
String	getKeyPairGeneratorProvider() Gets the the JCA provider to be used for relevant KeyPairGenerator operations.
String	getMacProvider() Gets the the JCA provider to be used for relevant Mac operations.
String	getMessageDigestProvider() Gets the the JCA provider to be used for relevant MessageDigest operations.
ProviderContext.SignatureAlgorithmOverride	getSignatureAlgorithmOverride() Gets the the algorithm info (name and parameter spec) to be used as overrides for relevant Signature operations.
String	getSignatureProvider() Gets the the JCA provider to be used for relevant Signature operations.
void	setCipherProvider(String cipherProvider) Sets the the JCA provider to be used for relevant Cipher operations.
void	setGeneralProvider(String generalProvider) Sets the general JCA provider to be used for all relevant operations when a more specific one isn't set.
void	setKeyAgreementProvider(String keyAgreementProvider) Sets the the JCA provider to be used for relevant KeyAgreement operations.
void	setKeyFactoryProvider(String keyFactoryProvider) Sets the the JCA provider to be used for relevant KeyFactory operations.
void	setKeyPairGeneratorProvider(String keyPairGeneratorProvider) Sets the the JCA provider to be used for relevant KeyPairGenerator operations.
void	setMacProvider(String macProvider) Sets the the JCA provider to be used for relevant Mac operations.
void	setMessageDigestProvider(String messageDigestProvider) Sets the the JCA provider to be used for relevant MessageDigest operations.
void	setSignatureAlgorithmOverride(ProviderContext.SignatureAlgorithmOverride signatureAlgorithmOverride) Sets the algorithm info (name and parameter spec) to be used as overrides for relevant Signature operations.
void	setSignatureProvider(String signatureProvider) Sets the the JCA provider to be used for relevant Signature operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context()

Method Detail

getGeneralProvider

public String getGeneralProvider()

Gets the general JCA provider to be used for all relevant operations when a more specific one isn't set.

Returns:

the general JCA provider name

setGeneralProvider

public void setGeneralProvider(String generalProvider)

Sets the general JCA provider to be used for all relevant operations when a more specific one isn't set. null to use the system configured providers.

Parameters:

generalProvider - the provider name

getKeyPairGeneratorProvider

public String getKeyPairGeneratorProvider()

Gets the the JCA provider to be used for relevant KeyPairGenerator operations.

Returns:

the name of the provider or null for the the system configured providers.

setKeyPairGeneratorProvider

public void setKeyPairGeneratorProvider(String keyPairGeneratorProvider)

Sets the the JCA provider to be used for relevant KeyPairGenerator operations. null to use the system configured providers.

Parameters:

keyPairGeneratorProvider - the provider name

getKeyAgreementProvider

public String getKeyAgreementProvider()

Gets the the JCA provider to be used for relevant KeyAgreement operations.

Returns:

the name of the provider or null for the the system configured providers.

setKeyAgreementProvider

public void setKeyAgreementProvider(String keyAgreementProvider)

Sets the the JCA provider to be used for relevant KeyAgreement operations. null to use the system configured providers.

Parameters:

keyAgreementProvider - the provider name

getCipherProvider

public String getCipherProvider()

Gets the the JCA provider to be used for relevant Cipher operations.

Returns:

the name of the provider or null for the the system configured providers.

setCipherProvider

public void setCipherProvider(String cipherProvider)

Sets the the JCA provider to be used for relevant Cipher operations. null to use the system configured providers.

Parameters:

cipherProvider - the provider name

getSignatureProvider

public String getSignatureProvider()

Gets the the JCA provider to be used for relevant Signature operations.

Returns:

the name of the provider or null for the the system configured providers.

setSignatureProvider

public void setSignatureProvider(String signatureProvider)

Sets the the JCA provider to be used for relevant Signature operations. null to use the system configured providers.

Parameters:

signatureProvider - the provider name

getSignatureAlgorithmOverride

public ProviderContext.SignatureAlgorithmOverride getSignatureAlgorithmOverride()

Gets the the algorithm info (name and parameter spec) to be used as overrides for relevant Signature operations. Null means no override is done and the normal algorithm details are used.

Returns:

the SignatureAlgorithmOverride object or null

setSignatureAlgorithmOverride

public void setSignatureAlgorithmOverride(ProviderContext.SignatureAlgorithmOverride signatureAlgorithmOverride)

Sets the algorithm info (name and parameter spec) to be used as overrides for relevant Signature operations. The need for this should be quite rare but it could be useful in cases where different providers are using different names for the same algorithm - and there have been some naming inconsistencies with RSAPSS where RSASSA-PSS + AlgorithmParameterSpec was used when PSS support was added to the default JRE but providers that supported PSS earlier used something like SHA256withRSAandMGF1).

Parameters:

signatureAlgorithmOverride - with the algorithm info. Null indicates to use the defaults (and is the default in and of itself).

getMacProvider

public String getMacProvider()

Gets the the JCA provider to be used for relevant Mac operations.

Returns:

of the Mac provider or null for the the system configured providers.

setMacProvider

public void setMacProvider(String macProvider)

Sets the the JCA provider to be used for relevant Mac operations. null to use the system configured providers.

Parameters:

macProvider - the provider name

getMessageDigestProvider

public String getMessageDigestProvider()

Gets the the JCA provider to be used for relevant MessageDigest operations.

Returns:

the name of the provider or null for the the system configured providers.

setMessageDigestProvider

public void setMessageDigestProvider(String messageDigestProvider)

Sets the the JCA provider to be used for relevant MessageDigest operations. null to use the system configured providers.

Parameters:

messageDigestProvider - the provider name

getKeyFactoryProvider

public String getKeyFactoryProvider()

Gets the the JCA provider to be used for relevant KeyFactory operations.

Returns:

the name of the provider or null for the the system configured providers.

setKeyFactoryProvider

public void setKeyFactoryProvider(String keyFactoryProvider)

Sets the the JCA provider to be used for relevant KeyFactory operations. null to use the system configured providers.

Parameters:

keyFactoryProvider - the provider name