Package org.jivesoftware.smackx.ox

Class OpenPgpMessage

java.lang.Object

org.jivesoftware.smackx.ox.OpenPgpMessage

public class OpenPgpMessage
extends Object

This class embodies a decrypted and/or verified OpenPgpElement.
The content can be one of the following three OpenPgpContentElements:

SignElement: The content is expected to be signed with the senders key, but unencrypted.
CryptElement: The content is expected to be encrypted, but not signed.
SigncryptElement: The content is expected to be signed with the senders key and encrypted.

To determine, of which nature the content of the message is, use getState(). You should utilize this information to cast the return value of getOpenPgpContentElement() correctly.
Use getMetadata() in order to get information about the messages encryption status, its signatures etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenPgpMessage.State

Constructor Summary

Constructors

Constructor	Description
OpenPgpMessage(byte[] bytes, OpenPgpMessage.State state, org.pgpainless.decryption_verification.OpenPgpMetadata metadata)	Constructor.
OpenPgpMessage(String content, OpenPgpMessage.State state, org.pgpainless.decryption_verification.OpenPgpMetadata metadata)	Constructor.

Method Summary

Modifier and Type	Method	Description
org.pgpainless.decryption_verification.OpenPgpMetadata	getMetadata()	Return metadata about the encrypted message.
OpenPgpContentElement	getOpenPgpContentElement()	Return the decrypted OpenPgpContentElement of this message.
OpenPgpMessage.State	getState()	Return the state of the message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenPgpMessage

public OpenPgpMessage(String content,
 OpenPgpMessage.State state,
 org.pgpainless.decryption_verification.OpenPgpMetadata metadata)

Constructor.

Parameters:

content - XML representation of the decrypted OpenPgpContentElement.

state - OpenPgpMessage.State of the OpenPgpContentElement.

metadata - Metadata about the encryption.

OpenPgpMessage

public OpenPgpMessage(byte[] bytes,
 OpenPgpMessage.State state,
 org.pgpainless.decryption_verification.OpenPgpMetadata metadata)

Constructor.

Parameters:

bytes - bytes of the XML representation of the decrypted OpenPgpContentElement.

state - OpenPgpMessage.State of the OpenPgpContentElement.

metadata - metadata about the encryption.

Method Details

getOpenPgpContentElement

public OpenPgpContentElement getOpenPgpContentElement()
                                               throws XmlPullParserException,
IOException

Return the decrypted OpenPgpContentElement of this message. To determine, whether the element is a SignElement, CryptElement or SigncryptElement, please consult getState().

Returns:

OpenPgpContentElement

Throws:

XmlPullParserException - if the parser encounters an error.

IOException - if the parser encounters an error.

getState

public OpenPgpMessage.State getState()
                              throws IOException,
XmlPullParserException

Return the state of the message. This value determines, whether the message was a SignElement, CryptElement or SigncryptElement.

Returns:

state of the content element.

Throws:

IOException - if the parser encounters an error.

XmlPullParserException - if the parser encounters and error.

getMetadata

public org.pgpainless.decryption_verification.OpenPgpMetadata getMetadata()

Return metadata about the encrypted message.

Returns:

metadata TODO javadoc me please