- java.lang.Object
-
- org.apache.xml.security.stax.ext.SecurePart
-
public class SecurePart extends java.lang.ObjectClass to describe which and how an element must be secured
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSecurePart.Modifier
-
Field Summary
Fields Modifier and Type Field Description private java.lang.StringdigestMethodprivate java.lang.StringexternalReferenceprivate booleangenerateXPointerprivate java.lang.StringidToSecureprivate SecurePart.Modifiermodifierprivate javax.xml.namespace.QNamenameprivate booleanrequiredprivate booleansecureEntireRequestprivate 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, SecurePart.Modifier modifier)SecurePart(javax.xml.namespace.QName name, SecurePart.Modifier modifier, java.lang.String[] transforms, java.lang.String digestMethod)SecurePart(SecurePart.Modifier modifier)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.StringgetDigestMethod()java.lang.StringgetExternalReference()java.lang.StringgetIdToSecure()The ID of the element to secure (encrypt or sign), possiblynull.java.lang.StringgetIdToSign()Deprecated.SecurePart.ModifiergetModifier()javax.xml.namespace.QNamegetName()The name of the element to be securedjava.lang.String[]getTransforms()booleanisGenerateXPointer()booleanisRequired()booleanisSecureEntireRequest()voidsetDigestMethod(java.lang.String digestMethod)voidsetExternalReference(java.lang.String externalReference)voidsetGenerateXPointer(boolean generateXPointer)voidsetIdToSecure(java.lang.String idToSecure)voidsetIdToSign(java.lang.String idToSign)Deprecated.voidsetModifier(SecurePart.Modifier modifier)voidsetName(javax.xml.namespace.QName name)voidsetRequired(boolean required)voidsetSecureEntireRequest(boolean secureEntireRequest)voidsetTransforms(java.lang.String[] transforms)
-
-
-
Field Detail
-
name
private javax.xml.namespace.QName name
-
generateXPointer
private boolean generateXPointer
-
modifier
private SecurePart.Modifier modifier
-
idToSecure
private java.lang.String idToSecure
-
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(SecurePart.Modifier modifier)
-
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(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)
-
getIdToSecure
public java.lang.String getIdToSecure()
The ID of the element to secure (encrypt or sign), possiblynull. This matches the attribute value of an element that has an attribute with a name given byXMLSecurityProperties.getIdAttributeNS().- Returns:
- The ID of the element to secure, possibly
null.
-
setIdToSecure
public void setIdToSecure(java.lang.String idToSecure)
-
getIdToSign
@Deprecated public java.lang.String getIdToSign()
Deprecated.UsegetIdToSecure()instead.
-
setIdToSign
@Deprecated public void setIdToSign(java.lang.String idToSign)
Deprecated.UsesetIdToSecure(String)instead.- Parameters:
idToSign-
-
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)
-
-