org.apache.commons.openpgp
Interface OpenPgpSigner

All Known Implementing Classes:

BouncyCastleOpenPgpSigner

public interface OpenPgpSigner

Interface for signing data with OpenPGP.

Author:

Brett Porter

Field Summary

static java.lang.String

ROLE

Method Summary

void	detachedSign(java.io.InputStream data, java.io.OutputStream signature, java.lang.String keyId, KeyRing keyRing, boolean asciiArmor) Sign a piece of data with the given key, storing the signature in a detached output.
void	sign(java.io.InputStream data, java.io.OutputStream signedOutput, java.lang.String keyId, KeyRing keyRing, boolean asciiArmor) Sign a piece of data with the given key.

Field Detail

ROLE

static final java.lang.String ROLE

Method Detail

sign

void sign(java.io.InputStream data,
          java.io.OutputStream signedOutput,
          java.lang.String keyId,
          KeyRing keyRing,
          boolean asciiArmor)
          throws OpenPgpException

Sign a piece of data with the given key.

Parameters:

data - the data to sign

signedOutput - the signed output data

keyId - the key ID of the key used to sign it

keyRing - the keyring containing the key above

asciiArmor - whether to ascii armor the output

Throws:

OpenPgpException

detachedSign

void detachedSign(java.io.InputStream data,
                  java.io.OutputStream signature,
                  java.lang.String keyId,
                  KeyRing keyRing,
                  boolean asciiArmor)
                  throws OpenPgpException,
                         java.io.IOException

Sign a piece of data with the given key, storing the signature in a detached output.

Parameters:

data - the data to sign

signature - the detached signature

keyId - the key ID of the key used to sign it

keyRing - the keyring containing the key above

asciiArmor - whether to ascii armor the output

Throws:

OpenPgpException

java.io.IOException