Apache CXF API

org.apache.cxf.sts.service
Class EncryptionProperties

java.lang.Object
  extended by org.apache.cxf.sts.service.EncryptionProperties

public class EncryptionProperties
extends Object

This class contains various configuration properties that can be used to encrypt an issued token. The encryptionName property must be specified (corresponding to the alias to be used to select a certificate from a KeyStore) - everything else is optional.


Constructor Summary
EncryptionProperties()
           
 
Method Summary
 List<String> getAcceptedEncryptionAlgorithms()
          Get the list of accepted encryption algorithms.
 List<String> getAcceptedKeyWrapAlgorithms()
          Get the list of accepted key-wrap algorithms.
 String getEncryptionAlgorithm()
          Get the encryption algorithm to use
 String getEncryptionName()
          Get the alias used to select a certificate for encryption
 int getKeyIdentifierType()
          Get the (WSS4J) key identifier type used to reference a certificate for encryption
 String getKeyWrapAlgorithm()
          Get the encryption key-wrap algorithm to use
 void setAcceptedEncryptionAlgorithms(List<String> acceptedEncryptionAlgorithms)
          Set the list of accepted encryption algorithms.
 void setAcceptedKeyWrapAlgorithms(List<String> acceptedKeyWrapAlgorithms)
          Set the list of accepted key-wrap algorithms.
 void setEncryptionAlgorithm(String encryptionAlgorithm)
          Set the encryption algorithm to use
 void setEncryptionName(String encryptionName)
          Set the alias used to select a certificate for encryption
 void setKeyIdentifierType(int keyIdentifierType)
          Set the (WSS4J) key identifier type used to reference a certificate for encryption
 void setKeyWrapAlgorithm(String keyWrapAlgorithm)
          Set the encryption key-wrap algorithm to use
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EncryptionProperties

public EncryptionProperties()
Method Detail

getEncryptionAlgorithm

public String getEncryptionAlgorithm()
Get the encryption algorithm to use


setEncryptionAlgorithm

public void setEncryptionAlgorithm(String encryptionAlgorithm)
Set the encryption algorithm to use


getKeyWrapAlgorithm

public String getKeyWrapAlgorithm()
Get the encryption key-wrap algorithm to use


setKeyWrapAlgorithm

public void setKeyWrapAlgorithm(String keyWrapAlgorithm)
Set the encryption key-wrap algorithm to use


getKeyIdentifierType

public int getKeyIdentifierType()
Get the (WSS4J) key identifier type used to reference a certificate for encryption


setKeyIdentifierType

public void setKeyIdentifierType(int keyIdentifierType)
Set the (WSS4J) key identifier type used to reference a certificate for encryption


getEncryptionName

public String getEncryptionName()
Get the alias used to select a certificate for encryption


setEncryptionName

public void setEncryptionName(String encryptionName)
Set the alias used to select a certificate for encryption


setAcceptedEncryptionAlgorithms

public void setAcceptedEncryptionAlgorithms(List<String> acceptedEncryptionAlgorithms)
Set the list of accepted encryption algorithms. A request can contain a wst:EncryptionAlgorithm uri to use to encrypt an issued token. The algorithm specified must be contained in this list. The default algorithms are 3-DES, AES-128, AES-128 GCM, AES-192, AES-192 GCM, AES-256 and AES-256 GCM.


getAcceptedEncryptionAlgorithms

public List<String> getAcceptedEncryptionAlgorithms()
Get the list of accepted encryption algorithms. A request can contain a wst:EncryptionAlgorithm uri to use to encrypt an issued token. The algorithm specified must be contained in this list. The default algorithms are 3-DES, AES-128, AES-128 GCM, AES-192, AES-192 GCM, AES-256 and AES-256 GCM.


setAcceptedKeyWrapAlgorithms

public void setAcceptedKeyWrapAlgorithms(List<String> acceptedKeyWrapAlgorithms)
Set the list of accepted key-wrap algorithms. A request can contain a wst:KeyWrapAlgorithm uri for use in encrypting an issued token. The algorithm specified must be contained in this list. The default algorithms are RSA 1.5 and RSA OEP.


getAcceptedKeyWrapAlgorithms

public List<String> getAcceptedKeyWrapAlgorithms()
Get the list of accepted key-wrap algorithms. A request can contain a wst:KeyWrapAlgorithm uri for use in encrypting an issued token. The algorithm specified must be contained in this list. The default algorithms are RSA 1.5 and RSA OEP.


Apache CXF API

Apache CXF