org.apache.abdera.security
Interface Encryption


public interface Encryption

Interface used for encrypting/decrypting Abdera documents.


Method Summary
 Document decrypt(Document doc, EncryptionOptions options)
          Decrypt the document using the specified options
 Document encrypt(Document doc, EncryptionOptions options)
          Encrypt the document using the specified options
 EncryptionOptions getDefaultEncryptionOptions()
          Returns the default encryption/decryption options
 boolean isEncrypted(Document doc)
          Returns true if this specified document has been encrypted
 

Method Detail

encrypt

Document encrypt(Document doc,
                 EncryptionOptions options)
                 throws SecurityException
Encrypt the document using the specified options

Parameters:
doc - The document to encrypt
options - The encryption options
Returns:
The encrypted document
Throws:
SecurityException - if the encryption failed

decrypt

Document decrypt(Document doc,
                 EncryptionOptions options)
                 throws SecurityException
Decrypt the document using the specified options

Parameters:
doc - The document to decrypt
options - The decryption options
Returns:
The decrypted document
Throws:
SecurityException - if the decryption failed

isEncrypted

boolean isEncrypted(Document doc)
                    throws SecurityException
Returns true if this specified document has been encrypted

Throws:
SecurityException

getDefaultEncryptionOptions

EncryptionOptions getDefaultEncryptionOptions()
Returns the default encryption/decryption options

See Also:
EncryptionOptions


Copyright © 2006-2010 Apache Software Foundation. All Rights Reserved.