com.files.models

Class As2Partner

java.lang.Object

com.files.models.As2Partner

All Implemented Interfaces:

ModelInterface

public class As2Partner
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,String>	additionalHttpHeaders Additional HTTP Headers for outgoing message sent to this partner.
Long	as2StationId ID of the AS2 Station associated with this partner.
String	defaultMimeType Default mime type of the file attached to the encrypted message
Boolean	enableDedicatedIps If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
String	hexPublicCertificateSerial Serial of public certificate used for message security in hex format.
String	httpAuthPassword Password to send to server for HTTP Authentication.
String	httpAuthUsername Username to send to server for HTTP Authentication.
Long	id ID of the AS2 Partner.
String	mdnValidationLevel How should Files.com evaluate message transfer success based on a partner's MDN response?
String	name The partner's formal AS2 name.
String	publicCertificate Public certificate for AS2 Partner.
String	publicCertificateIssuer Issuer of public certificate used for message security.
String	publicCertificateMd5 MD5 hash of public certificate used for message security.
String	publicCertificateNotAfter Not after value of public certificate used for message security.
String	publicCertificateNotBefore Not before value of public certificate used for message security.
String	publicCertificateSerial Serial of public certificate used for message security.
String	publicCertificateSubject Subject of public certificate used for message security.
String	serverCertificate Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS?
String	uri Public URI where we will send the AS2 messages (via HTTP/HTTPS).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<As2Partner>	all()
static ListIterator<As2Partner>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static As2Partner	create(HashMap<String,Object> parameters) Parameters: enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
static As2Partner	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static As2Partner	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static As2Partner	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - As2 Partner ID.
static As2Partner	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static As2Partner	get()
static As2Partner	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<As2Partner>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<As2Partner>	list(HashMap<String,Object> parameters)
static ListIterator<As2Partner>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
As2Partner	update() Parameters: enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
static As2Partner	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static As2Partner	update(Long id, HashMap<String,Object> parameters) Parameters: enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.
static As2Partner	update(Long id, 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.

as2StationId

public Long as2StationId

ID of the AS2 Station associated with this partner.

name

public String name

The partner's formal AS2 name.

uri

public String uri

Public URI where we will send the AS2 messages (via HTTP/HTTPS).

serverCertificate

public String serverCertificate

Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS?

httpAuthUsername

public String httpAuthUsername

Username to send to server for HTTP Authentication.

additionalHttpHeaders

public Map<String,String> additionalHttpHeaders

Additional HTTP Headers for outgoing message sent to this partner.

defaultMimeType

public String defaultMimeType

Default mime type of the file attached to the encrypted message

mdnValidationLevel

public String mdnValidationLevel

How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.

enableDedicatedIps

public Boolean enableDedicatedIps

If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner.

hexPublicCertificateSerial

public String hexPublicCertificateSerial

Serial of public certificate used for message security in hex format.

publicCertificateMd5

public String publicCertificateMd5

MD5 hash of public certificate used for message security.

publicCertificateSubject

public String publicCertificateSubject

Subject of public certificate used for message security.

publicCertificateIssuer

public String publicCertificateIssuer

Issuer of public certificate used for message security.

publicCertificateSerial

public String publicCertificateSerial

Serial of public certificate used for message security.

publicCertificateNotBefore

public String publicCertificateNotBefore

Not before value of public certificate used for message security.

publicCertificateNotAfter

public String publicCertificateNotAfter

Not after value of public certificate used for message security.

httpAuthPassword

public String httpAuthPassword

Password to send to server for HTTP Authentication.

publicCertificate

public String publicCertificate

Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.

Constructor Detail

As2Partner

public As2Partner()

As2Partner

public As2Partner(HashMap<String,Object> parameters)

As2Partner

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

Method Detail

update

public As2Partner update()
                  throws IOException

Parameters: enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner. http_auth_username - string - Username to send to server for HTTP Authentication. http_auth_password - string - Password to send to server for HTTP Authentication. mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? default_mime_type - string - Default mime type of the file attached to the encrypted message additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner. name - string - The partner's formal AS2 name. uri - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS). public_certificate - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<As2Partner> 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).

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<As2Partner> all()
                                    throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

find

public static As2Partner find(Long id,
                              HashMap<String,Object> parameters)
                       throws RuntimeException

Parameters: id (required) - int64 - As2 Partner ID.

Throws:

RuntimeException

find

public static As2Partner find(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

find

public static As2Partner find(Long id,
                              HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:

RuntimeException

get

public static As2Partner get()
                      throws RuntimeException

Throws:

RuntimeException

get

public static As2Partner get(Long id,
                             HashMap<String,Object> parameters,
                             HashMap<String,Object> options)
                      throws RuntimeException

Throws:

RuntimeException

create

public static As2Partner create(HashMap<String,Object> parameters)
                         throws RuntimeException

Parameters: enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner. http_auth_username - string - Username to send to server for HTTP Authentication. http_auth_password - string - Password to send to server for HTTP Authentication. mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? default_mime_type - string - Default mime type of the file attached to the encrypted message additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner. as2_station_id (required) - int64 - ID of the AS2 Station associated with this partner. name (required) - string - The partner's formal AS2 name. uri (required) - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS). public_certificate (required) - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.

Throws:

RuntimeException

create

public static As2Partner create(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

update

public static As2Partner update(Long id,
                                HashMap<String,Object> parameters)
                         throws RuntimeException

Parameters: enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 Partner. http_auth_username - string - Username to send to server for HTTP Authentication. http_auth_password - string - Password to send to server for HTTP Authentication. mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates. server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS? default_mime_type - string - Default mime type of the file attached to the encrypted message additional_http_headers - object - Additional HTTP Headers for outgoing message sent to this partner. name - string - The partner's formal AS2 name. uri - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS). public_certificate - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.

Throws:

RuntimeException

update

public static As2Partner update(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

update

public static As2Partner update(Long id,
                                HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException