org.apache.ws.security.message

Class WSSecHeader

java.lang.Object

org.apache.ws.security.message.WSSecHeader

public class WSSecHeader
extends Object

This class implements WS Security header. Setup a Security header with a specified actor and mustunderstand flag. The defaults for actor and mustunderstand are: empty actor and mustunderstand is true.

Author:

Werner Dittmann (Werner.Dittmann@apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	actor
protected boolean	doDebug
protected boolean	mustunderstand

Constructor Summary

Constructors

Constructor and Description
WSSecHeader() Constructor.
WSSecHeader(String actor) Constructor.
WSSecHeader(String act, boolean mu) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Element	getSecurityHeader() Get the security header element of this instance.
Element	insertSecurityHeader(Document doc) Creates a security header and inserts it as child into the SOAP Envelope.
boolean	isEmpty(Document doc) Returns whether the security header is empty
void	removeSecurityHeader(Document doc)
void	setActor(String act) set actor name.
void	setMustUnderstand(boolean mu) Set the mustUnderstand flag for the wsse:Security header.

Methods inherited from class java.lang.Object

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

Field Detail

actor

protected String actor

mustunderstand

protected boolean mustunderstand

doDebug

protected boolean doDebug

Constructor Detail

WSSecHeader

public WSSecHeader()

Constructor.

WSSecHeader

public WSSecHeader(String actor)

Constructor.

Parameters:

actor - The actor name of the wsse:Security header

WSSecHeader

public WSSecHeader(String act,
           boolean mu)

Constructor.

Parameters:

act - The actor name of the wsse:Security header

mu - Set mustUnderstand to true or false

Method Detail

setActor

public void setActor(String act)

set actor name.

Parameters:

act - The actor name of the wsse:Security header

setMustUnderstand

public void setMustUnderstand(boolean mu)

Set the mustUnderstand flag for the wsse:Security header.

Parameters:

mu - Set mustUnderstand to true or false

getSecurityHeader

public Element getSecurityHeader()

Get the security header element of this instance.

Returns:

The security header element.

isEmpty

public boolean isEmpty(Document doc)
                throws WSSecurityException

Returns whether the security header is empty

Returns:

true if empty or if there is no security header false if non empty security header

Throws:

WSSecurityException

insertSecurityHeader

public Element insertSecurityHeader(Document doc)
                             throws WSSecurityException

Creates a security header and inserts it as child into the SOAP Envelope. Check if a WS Security header block for an actor is already available in the document. If a header block is found return it, otherwise a new wsse:Security header block is created and the attributes set

Parameters:

doc - A SOAP envelope as Document

Returns:

A wsse:Security element

Throws:

WSSecurityException

removeSecurityHeader

public void removeSecurityHeader(Document doc)
                          throws WSSecurityException

Throws:

WSSecurityException