Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.poifs.crypt
Class AgileDecryptor

    java.lang.Object
      org.apache.poi.poifs.crypt.Decryptor
          org.apache.poi.poifs.crypt.AgileDecryptor

    public class AgileDecryptor

extends Decryptor

Author:
  Gary King

Field Summary

Fields inherited from class org.apache.poi.poifs.crypt.Decryptor
`DEFAULT_PASSWORD`

Method Summary
`java.io.InputStream` | `getDataStream(DirectoryNode dir)` Return a stream with decrypted data.
`long` | `getLength()` Returns the length of the encytpted data that can be safely read with `Decryptor.getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)`.
`boolean` | `verifyPassword(java.lang.String password)`

Methods inherited from class org.apache.poi.poifs.crypt.Decryptor
`getDataStream, getDataStream, getInstance`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### verifyPassword

    public boolean verifyPassword(java.lang.String password)
                           throws java.security.GeneralSecurityException

  Specified by:
    `verifyPassword` in class `Decryptor`
  Throws:
    `java.security.GeneralSecurityException`

### getDataStream

    public java.io.InputStream getDataStream(DirectoryNode dir)
                                      throws java.io.IOException,
                                             java.security.GeneralSecurityException

  Description copied from class: `Decryptor`
  Return a stream with decrypted data.

  Use `Decryptor.getLength()` to get the size of that data that can be safely read from the stream. Just reading to the end of the input stream is not sufficient because there are normally padding bytes that must be discarded

  Specified by:
    `getDataStream` in class `Decryptor`
  Parameters:
    `dir` - the node to read from
  Returns:
    decrypted stream
  Throws:
    `java.io.IOException`
    `java.security.GeneralSecurityException`

### getLength

    public long getLength()

  Description copied from class: `Decryptor`
  Returns the length of the encytpted data that can be safely read with `Decryptor.getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)`. Just reading to the end of the input stream is not sufficient because there are normally padding bytes that must be discarded

  The length variable is initialized in `Decryptor.getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)`, an attempt to call getLength() prior to getDataStream() will result in IllegalStateException.

  Specified by:
    `getLength` in class `Decryptor`
  Returns:
    length of the encrypted data

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD