com.files.models

Class As2IncomingMessage

java.lang.Object

com.files.models.As2IncomingMessage

All Implemented Interfaces:

ModelInterface

public class As2IncomingMessage
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	activityLog JSON Structure of the activity log.
String	as2From AS2 FROM header of message
Long	as2PartnerId Id of the AS2 Partner associated with this message.
Long	as2StationId Id of the AS2 Station associated with this message.
String	as2To AS2 TO header of message
String	attachmentFilename Filename of the file being received.
String	bodySize Encrypted Payload Body Size
String	contentType Content Type header of the incoming message.
Date	createdAt Message creation date/time
String	date Date Header
String	encryptedUri URL to download the encrypted signed smime that is to sent as AS2 body
String	hexRecipientSerial Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format.
Map<String,String>	httpHeaders HTTP Headers sent with this message.
String	httpResponseCode HTTP Response Code sent for this message
Map<String,String>	httpResponseHeaders HTTP Headers sent for this message.
Long	id Id of the AS2 Partner.
String	ip IP Address of the Sender
String	mdnResponseUri URL to download the http response body
Boolean	messageDecrypted Message decrypted successfully?
String	messageId AS2 Message Id
Boolean	messageMdnReturned MDN returned?
Boolean	messageProcessingSuccess Message processed successfully?
Boolean	messageReceived Message body received?
Boolean	messageSignatureVerified Message signature verified?
String	mic AS2 Message Integrity Check
String	micAlgo AS2 Message Integrity Check Algorithm Used
String	processingResult Result of processing.
String	processingResultDescription Result of processing description.
String	rawUri URL to download the original file contents
String	recipientIssuer Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer
String	recipientSerial Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial
String	smimeSignedUri URL to download the file contents as smime with signature
String	smimeUri URL to download the file contents encoded as smime
String	subject AS2 Subject Header
String	uuid UUID assigned to this message.

Constructor Summary

Constructors

Constructor and Description
As2IncomingMessage()
As2IncomingMessage(HashMap<String,Object> parameters)
As2IncomingMessage(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<As2IncomingMessage>	all()
static ListIterator<As2IncomingMessage>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<As2IncomingMessage>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<As2IncomingMessage>	list(HashMap<String,Object> parameters)
static ListIterator<As2IncomingMessage>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

Id of the AS2 Partner.

as2PartnerId

public Long as2PartnerId

Id of the AS2 Partner associated with this message.

as2StationId

public Long as2StationId

Id of the AS2 Station associated with this message.

uuid

public String uuid

UUID assigned to this message.

contentType

public String contentType

Content Type header of the incoming message.

httpHeaders

public Map<String,String> httpHeaders

HTTP Headers sent with this message.

activityLog

public String activityLog

JSON Structure of the activity log.

processingResult

public String processingResult

Result of processing.

processingResultDescription

public String processingResultDescription

Result of processing description.

mic

public String mic

AS2 Message Integrity Check

micAlgo

public String micAlgo

AS2 Message Integrity Check Algorithm Used

as2To

public String as2To

AS2 TO header of message

as2From

public String as2From

AS2 FROM header of message

messageId

public String messageId

AS2 Message Id

subject

public String subject

AS2 Subject Header

date

public String date

Date Header

bodySize

public String bodySize

Encrypted Payload Body Size

attachmentFilename

public String attachmentFilename

Filename of the file being received.

ip

public String ip

IP Address of the Sender

createdAt

public Date createdAt

Message creation date/time

httpResponseCode

public String httpResponseCode

HTTP Response Code sent for this message

httpResponseHeaders

public Map<String,String> httpResponseHeaders

HTTP Headers sent for this message.

recipientSerial

public String recipientSerial

Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial

hexRecipientSerial

public String hexRecipientSerial

Incoming Message Recipient(the Client Cert used to encrypt this message)'s serial in hex format.

recipientIssuer

public String recipientIssuer

Incoming Message Recipient(the Client Cert used to encrypt this message)'s issuer

messageReceived

public Boolean messageReceived

Message body received?

messageDecrypted

public Boolean messageDecrypted

Message decrypted successfully?

messageSignatureVerified

public Boolean messageSignatureVerified

Message signature verified?

messageProcessingSuccess

public Boolean messageProcessingSuccess

Message processed successfully?

messageMdnReturned

public Boolean messageMdnReturned

MDN returned?

encryptedUri

public String encryptedUri

URL to download the encrypted signed smime that is to sent as AS2 body

smimeSignedUri

public String smimeSignedUri

URL to download the file contents as smime with signature

smimeUri

public String smimeUri

URL to download the file contents encoded as smime

rawUri

public String rawUri

URL to download the original file contents

mdnResponseUri

public String mdnResponseUri

URL to download the http response body

Constructor Detail

As2IncomingMessage

public As2IncomingMessage()

As2IncomingMessage

public As2IncomingMessage(HashMap<String,Object> parameters)

As2IncomingMessage

public As2IncomingMessage(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)

Method Detail

list

public static ListIterator<As2IncomingMessage> list()
                                             throws RuntimeException

Parameters: cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at` and `as2_partner_id`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`. filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. as2_partner_id - int64 - As2 Partner ID. If provided, will return message specific to that partner.

Throws:

RuntimeException

list

public static ListIterator<As2IncomingMessage> list(HashMap<String,Object> parameters)
                                             throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<As2IncomingMessage> list(HashMap<String,Object> parameters,
                                                    HashMap<String,Object> options)
                                             throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<As2IncomingMessage> all()
                                            throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<As2IncomingMessage> all(HashMap<String,Object> parameters,
                                                   HashMap<String,Object> options)
                                            throws RuntimeException

Throws:

RuntimeException