org.apache.wss4j.common

Class WSEncryptionPart

java.lang.Object

org.apache.wss4j.common.WSEncryptionPart

public class WSEncryptionPart
extends Object

Constructor Summary

Constructors

Constructor and Description
WSEncryptionPart(String id) Constructor to initialize part structure with element id.
WSEncryptionPart(String id, String encMod) Constructor to initialize part structure with element id and modifier.
WSEncryptionPart(String nm, String nmspace, String encMod) Constructor to initialize part structure with element, namespace, and modifier.

Method Summary

Modifier and Type	Method and Description
Element	getElement() Get the DOM Element corresponding to this EncryptionPart
String	getEncId()
String	getEncModifier()
String	getId()
String	getName()
String	getNamespace()
String	getXpath()
boolean	isRequired()
void	setElement(Element element) Set the DOM Element corresponding to this EncryptionPart
void	setEncId(String id)
void	setEncModifier(String encModifier) Set the encryption modifier
void	setId(String id) Set the id
void	setRequired(boolean required)
void	setXpath(String xpath)

Methods inherited from class java.lang.Object

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

Constructor Detail

WSEncryptionPart

public WSEncryptionPart(String nm,
                        String nmspace,
                        String encMod)

Constructor to initialize part structure with element, namespace, and modifier. This constructor initializes the parts structure to lookup for a fully qualified name of an element to encrypt or sign. The modifier controls how encryption encrypts the element, signature processing does not use the modifier information.

Regarding the modifier ("Content" or "Element") refer to the W3C XML Encryption specification.

Parameters:

nm - Element's name

nmspace - Element's namespace

encMod - The encryption modifier

WSEncryptionPart

public WSEncryptionPart(String id)

Constructor to initialize part structure with element id. This constructor initializes the parts structure to lookup for a an element with the given Id to encrypt or sign.

Parameters:

id - The Id to of the element to process

WSEncryptionPart

public WSEncryptionPart(String id,
                        String encMod)

Constructor to initialize part structure with element id and modifier. This constructor initializes the parts structure to lookup for a an element with the given Id to encrypt or sign. The modifier controls how encryption encrypts the element, signature processing does not use the modifier information.

Regarding the modifier ("Content" or "Element") refer to the W3C XML Encryption specification.

Parameters:

id - The Id to of the element to process

encMod - The encryption modifier

Method Detail

getName

public String getName()

Returns:

the local name of the element to encrypt.

getNamespace

public String getNamespace()

Returns:

the namespace of the element to encrypt

getEncModifier

public String getEncModifier()

Returns:

the encryption modifier

setEncModifier

public void setEncModifier(String encModifier)

Set the encryption modifier

getId

public String getId()

Returns:

Returns the id.

setId

public void setId(String id)

Set the id

Parameters:

id -

setEncId

public void setEncId(String id)

getEncId

public String getEncId()

getXpath

public String getXpath()

Returns:

the xpath

setXpath

public void setXpath(String xpath)

Parameters:

xpath - the xpath to set

setElement

public void setElement(Element element)

Set the DOM Element corresponding to this EncryptionPart

Parameters:

element - the DOM Element corresponding to this EncryptionPart

getElement

public Element getElement()

Get the DOM Element corresponding to this EncryptionPart

Returns:

the DOM Element corresponding to this EncryptionPart

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)