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

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

public class XMLSec
extends Object

This is the central class of the streaming XML-security framework.
Instances of the inbound and outbound security streams can be retrieved with this class.

Version:
$Revision: 1354898 $ $Date: 2012-06-28 11:19:02 +0100 (Thu, 28 Jun 2012) $
Author:
$Author: coheigea $

Constructor Summary
XMLSec()
           
 
Method Summary
static InboundXMLSec getInboundWSSec(XMLSecurityProperties securityProperties)
          Creates and configures an inbound streaming security engine
static OutboundXMLSec getOutboundXMLSec(XMLSecurityProperties securityProperties)
          Creates and configures an outbound streaming security engine
static void init()
           
static XMLSecurityProperties validateAndApplyDefaultsToInboundSecurityProperties(XMLSecurityProperties securityProperties)
          Validates the user supplied configuration and applies default values as appropriate for the inbound security engine
static XMLSecurityProperties validateAndApplyDefaultsToOutboundSecurityProperties(XMLSecurityProperties securityProperties)
          Validates the user supplied configuration and applies default values as appropriate for the outbound security engine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLSec

public XMLSec()
Method Detail

init

public static void init()

getOutboundXMLSec

public static OutboundXMLSec getOutboundXMLSec(XMLSecurityProperties securityProperties)
                                        throws XMLSecurityException
Creates and configures an outbound streaming security engine

Parameters:
securityProperties - The user-defined security configuration
Returns:
A new OutboundXMLSec
Throws:
XMLSecurityException - if the initialisation failed
XMLSecurityConfigurationException - if the configuration is invalid

getInboundWSSec

public static InboundXMLSec getInboundWSSec(XMLSecurityProperties securityProperties)
                                     throws XMLSecurityException
Creates and configures an inbound streaming security engine

Parameters:
securityProperties - The user-defined security configuration
Returns:
A new InboundWSSec
Throws:
XMLSecurityException - if the initialisation failed
XMLSecurityConfigurationException - if the configuration is invalid

validateAndApplyDefaultsToOutboundSecurityProperties

public static XMLSecurityProperties validateAndApplyDefaultsToOutboundSecurityProperties(XMLSecurityProperties securityProperties)
                                                                                  throws XMLSecurityConfigurationException
Validates the user supplied configuration and applies default values as appropriate for the outbound security engine

Parameters:
securityProperties - The configuration to validate
Returns:
The validated configuration
Throws:
XMLSecurityConfigurationException - if the configuration is invalid

validateAndApplyDefaultsToInboundSecurityProperties

public static XMLSecurityProperties validateAndApplyDefaultsToInboundSecurityProperties(XMLSecurityProperties securityProperties)
                                                                                 throws XMLSecurityConfigurationException
Validates the user supplied configuration and applies default values as appropriate for the inbound security engine

Parameters:
securityProperties - The configuration to validate
Returns:
The validated configuration
Throws:
XMLSecurityConfigurationException - if the configuration is invalid


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