org.apache.xml.security.stax.ext
Class XMLSecurityProperties

java.lang.Object
  extended by org.apache.xml.security.stax.ext.XMLSecurityProperties

public class XMLSecurityProperties
extends Object

Main configuration class to supply keys etc. This class is subject to change in the future.

Version:
$Revision: 1562446 $ $Date: 2014-01-29 14:02:29 +0000 (Wed, 29 Jan 2014) $
Author:
$Author: coheigea $

Constructor Summary
  XMLSecurityProperties()
           
protected XMLSecurityProperties(XMLSecurityProperties xmlSecurityProperties)
           
 
Method Summary
 void addAction(XMLSecurityConstants.Action action)
           
 void addEncryptionPart(SecurePart securePart)
          Adds a part which must be encrypted by the framework
 void addInputProcessor(InputProcessor inputProcessor)
          Add an additional, non standard, InputProcessor to the chain
 void addSignaturePart(SecurePart securePart)
           
 List<XMLSecurityConstants.Action> getActions()
          Returns the actual set actions
 Key getDecryptionKey()
           
 Key getEncryptionKey()
           
 SecurityTokenConstants.KeyIdentifier getEncryptionKeyIdentifier()
          returns the KeyIdentifierType which will be used in the secured document
 String getEncryptionKeyTransportAlgorithm()
          Returns the encryption key transport algorithm
 String getEncryptionKeyTransportDigestAlgorithm()
           
 String getEncryptionKeyTransportMGFAlgorithm()
           
 byte[] getEncryptionKeyTransportOAEPParams()
           
 List<SecurePart> getEncryptionSecureParts()
          Returns the encryption parts which are actually set
 String getEncryptionSymAlgorithm()
          Returns the Encryption-Algo
 Key getEncryptionTransportKey()
           
 X509Certificate getEncryptionUseThisCertificate()
           
 List<InputProcessor> getInputProcessorList()
          Returns the currently registered additional InputProcessors
 String getSignatureAlgorithm()
           
 String getSignatureCanonicalizationAlgorithm()
           
 X509Certificate[] getSignatureCerts()
           
 String getSignatureDigestAlgorithm()
           
 Key getSignatureKey()
           
 SecurityTokenConstants.KeyIdentifier getSignatureKeyIdentifier()
           
 List<SecurePart> getSignatureSecureParts()
           
 Key getSignatureVerificationKey()
           
 boolean isAddExcC14NInclusivePrefixes()
           
 boolean isDisableSchemaValidation()
           
 boolean isSkipDocumentEvents()
          Returns if the framework is skipping document-events
 boolean isUseSingleCert()
           
 void setActions(List<XMLSecurityConstants.Action> actions)
          Specifies how to secure the document eg.
 void setAddExcC14NInclusivePrefixes(boolean addExcC14NInclusivePrefixes)
           
 void setDecryptionKey(Key decryptionKey)
           
 void setDisableSchemaValidation(boolean disableSchemaValidation)
           
 void setEncryptionKey(Key encryptionKey)
           
 void setEncryptionKeyIdentifier(SecurityTokenConstants.KeyIdentifier encryptionKeyIdentifier)
          Specifies the KeyIdentifierType to use in the secured document
 void setEncryptionKeyTransportAlgorithm(String encryptionKeyTransportAlgorithm)
          Specifies the encryption key transport algorithm
 void setEncryptionKeyTransportDigestAlgorithm(String encryptionKeyTransportDigestAlgorithm)
           
 void setEncryptionKeyTransportMGFAlgorithm(String encryptionKeyTransportMGFAlgorithm)
           
 void setEncryptionKeyTransportOAEPParams(byte[] encryptionKeyTransportOAEPParams)
           
 void setEncryptionSymAlgorithm(String encryptionSymAlgorithm)
          Specifies the encryption algorithm
 void setEncryptionTransportKey(Key encryptionTransportKey)
           
 void setEncryptionUseThisCertificate(X509Certificate encryptionUseThisCertificate)
           
 void setSignatureAlgorithm(String signatureAlgorithm)
           
 void setSignatureCanonicalizationAlgorithm(String signatureCanonicalizationAlgorithm)
           
 void setSignatureCerts(X509Certificate[] signatureCerts)
           
 void setSignatureDigestAlgorithm(String signatureDigestAlgorithm)
           
 void setSignatureKey(Key signatureKey)
           
 void setSignatureKeyIdentifier(SecurityTokenConstants.KeyIdentifier signatureKeyIdentifier)
           
 void setSignatureVerificationKey(Key signatureVerificationKey)
           
 void setSkipDocumentEvents(boolean skipDocumentEvents)
          specifies if the framework should forward Document-Events or not
 void setUseSingleCert(boolean useSingleCert)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLSecurityProperties

public XMLSecurityProperties()

XMLSecurityProperties

protected XMLSecurityProperties(XMLSecurityProperties xmlSecurityProperties)
Method Detail

getSignatureKeyIdentifier

public SecurityTokenConstants.KeyIdentifier getSignatureKeyIdentifier()

setSignatureKeyIdentifier

public void setSignatureKeyIdentifier(SecurityTokenConstants.KeyIdentifier signatureKeyIdentifier)

getEncryptionKeyIdentifier

public SecurityTokenConstants.KeyIdentifier getEncryptionKeyIdentifier()
returns the KeyIdentifierType which will be used in the secured document

Returns:
The KeyIdentifierType

setEncryptionKeyIdentifier

public void setEncryptionKeyIdentifier(SecurityTokenConstants.KeyIdentifier encryptionKeyIdentifier)
Specifies the KeyIdentifierType to use in the secured document

Parameters:
encryptionKeyIdentifier -

addInputProcessor

public void addInputProcessor(InputProcessor inputProcessor)
Add an additional, non standard, InputProcessor to the chain

Parameters:
inputProcessor - The InputProcessor to add

getInputProcessorList

public List<InputProcessor> getInputProcessorList()
Returns the currently registered additional InputProcessors

Returns:
the List with the InputProcessors

setDecryptionKey

public void setDecryptionKey(Key decryptionKey)

getDecryptionKey

public Key getDecryptionKey()

setEncryptionTransportKey

public void setEncryptionTransportKey(Key encryptionTransportKey)

getEncryptionTransportKey

public Key getEncryptionTransportKey()

setEncryptionKey

public void setEncryptionKey(Key encryptionKey)

getEncryptionKey

public Key getEncryptionKey()

addEncryptionPart

public void addEncryptionPart(SecurePart securePart)
Adds a part which must be encrypted by the framework

Parameters:
securePart -

getEncryptionSecureParts

public List<SecurePart> getEncryptionSecureParts()
Returns the encryption parts which are actually set

Returns:
A List of SecurePart's

getEncryptionSymAlgorithm

public String getEncryptionSymAlgorithm()
Returns the Encryption-Algo

Returns:
the Encryption-Algo as String

setEncryptionSymAlgorithm

public void setEncryptionSymAlgorithm(String encryptionSymAlgorithm)
Specifies the encryption algorithm

Parameters:
encryptionSymAlgorithm - The algo to use for encryption

getEncryptionKeyTransportAlgorithm

public String getEncryptionKeyTransportAlgorithm()
Returns the encryption key transport algorithm

Returns:
the key transport algorithm as string

setEncryptionKeyTransportAlgorithm

public void setEncryptionKeyTransportAlgorithm(String encryptionKeyTransportAlgorithm)
Specifies the encryption key transport algorithm

Parameters:
encryptionKeyTransportAlgorithm - the encryption key transport algorithm as string

getEncryptionKeyTransportDigestAlgorithm

public String getEncryptionKeyTransportDigestAlgorithm()

setEncryptionKeyTransportDigestAlgorithm

public void setEncryptionKeyTransportDigestAlgorithm(String encryptionKeyTransportDigestAlgorithm)

getEncryptionKeyTransportMGFAlgorithm

public String getEncryptionKeyTransportMGFAlgorithm()

setEncryptionKeyTransportMGFAlgorithm

public void setEncryptionKeyTransportMGFAlgorithm(String encryptionKeyTransportMGFAlgorithm)

getEncryptionKeyTransportOAEPParams

public byte[] getEncryptionKeyTransportOAEPParams()

setEncryptionKeyTransportOAEPParams

public void setEncryptionKeyTransportOAEPParams(byte[] encryptionKeyTransportOAEPParams)

getEncryptionUseThisCertificate

public X509Certificate getEncryptionUseThisCertificate()

setEncryptionUseThisCertificate

public void setEncryptionUseThisCertificate(X509Certificate encryptionUseThisCertificate)

getSignatureCerts

public X509Certificate[] getSignatureCerts()

setSignatureCerts

public void setSignatureCerts(X509Certificate[] signatureCerts)

addSignaturePart

public void addSignaturePart(SecurePart securePart)

getSignatureSecureParts

public List<SecurePart> getSignatureSecureParts()

getSignatureAlgorithm

public String getSignatureAlgorithm()

setSignatureAlgorithm

public void setSignatureAlgorithm(String signatureAlgorithm)

getSignatureDigestAlgorithm

public String getSignatureDigestAlgorithm()

setSignatureDigestAlgorithm

public void setSignatureDigestAlgorithm(String signatureDigestAlgorithm)

setSignatureKey

public void setSignatureKey(Key signatureKey)

getSignatureKey

public Key getSignatureKey()

isUseSingleCert

public boolean isUseSingleCert()

setUseSingleCert

public void setUseSingleCert(boolean useSingleCert)

isAddExcC14NInclusivePrefixes

public boolean isAddExcC14NInclusivePrefixes()

setAddExcC14NInclusivePrefixes

public void setAddExcC14NInclusivePrefixes(boolean addExcC14NInclusivePrefixes)

getActions

public List<XMLSecurityConstants.Action> getActions()
Returns the actual set actions

Returns:
The Actions in applied order

setActions

public void setActions(List<XMLSecurityConstants.Action> actions)
Specifies how to secure the document eg. Timestamp, Signature, Encrypt

Parameters:
actions -

addAction

public void addAction(XMLSecurityConstants.Action action)

getSignatureCanonicalizationAlgorithm

public String getSignatureCanonicalizationAlgorithm()

setSignatureCanonicalizationAlgorithm

public void setSignatureCanonicalizationAlgorithm(String signatureCanonicalizationAlgorithm)

getSignatureVerificationKey

public Key getSignatureVerificationKey()

setSignatureVerificationKey

public void setSignatureVerificationKey(Key signatureVerificationKey)

isSkipDocumentEvents

public boolean isSkipDocumentEvents()
Returns if the framework is skipping document-events

Returns:
true if document-events will be skipped, false otherwise

setSkipDocumentEvents

public void setSkipDocumentEvents(boolean skipDocumentEvents)
specifies if the framework should forward Document-Events or not

Parameters:
skipDocumentEvents - set to true when document events should be discarded, false otherwise

isDisableSchemaValidation

public boolean isDisableSchemaValidation()

setDisableSchemaValidation

public void setDisableSchemaValidation(boolean disableSchemaValidation)


Copyright © 2000–2014 The Apache Software Foundation. All rights reserved.