org.apache.xml.security.keys.provider
Class KeyStoreElement

java.lang.Object
  |
  +--org.apache.xml.security.utils.ElementProxy
        |
        +--org.apache.xml.security.keys.provider.KeyStoreElement

public class KeyStoreElement
extends ElementProxy

Author:
$Author: geuerp $

Nested Class Summary
 class KeyStoreElement.MyEnumeration
          Class MyEnumeration
 
Field Summary
 
Fields inherited from class org.apache.xml.security.utils.ElementProxy
_baseURI, _constructionElement, _doc, _state, MODE_CREATE, MODE_DECRYPT, MODE_ENCRYPT, MODE_PROCESS, MODE_SIGN, MODE_UNKNOWN, MODE_VERIFY
 
Constructor Summary
KeyStoreElement(org.w3c.dom.Document doc)
          Constructor KeyStoreElement
KeyStoreElement(org.w3c.dom.Element element, java.lang.String BaseURI)
          Constructor KeyStoreElement
 
Method Summary
 java.util.Enumeration aliases()
          Method getAliases
 void deleteEntry(java.lang.String alias)
          Method deleteEntry
 java.lang.String getBaseLocalName()
          Method getBaseLocalName
 java.lang.String getBaseNamespace()
          Method getBaseNamespace
 java.security.cert.Certificate getCertificate(java.lang.String alias)
          Method getCertificate
 java.security.cert.Certificate[] getCertificateChain(java.lang.String alias)
          Method engineGetCertificateChain
 org.w3c.dom.Element getCertificateEntryElement(java.lang.String alias)
          Method getCertificateEntryElement
 java.util.Date getCreationDate(java.lang.String alias)
          Method getCreationDate
 java.security.Key getKey(java.lang.String alias, char[] password)
          Method getKey
 org.w3c.dom.Element getKeyEntryElement(java.lang.String alias)
          Method getKeyEntryElement
 int getNumberOfCertificates()
          Method getNumberOfCertificates
 int getNumberOfKeys()
          Method getNumberOfKeys
 org.w3c.dom.Element getSignatureElement()
          Method getSignatureElement
 boolean isCertificateEntry(java.lang.String alias)
          Method isCertificateEntry
 boolean isKeyEntry(java.lang.String alias)
          Method isKeyEntry
protected  void removeOldSignatures()
          This method removes all ds:Signature children from the KeyStore.
 void setCertificateEntry(java.lang.String alias, java.security.cert.Certificate cert)
          Method setCertificateEntry
 void setKeyEntry(java.lang.String alias, byte[] key, java.security.cert.Certificate[] chain)
          Method setKeyEntry
 void setKeyEntry(java.lang.String alias, java.security.Key k, char[] password, java.security.cert.Certificate[] chain)
          Method setKeyEntry
 void sign(char[] password)
          Method sign
 boolean verify(char[] password)
          Method verify
 
Methods inherited from class org.apache.xml.security.utils.ElementProxy
addBase64Element, addBase64Text, addBigIntegerElement, addText, addTextElement, createElementForFamily, getBaseURI, getBigIntegerFromChildElement, getBytesFromChildElement, getBytesFromTextChild, getChildElementLocalName, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getTextFromChildElement, getTextFromTextChild, guaranteeThatElementInCorrectSpace, length, setDefaultPrefix, setElement, setXPathNamespaceContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KeyStoreElement

public KeyStoreElement(org.w3c.dom.Document doc)
Constructor KeyStoreElement

Parameters:
doc -

KeyStoreElement

public KeyStoreElement(org.w3c.dom.Element element,
                       java.lang.String BaseURI)
                throws XMLSecurityException
Constructor KeyStoreElement

Parameters:
element -
BaseURI -
Throws:
XMLSecurityException
Method Detail

getBaseLocalName

public java.lang.String getBaseLocalName()
Method getBaseLocalName

Specified by:
getBaseLocalName in class ElementProxy
Returns:

getBaseNamespace

public java.lang.String getBaseNamespace()
Method getBaseNamespace

Specified by:
getBaseNamespace in class ElementProxy
Returns:

removeOldSignatures

protected void removeOldSignatures()
This method removes all ds:Signature children from the KeyStore.


sign

public void sign(char[] password)
          throws java.io.IOException
Method sign

Parameters:
password -
Throws:
java.io.IOException

getSignatureElement

public org.w3c.dom.Element getSignatureElement()
                                        throws XMLSecurityException
Method getSignatureElement

Returns:
Throws:
XMLSecurityException

verify

public boolean verify(char[] password)
               throws java.io.IOException
Method verify

Parameters:
password -
Returns:
Throws:
java.io.IOException

getNumberOfKeys

public int getNumberOfKeys()
Method getNumberOfKeys

Returns:

getNumberOfCertificates

public int getNumberOfCertificates()
Method getNumberOfCertificates

Returns:

aliases

public java.util.Enumeration aliases()
Method getAliases

Returns:

isCertificateEntry

public boolean isCertificateEntry(java.lang.String alias)
Method isCertificateEntry

Parameters:
alias -
Returns:

isKeyEntry

public boolean isKeyEntry(java.lang.String alias)
Method isKeyEntry

Parameters:
alias -
Returns:

getCertificateEntryElement

public org.w3c.dom.Element getCertificateEntryElement(java.lang.String alias)
Method getCertificateEntryElement

Parameters:
alias -
Returns:

getKeyEntryElement

public org.w3c.dom.Element getKeyEntryElement(java.lang.String alias)
Method getKeyEntryElement

Parameters:
alias -
Returns:

getCertificate

public java.security.cert.Certificate getCertificate(java.lang.String alias)
Method getCertificate

Parameters:
alias -
Returns:

getCreationDate

public java.util.Date getCreationDate(java.lang.String alias)
Method getCreationDate

Parameters:
alias -
Returns:

deleteEntry

public void deleteEntry(java.lang.String alias)
                 throws java.security.KeyStoreException
Method deleteEntry

Parameters:
alias -
Throws:
java.security.KeyStoreException

getCertificateChain

public java.security.cert.Certificate[] getCertificateChain(java.lang.String alias)
Method engineGetCertificateChain

Parameters:
alias -
Returns:

setCertificateEntry

public void setCertificateEntry(java.lang.String alias,
                                java.security.cert.Certificate cert)
                         throws java.security.KeyStoreException
Method setCertificateEntry

Parameters:
alias -
cert -
Throws:
java.security.KeyStoreException

setKeyEntry

public void setKeyEntry(java.lang.String alias,
                        byte[] key,
                        java.security.cert.Certificate[] chain)
                 throws java.security.KeyStoreException
Method setKeyEntry

Parameters:
alias -
key -
chain -
Throws:
java.security.KeyStoreException

setKeyEntry

public void setKeyEntry(java.lang.String alias,
                        java.security.Key k,
                        char[] password,
                        java.security.cert.Certificate[] chain)
                 throws java.security.KeyStoreException
Method setKeyEntry

Parameters:
alias -
k -
password -
chain -
Throws:
java.security.KeyStoreException

getKey

public java.security.Key getKey(java.lang.String alias,
                                char[] password)
                         throws java.security.NoSuchAlgorithmException,
                                java.security.UnrecoverableKeyException
Method getKey

Parameters:
alias -
password -
Returns:
Throws:
java.security.NoSuchAlgorithmException
java.security.UnrecoverableKeyException