org.opensaml
Interface SAMLSOAPBinding.SOAPHook

Enclosing interface:
SAMLSOAPBinding

public static interface SAMLSOAPBinding.SOAPHook

Callback interface provided by client application enabling post-construction modification or examination of SOAP envelope. For example, a caller may embed security information and/or sign the envelope, or insert additional headers as required.

Author:
Scott Cantor

Method Summary
 boolean incoming(Element envelope, Object globalCtx, Object callCtx)
          Callback hook enabling incoming envelope examination.
 boolean outgoing(Element envelope, Object globalCtx, Object callCtx)
          Callback hook enabling outgoing envelope modification.
 

Method Detail

incoming

boolean incoming(Element envelope,
                 Object globalCtx,
                 Object callCtx)
                 throws SAMLException
Callback hook enabling incoming envelope examination.

Parameters:
envelope - The SOAP envelope after insertion of the SAML protocol message
globalCtx - Context data to pass to registered hooks on each call
callCtx - Context data to pass to registered hooks for this call
Returns:
true iff receipt of message should proceed
Throws:
SAMLException - Raised by hook if an error occurs, aborts receipt

outgoing

boolean outgoing(Element envelope,
                 Object globalCtx,
                 Object callCtx)
                 throws SAMLException
Callback hook enabling outgoing envelope modification.

Parameters:
envelope - The SOAP envelope after insertion of the SAML protocol message
globalCtx - Context data to pass to registered hooks on each call
callCtx - Context data to pass to registered hooks for this call
Returns:
true iff transmission of message should proceed
Throws:
SAMLException - Raised by hook if an error occurs, aborts transmission


Copyright ? 2005 UCAID. All Rights Reserved.