|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sun.xml.wss.impl.misc.SOAPElementExtension
com.sun.xml.wss.impl.misc.SecurityHeaderBlockImpl
com.sun.xml.wss.core.KeyInfoHeaderBlock
public class KeyInfoHeaderBlock
Corresponds to the schema representation for a KeyInfo.
| Field Summary | |
|---|---|
static String |
SignatureSpecNS
|
static String |
SignatureSpecNSprefix
|
static String |
TAG_KEYINFO
|
| Fields inherited from class com.sun.xml.wss.impl.misc.SecurityHeaderBlockImpl |
|---|
delegateElement |
| Constructor Summary | |
|---|---|
KeyInfoHeaderBlock(Document ownerDoc)
constructor that creates an empty KeyInfo |
|
KeyInfoHeaderBlock(com.sun.org.apache.xml.internal.security.keys.KeyInfo keyinfo)
constructor that takes Apache KeyInfo |
|
KeyInfoHeaderBlock(SOAPElement element)
parse and create the KeyInfo element |
|
| Method Summary | |
|---|---|
void |
addBinarySecret(SOAPElement binarySecret)
Method addBinarySecret |
void |
addDSAKeyValue(SOAPElement dsakeyvalue)
Method add |
void |
addEncryptedKey(EncryptedKeyToken reference)
Method addEncryptedKey |
void |
addKeyName(SOAPElement keyname)
Method add. |
void |
addKeyName(String keynameString)
Method addKeyName. |
void |
addKeyValue(PublicKey pk)
Method addKeyValue |
void |
addKeyValue(SOAPElement keyvalue)
Method addKeyValue |
void |
addMgmtData(SOAPElement mgmtdata)
Method add |
void |
addMgmtData(String mgmtdata)
Method addMgmtData |
void |
addPGPData(SOAPElement pgpdata)
Method addPGPData |
void |
addRetrievalMethod(SOAPElement retrievalmethod)
Method addRetrievalMethod |
void |
addRetrievalMethod(String URI,
com.sun.org.apache.xml.internal.security.transforms.Transforms transforms,
String type)
Method addRetrievalMethod |
void |
addRSAKeyValue(SOAPElement rsakeyvalue)
Method add |
void |
addSecurityTokenReference(SecurityTokenReference reference)
Method addSecurityTokenReference |
void |
addSPKIData(SOAPElement spkidata)
Method add |
void |
addUnknownElement(SOAPElement element)
Method addUnknownElement |
void |
addUnknownKeyValue(SOAPElement unknownKeyValueElement)
Method addKeyValue |
void |
addX509Data(SOAPElement x509data)
Method addX509Data |
void |
addX509Data(com.sun.org.apache.xml.internal.security.keys.content.X509Data x509Data)
|
int |
binarySecretCount()
Method binarySecretCount |
boolean |
containsBinarySecret()
Method containsBinarySecret |
boolean |
containsEncryptedKeyToken()
Method containsEncryptedKeyToken |
boolean |
containsKeyName()
Method containsKeyName |
boolean |
containsKeyValue()
Method containsKeyValue |
boolean |
containsMgmtData()
Method containsMgmtData |
boolean |
containsPGPData()
Method containsPGPData |
boolean |
containsRetrievalMethod()
Method containsRetrievalMethod |
boolean |
containsSecurityTokenReference()
Method containsSecurityTokenReference |
boolean |
containsSPKIData()
Method containsSPKIData |
boolean |
containsUnknownElement()
Method containsUnknownElement |
boolean |
containsX509Data()
Method containsX509Data |
int |
encryptedKeyTokenCount()
Method encryptedKeyTokenCount |
static SecurityHeaderBlock |
fromSoapElement(SOAPElement element)
|
SOAPElement |
getAsSoapElement()
Method to return the KeyInfo as a SOAPElement. |
BinarySecret |
getBinarySecret(int index)
|
EncryptedKeyToken |
getEncryptedKey(int index)
Method getEncryptedKey |
String |
getId()
Method getId |
com.sun.org.apache.xml.internal.security.keys.KeyInfo |
getKeyInfo()
Method getKeyInfo |
SOAPElement |
getKeyName(int index)
Method getKeyName |
String |
getKeyNameString(int index)
Method getKeyNameString |
com.sun.org.apache.xml.internal.security.keys.content.KeyValue |
getKeyValue(int index)
Method getKeyValue |
SOAPElement |
getKeyValueElement(int index)
Method getKeyValueElement |
SOAPElement |
getMgmtData(int index)
Method getMgmtData |
SOAPElement |
getPGPData(int index)
Method getPGPData |
SOAPElement |
getRetrievalMethod(int index)
Method getRetrievalMethod |
SecurityTokenReference |
getSecurityTokenReference(int index)
Method getSecurityTokenReference |
SOAPElement |
getSPKIData(int index)
Method getSPKIData |
SOAPElement |
getUnknownElement(int index)
Method getUnknownElement |
com.sun.org.apache.xml.internal.security.keys.content.X509Data |
getX509Data(int index)
Method getX509Data |
SOAPElement |
getX509DataElement(int index)
Method getX509DataElement |
int |
keyNameCount()
Method keyNameCount |
int |
keyValueCount()
Method keyValueCount |
int |
mgmtDataCount()
Method mgmtDataCount |
int |
pgpDataCount()
Method pgpDataCount |
int |
retrievalMethodCount()
Method retrievalMethodCount |
void |
saveChanges()
This method should be called when changes are made inside an object through its reference obtained from any of the get methods of this class. |
int |
securityTokenReferenceCount()
Method securityTokenReferenceCount |
void |
setBaseURI(String uri)
Method setBaseURI : BaseURI accepted by Apache KeyInfo Ctor |
void |
setDocument(Document doc)
setDocument |
void |
setId(String id)
Method setId |
int |
spkiDataCount()
Method spkiDataCount |
int |
unknownElementCount()
Method unknownElementCount |
int |
x509DataCount()
Method x509DataCount |
| Methods inherited from class com.sun.xml.wss.impl.misc.SOAPElementExtension |
|---|
addAttribute, addChildElement, createQName, getAttributeValue, getChildElements, getElementQName, removeAttribute, setElementQName |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.xml.soap.SOAPElement |
|---|
addAttribute, addChildElement, createQName, getAttributeValue, getChildElements, getElementQName, removeAttribute, setElementQName |
| Field Detail |
|---|
public static final String SignatureSpecNS
public static final String SignatureSpecNSprefix
public static final String TAG_KEYINFO
| Constructor Detail |
|---|
public KeyInfoHeaderBlock(Document ownerDoc)
throws XWSSecurityException
ownerDoc - the OwnerDocument of the KeyInfo
XWSSecurityException
public KeyInfoHeaderBlock(com.sun.org.apache.xml.internal.security.keys.KeyInfo keyinfo)
throws XWSSecurityException
keyinfo - the KeyInfo from XML DSIG
XWSSecurityException
public KeyInfoHeaderBlock(SOAPElement element)
throws XWSSecurityException
element - the KeyInfo element
NOTE : this constructor assumes a fully initialized XML KeyInfo
No additions are allowed on the keyinfo, only we can get existing
values. For example addkeyName() will have no impact on the KeyInfo
will not append a KeyName child to the KeyInfo.
XWSSecurityException| Method Detail |
|---|
public void addKeyName(String keynameString)
keynameString - public void addBinarySecret(SOAPElement binarySecret)
secret - byte[] representing secret
public void addKeyName(SOAPElement keyname)
throws XWSSecurityException
keyname -
XWSSecurityExceptionpublic void addKeyValue(PublicKey pk)
pk - public void addUnknownKeyValue(SOAPElement unknownKeyValueElement)
unknownKeyValueElement -
public void addDSAKeyValue(SOAPElement dsakeyvalue)
throws XWSSecurityException
dsakeyvalue -
XWSSecurityException
public void addRSAKeyValue(SOAPElement rsakeyvalue)
throws XWSSecurityException
rsakeyvalue -
XWSSecurityException
public void addKeyValue(SOAPElement keyvalue)
throws XWSSecurityException
keyvalue -
XWSSecurityExceptionpublic void addMgmtData(String mgmtdata)
mgmtdata -
public void addMgmtData(SOAPElement mgmtdata)
throws XWSSecurityException
mgmtdata -
XWSSecurityException
public void addPGPData(SOAPElement pgpdata)
throws XWSSecurityException
pgpdata -
XWSSecurityException
public void addRetrievalMethod(String URI,
com.sun.org.apache.xml.internal.security.transforms.Transforms transforms,
String type)
URI - transforms - type -
public void addRetrievalMethod(SOAPElement retrievalmethod)
throws XWSSecurityException
retrievalmethod -
XWSSecurityException
public void addSPKIData(SOAPElement spkidata)
throws XWSSecurityException
spkidata -
XWSSecurityException
public void addX509Data(SOAPElement x509data)
throws XWSSecurityException
x509data -
XWSSecurityExceptionpublic void addUnknownElement(SOAPElement element)
element - public int keyNameCount()
public int keyValueCount()
public int mgmtDataCount()
public int pgpDataCount()
public int retrievalMethodCount()
public int spkiDataCount()
public int x509DataCount()
public int unknownElementCount()
public SOAPElement getKeyName(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public String getKeyNameString(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public SOAPElement getKeyValueElement(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public com.sun.org.apache.xml.internal.security.keys.content.KeyValue getKeyValue(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public SOAPElement getMgmtData(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public SOAPElement getPGPData(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public SOAPElement getRetrievalMethod(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public SOAPElement getSPKIData(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public SOAPElement getX509DataElement(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public com.sun.org.apache.xml.internal.security.keys.content.X509Data getX509Data(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityException
public SOAPElement getUnknownElement(int index)
throws XWSSecurityException
index - 0 is the lowest index
XWSSecurityExceptionpublic boolean containsKeyName()
public boolean containsKeyValue()
public boolean containsMgmtData()
public boolean containsPGPData()
public boolean containsRetrievalMethod()
public boolean containsSPKIData()
public boolean containsUnknownElement()
public boolean containsX509Data()
public void addSecurityTokenReference(SecurityTokenReference reference)
throws XWSSecurityException
reference -
XWSSecurityException
public SecurityTokenReference getSecurityTokenReference(int index)
throws XWSSecurityException
index -
XWSSecurityExceptionpublic int securityTokenReferenceCount()
public boolean containsSecurityTokenReference()
public void addEncryptedKey(EncryptedKeyToken reference)
throws XWSSecurityException
reference -
XWSSecurityException
public EncryptedKeyToken getEncryptedKey(int index)
throws XWSSecurityException
index -
XWSSecurityExceptionpublic int encryptedKeyTokenCount()
public boolean containsEncryptedKeyToken()
public BinarySecret getBinarySecret(int index)
throws XWSSecurityException
XWSSecurityExceptionpublic int binarySecretCount()
public boolean containsBinarySecret()
public void setId(String id)
public String getId()
getId in interface SecurityHeaderBlockgetId in class SecurityHeaderBlockImplpublic final com.sun.org.apache.xml.internal.security.keys.KeyInfo getKeyInfo()
public void setBaseURI(String uri)
uri - Base URI to be used as context for all relative URIs.
public SOAPElement getAsSoapElement()
throws XWSSecurityException
getAsSoapElement in interface SecurityHeaderBlockgetAsSoapElement in class SecurityHeaderBlockImplXWSSecurityException - If owner soap document is not set.setDocument(Document)public void setDocument(Document doc)
doc - The owner Document of this KeyInfopublic void saveChanges()
public static SecurityHeaderBlock fromSoapElement(SOAPElement element)
throws XWSSecurityException
XWSSecurityException
public void addX509Data(com.sun.org.apache.xml.internal.security.keys.content.X509Data x509Data)
throws XWSSecurityException
XWSSecurityException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||