Module org.apache.santuario.xmlsec

Package org.apache.xml.security.stax.ext

Class SecurePart

java.lang.Object

org.apache.xml.security.stax.ext.SecurePart

public class SecurePart
extends Object

Class to describe which and how an element must be secured

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SecurePart.Modifier

Constructor Summary

Constructors

Constructor	Description
SecurePart(String externalReference)
SecurePart(String externalReference, String[] transforms, String digestMethod)
SecurePart(String externalReference, SecurePart.Modifier modifier)
SecurePart(QName name, boolean generateXPointer, SecurePart.Modifier modifier)
SecurePart(QName name, boolean generateXPointer, SecurePart.Modifier modifier, String[] transforms, String digestMethod)
SecurePart(QName name, SecurePart.Modifier modifier)
SecurePart(QName name, SecurePart.Modifier modifier, String[] transforms, String digestMethod)
SecurePart(SecurePart.Modifier modifier)

Method Summary

Modifier and Type	Method	Description
String	getDigestMethod()
String	getExternalReference()
String	getIdToSecure()	The ID of the element to secure (encrypt or sign), possibly null.
String	getIdToSign()	Deprecated.
SecurePart.Modifier	getModifier()
QName	getName()	The name of the element to be secured
String[]	getTransforms()
boolean	isGenerateXPointer()
boolean	isRequired()
boolean	isSecureEntireRequest()
void	setDigestMethod(String digestMethod)
void	setExternalReference(String externalReference)
void	setGenerateXPointer(boolean generateXPointer)
void	setIdToSecure(String idToSecure)
void	setIdToSign(String idToSign)	Deprecated.
void	setModifier(SecurePart.Modifier modifier)
void	setName(QName name)
void	setRequired(boolean required)
void	setSecureEntireRequest(boolean secureEntireRequest)
void	setTransforms(String[] transforms)

Methods inherited from class java.lang.Object

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

Constructor Details

SecurePart

public SecurePart(SecurePart.Modifier modifier)

SecurePart

public SecurePart(QName name,
 SecurePart.Modifier modifier)

SecurePart

public SecurePart(QName name,
 SecurePart.Modifier modifier,
 String[] transforms,
 String digestMethod)

SecurePart

public SecurePart(QName name,
 boolean generateXPointer,
 SecurePart.Modifier modifier)

SecurePart

public SecurePart(QName name,
 boolean generateXPointer,
 SecurePart.Modifier modifier,
 String[] transforms,
 String digestMethod)

SecurePart

public SecurePart(String externalReference)

SecurePart

public SecurePart(String externalReference,
 SecurePart.Modifier modifier)

SecurePart

public SecurePart(String externalReference,
 String[] transforms,
 String digestMethod)

Method Details

getName

public QName getName()

The name of the element to be secured

Returns:

The Element-Local-Name

setName

public void setName(QName name)

getModifier

public SecurePart.Modifier getModifier()

setModifier

public void setModifier(SecurePart.Modifier modifier)

getIdToSecure

public String getIdToSecure()

The ID of the element to secure (encrypt or sign), possibly null. This matches the attribute value of an element that has an attribute with a name given by XMLSecurityProperties.getIdAttributeNS().

Returns:

The ID of the element to secure, possibly null.

setIdToSecure

public void setIdToSecure(String idToSecure)

getIdToSign

@Deprecated
public String getIdToSign()

Deprecated.

Use getIdToSecure() instead.

setIdToSign

@Deprecated
public void setIdToSign(String idToSign)

Deprecated.

Use setIdToSecure(String) instead.

Parameters:

idToSign -

isGenerateXPointer

public boolean isGenerateXPointer()

setGenerateXPointer

public void setGenerateXPointer(boolean generateXPointer)

getExternalReference

public String getExternalReference()

setExternalReference

public void setExternalReference(String externalReference)

getTransforms

public String[] getTransforms()

setTransforms

public void setTransforms(String[] transforms)

getDigestMethod

public String getDigestMethod()

setDigestMethod

public void setDigestMethod(String digestMethod)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

isSecureEntireRequest

public boolean isSecureEntireRequest()

setSecureEntireRequest

public void setSecureEntireRequest(boolean secureEntireRequest)