org.whispersystems.signalservice.api

Class SignalServiceMessageReceiver

java.lang.Object

org.whispersystems.signalservice.api.SignalServiceMessageReceiver

public class SignalServiceMessageReceiver
extends java.lang.Object

The primary interface for receiving Signal Service messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SignalServiceMessageReceiver.MessageReceivedCallback
static class	SignalServiceMessageReceiver.NullMessageReceivedCallback

Constructor Summary

Constructors

Constructor and Description
SignalServiceMessageReceiver(java.lang.String url, TrustStore trustStore, CredentialsProvider credentials, java.lang.String userAgent) Construct a SignalServiceMessageReceiver.
SignalServiceMessageReceiver(java.lang.String url, TrustStore trustStore, java.lang.String user, java.lang.String password, java.lang.String signalingKey, java.lang.String userAgent) Construct a SignalServiceMessageReceiver.

Method Summary

Modifier and Type	Method and Description
SignalServiceMessagePipe	createMessagePipe() Creates a pipe for receiving SignalService messages.
java.io.InputStream	retrieveAttachment(SignalServiceAttachmentPointer pointer, java.io.File destination) Retrieves a SignalServiceAttachment.
java.io.InputStream	retrieveAttachment(SignalServiceAttachmentPointer pointer, java.io.File destination, SignalServiceAttachment.ProgressListener listener) Retrieves a SignalServiceAttachment.
java.util.List<SignalServiceEnvelope>	retrieveMessages()
java.util.List<SignalServiceEnvelope>	retrieveMessages(SignalServiceMessageReceiver.MessageReceivedCallback callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalServiceMessageReceiver

public SignalServiceMessageReceiver(java.lang.String url,
                                    TrustStore trustStore,
                                    java.lang.String user,
                                    java.lang.String password,
                                    java.lang.String signalingKey,
                                    java.lang.String userAgent)

Construct a SignalServiceMessageReceiver.

Parameters:

url - The URL of the Signal Service.

trustStore - The TrustStore containing the server's TLS signing certificate.

user - The Signal Service username (eg. phone number).

password - The Signal Service user password.

signalingKey - The 52 byte signaling key assigned to this user at registration.

SignalServiceMessageReceiver

public SignalServiceMessageReceiver(java.lang.String url,
                                    TrustStore trustStore,
                                    CredentialsProvider credentials,
                                    java.lang.String userAgent)

Construct a SignalServiceMessageReceiver.

Parameters:

url - The URL of the Signal Service.

trustStore - The TrustStore containing the server's TLS signing certificate.

credentials - The Signal Service user's credentials.

Method Detail

retrieveAttachment

public java.io.InputStream retrieveAttachment(SignalServiceAttachmentPointer pointer,
                                              java.io.File destination)
                                       throws java.io.IOException,
                                              org.whispersystems.libsignal.InvalidMessageException

Retrieves a SignalServiceAttachment.

Parameters:

pointer - The SignalServiceAttachmentPointer received in a SignalServiceDataMessage.

destination - The download destination for this attachment.

Returns:

An InputStream that streams the plaintext attachment contents.

Throws:

java.io.IOException

org.whispersystems.libsignal.InvalidMessageException

retrieveAttachment

public java.io.InputStream retrieveAttachment(SignalServiceAttachmentPointer pointer,
                                              java.io.File destination,
                                              SignalServiceAttachment.ProgressListener listener)
                                       throws java.io.IOException,
                                              org.whispersystems.libsignal.InvalidMessageException

Retrieves a SignalServiceAttachment.

Parameters:

pointer - The SignalServiceAttachmentPointer received in a SignalServiceDataMessage.

destination - The download destination for this attachment.

listener - An optional listener (may be null) to receive callbacks on download progress.

Returns:

An InputStream that streams the plaintext attachment contents.

Throws:

java.io.IOException

org.whispersystems.libsignal.InvalidMessageException

createMessagePipe

public SignalServiceMessagePipe createMessagePipe()

Creates a pipe for receiving SignalService messages. Callers must call SignalServiceMessagePipe.shutdown() when finished with the pipe.

Returns:

A SignalServiceMessagePipe for receiving Signal Service messages.

retrieveMessages

public java.util.List<SignalServiceEnvelope> retrieveMessages()
                                                       throws java.io.IOException

Throws:

java.io.IOException

retrieveMessages

public java.util.List<SignalServiceEnvelope> retrieveMessages(SignalServiceMessageReceiver.MessageReceivedCallback callback)
                                                       throws java.io.IOException

Throws:

java.io.IOException