com.gemalto.idp.mobile.oob.message

Interface OobIncomingMessage

All Superinterfaces:

OobMessage

All Known Subinterfaces:

OobGenericIncomingMessage, OobProviderToUserMessage, OobTransactionSigningRequest, OobTransactionVerifyRequest

All Known Implementing Classes:

OobIncomingMessageBase, com.gemalto.idp.mobile.oob.internal.message.OobIncomingMessageImpl

public interface OobIncomingMessage
extends OobMessage

Interface of an incoming message from the OOB server.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
OobErrorMessage	createOobError(int errorCode, java.lang.String errorDescription, java.lang.Exception exception, java.lang.String externalRef, java.util.Map<java.lang.String,java.lang.String> meta) Create an outgoing error response for the current message.
OobErrorMessage	createOobError(int errorCode, java.lang.String errorDescription, java.lang.String errorStackTrace, java.lang.String externalRef, java.util.Map<java.lang.String,java.lang.String> meta) Create an outgoing error response for the current message.
java.util.Date	getExpirationDate() Get the message expiration date.
java.lang.String	getMessageType() Get the underlying message type.
boolean	isAcknowledgmentRequested() The server acknowledgment state of the message.

Methods inherited from interface com.gemalto.idp.mobile.oob.message.OobMessage

getMessageId, getMessageMIMEType, getProviderId, wipe

Method Detail

getMessageType

java.lang.String getMessageType()

Get the underlying message type.

Returns:

The message type.

isAcknowledgmentRequested

boolean isAcknowledgmentRequested()

The server acknowledgment state of the message.

Returns:

true if the server has request and acknowledgment.

getExpirationDate

java.util.Date getExpirationDate()

Get the message expiration date.

Returns:

The expiration date.

createOobError

OobErrorMessage createOobError(int errorCode,
                               java.lang.String errorDescription,
                               java.lang.String errorStackTrace,
                               java.lang.String externalRef,
                               java.util.Map<java.lang.String,java.lang.String> meta)

Create an outgoing error response for the current message.

Parameters:

errorCode - Error code.

errorDescription - Error description.

errorStackTrace - Error stack trace. Can be null.

externalRef - Any external reference. Can be null.

meta - Meta data for the message. Can be null.

Returns:

The generic message ready to be send.

createOobError

OobErrorMessage createOobError(int errorCode,
                               java.lang.String errorDescription,
                               java.lang.Exception exception,
                               java.lang.String externalRef,
                               java.util.Map<java.lang.String,java.lang.String> meta)

Create an outgoing error response for the current message.

Parameters:

errorCode - Error code.

errorDescription - Error description.

exception - Exception to be sent. Can be null.

externalRef - Any external reference. Can be null.

meta - Meta data for the message. Can be null.

Returns:

The generic message ready to be send.