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

## cryptix.message
Class SignedMessageBuilderSpi

    java.lang.Object
      cryptix.message.SignedMessageBuilderSpi

public abstract class SignedMessageBuilderSpi
extends java.lang.Object

Service provider interface for SignedMessageBuilder

Version:
  $Revision: 1.2 $
Author:
  Edwin Woudt

Constructor Summary
`SignedMessageBuilderSpi()`

Method Summary
`abstract void` | `engineAddSigner(KeyBundle bundle, char[] passphrase)` Adds a signer from a keybundle, decrypting it with the given passphrase.
`abstract void` | `engineAddSigner(java.security.PrivateKey signingkey)` Adds a signer
`abstract Message` | `engineBuild()` Returns the signed message
`abstract void` | `engineInit(Message contents, java.security.SecureRandom sr)` Initializes this builder with the given message.
`abstract void` | `engineSetAttribute(java.lang.String name, java.lang.Object attr)` Set a format specific attribute.

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

Constructor Detail

### SignedMessageBuilderSpi

    public SignedMessageBuilderSpi()

Method Detail

### engineInit

    public abstract void engineInit(Message contents,
                                    java.security.SecureRandom sr)
                             throws java.lang.IllegalStateException,
                                    MessageException

  Initializes this builder with the given message.

  Throws:
    `java.lang.IllegalStateException` - if this message has been initialized before.
    `MessageException` - on a variety of format specific problems.

### engineSetAttribute

    public abstract void engineSetAttribute(java.lang.String name,
                                            java.lang.Object attr)
                                     throws java.lang.IllegalStateException,
                                            java.lang.IllegalArgumentException,
                                            MessageException

  Set a format specific attribute.

  Parameters:
    `name` - a name identifying the attribute
    `attr` - the attribute itself
  Throws:
    `java.lang.IllegalStateException` - if this message has not been initialized before.
    `java.lang.IllegalArgumentException` - if the attribute is not supported or the given object does not have the right type.
    `MessageException` - on a variety of format specific problems.

### engineAddSigner

    public abstract void engineAddSigner(java.security.PrivateKey signingkey)
                                  throws java.lang.IllegalStateException,
                                         MessageException

  Adds a signer

  Throws:
    `InvalidStateException` - if this message has not been initialized properly or if the build() method has been called
    `MessageException` - on a variety of format specific problems.
    `java.lang.IllegalStateException`

### engineAddSigner

    public abstract void engineAddSigner(KeyBundle bundle,
                                         char[] passphrase)
                                  throws java.lang.IllegalStateException,
                                         MessageException,
                                         java.security.UnrecoverableKeyException

  Adds a signer from a keybundle, decrypting it with the given passphrase.

  Throws:
    `InvalidStateException` - if this message has not been initialized properly or if the build() method has been called
    `MessageException` - on a variety of format specific problems.
    `java.security.UnrecoverableKeyException` - if the private key cannot be retrieved from the keybundle (for example because of an incorrect passphrase).
    `java.lang.IllegalStateException`

### engineBuild

    public abstract Message engineBuild()
                                 throws java.lang.IllegalStateException,
                                        MessageException

  Returns the signed message

  Throws:
    `InvalidStateException` - if this message has not been initialized properly, if no calls have been made to the addSigner method or if multiple calls to this build() method are made.
    `MessageException` - on a variety of format specific problems.
    `java.lang.IllegalStateException`

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

Copyright (C) 1999-2003 The Cryptix Foundation Ltd.