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

Class SecurePart

java.lang.Object

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

public class SecurePart
extends java.lang.Object

Class to describe which and how an element must be secured

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecurePart.Modifier

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	digestMethod
private java.lang.String	externalReference
private boolean	generateXPointer
private java.lang.String	idToReference
private java.lang.String	idToSign
private SecurePart.Modifier	modifier
private javax.xml.namespace.QName	name
private boolean	required
private boolean	secureEntireRequest
private java.lang.String[]	transforms

Constructor Summary

Constructors

Constructor	Description
SecurePart(java.lang.String externalReference)
SecurePart(java.lang.String externalReference, java.lang.String[] transforms, java.lang.String digestMethod)
SecurePart(java.lang.String externalReference, SecurePart.Modifier modifier)
SecurePart(javax.xml.namespace.QName name, boolean generateXPointer, SecurePart.Modifier modifier)
SecurePart(javax.xml.namespace.QName name, boolean generateXPointer, SecurePart.Modifier modifier, java.lang.String[] transforms, java.lang.String digestMethod)
SecurePart(javax.xml.namespace.QName name, java.lang.String idToSign, java.lang.String idToReference, SecurePart.Modifier modifier)
SecurePart(javax.xml.namespace.QName name, SecurePart.Modifier modifier)
SecurePart(javax.xml.namespace.QName name, SecurePart.Modifier modifier, java.lang.String[] transforms, java.lang.String digestMethod)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDigestMethod()
java.lang.String	getExternalReference()
java.lang.String	getIdToReference()
java.lang.String	getIdToSign()	The id of the Element
SecurePart.Modifier	getModifier()
javax.xml.namespace.QName	getName()	The name of the element to be secured
java.lang.String[]	getTransforms()
boolean	isGenerateXPointer()
boolean	isRequired()
boolean	isSecureEntireRequest()
void	setDigestMethod(java.lang.String digestMethod)
void	setExternalReference(java.lang.String externalReference)
void	setGenerateXPointer(boolean generateXPointer)
void	setIdToReference(java.lang.String idToReference)
void	setIdToSign(java.lang.String idToSign)
void	setModifier(SecurePart.Modifier modifier)
void	setName(javax.xml.namespace.QName name)
void	setRequired(boolean required)
void	setSecureEntireRequest(boolean secureEntireRequest)
void	setTransforms(java.lang.String[] transforms)

Methods inherited from class java.lang.Object

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

Field Detail

name

private javax.xml.namespace.QName name

generateXPointer

private boolean generateXPointer

modifier

private SecurePart.Modifier modifier

idToSign

private java.lang.String idToSign

idToReference

private java.lang.String idToReference

externalReference

private java.lang.String externalReference

transforms

private java.lang.String[] transforms

digestMethod

private java.lang.String digestMethod

required

private boolean required

secureEntireRequest

private boolean secureEntireRequest

Constructor Detail

SecurePart

public SecurePart(javax.xml.namespace.QName name,
                  SecurePart.Modifier modifier)

SecurePart

public SecurePart(javax.xml.namespace.QName name,
                  SecurePart.Modifier modifier,
                  java.lang.String[] transforms,
                  java.lang.String digestMethod)

SecurePart

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

SecurePart

public SecurePart(javax.xml.namespace.QName name,
                  boolean generateXPointer,
                  SecurePart.Modifier modifier,
                  java.lang.String[] transforms,
                  java.lang.String digestMethod)

SecurePart

public SecurePart(javax.xml.namespace.QName name,
                  java.lang.String idToSign,
                  java.lang.String idToReference,
                  SecurePart.Modifier modifier)

SecurePart

public SecurePart(java.lang.String externalReference)

SecurePart

public SecurePart(java.lang.String externalReference,
                  SecurePart.Modifier modifier)

SecurePart

public SecurePart(java.lang.String externalReference,
                  java.lang.String[] transforms,
                  java.lang.String digestMethod)

Method Detail

getName

public javax.xml.namespace.QName getName()

The name of the element to be secured

Returns:

The Element-Local-Name

setName

public void setName(javax.xml.namespace.QName name)

getModifier

public SecurePart.Modifier getModifier()

setModifier

public void setModifier(SecurePart.Modifier modifier)

getIdToSign

public java.lang.String getIdToSign()

The id of the Element

Returns:

The id

setIdToSign

public void setIdToSign(java.lang.String idToSign)

getIdToReference

public java.lang.String getIdToReference()

setIdToReference

public void setIdToReference(java.lang.String idToReference)

isGenerateXPointer

public boolean isGenerateXPointer()

setGenerateXPointer

public void setGenerateXPointer(boolean generateXPointer)

getExternalReference

public java.lang.String getExternalReference()

setExternalReference

public void setExternalReference(java.lang.String externalReference)

getTransforms

public java.lang.String[] getTransforms()

setTransforms

public void setTransforms(java.lang.String[] transforms)

getDigestMethod

public java.lang.String getDigestMethod()

setDigestMethod

public void setDigestMethod(java.lang.String digestMethod)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

isSecureEntireRequest

public boolean isSecureEntireRequest()

setSecureEntireRequest

public void setSecureEntireRequest(boolean secureEntireRequest)