CPartnershipIDs (as2-lib 4.3.0 API)

java.lang.Object
- com.helger.as2lib.partner.CPartnershipIDs

```
@Immutable
public final class CPartnershipIDs
extends Object
```
Partnership IDs and attribute names. The IDs (starting with PID_) are using for setSenderID/setReceiverID where as the attributes (starting with PA_) are used with setAttribute.

Author:

Philip Helger

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPRESS_AFTER_SIGNING` Value for `PA_COMPRESSION_MODE`: compress after sign
`static String`	`COMPRESS_BEFORE_SIGNING` Value for `PA_COMPRESSION_MODE`: compress before sign
`static String`	`PA_AS2_MDN_OPTIONS` Requested options for returned MDN
`static String`	`PA_AS2_MDN_TO` Fill in to request an MDN for a transaction
`static String`	`PA_AS2_RECEIPT_DELIVERY_OPTION` URL destination for an async MDN
`static String`	`PA_AS2_RECEIPT_OPTION` Deprecated.
`static String`	`PA_AS2_URL` URL destination for AS2 transactions
`static String`	`PA_BLOCK_ERROR_MDN` If set and an error occurs while processing a document, an error MDN will not be sent.
`static String`	`PA_COMPRESSION_MODE` Optional compression mode
`static String`	`PA_COMPRESSION_TYPE` Optional compression type.
`static String`	`PA_CONTENT_TRANSFER_ENCODING` Deprecated.
`static String`	`PA_CONTENT_TRANSFER_ENCODING_RECEIVE` optional content transfer encoding value for incoming messages if not specified
`static String`	`PA_CONTENT_TRANSFER_ENCODING_SEND` optional content transfer encoding value for outgoing messages.
`static String`	`PA_DATE_FORMAT` set this to override the date format used when generating message IDs
`static String`	`PA_DISABLE_DECOMPRESS` Special attribute to disable decompression of a received message, even if the Content-Type header claims the messages is compressed.
`static String`	`PA_DISABLE_DECRYPT` Special attribute to disable decryption of a received message, even if the Content-Type header claims the messages is encrypted.
`static String`	`PA_DISABLE_VERIFY` Special attribute to disable signature verification of a received message, even if the Content-Type header claims the messages is signed.
`static String`	`PA_ENCRYPT` Set this to the algorithm to use for encryption, check `ECryptoAlgorithmCrypt` constants for values (using the value of the `getID()` method)
`static String`	`PA_FORCE_DECRYPT` Special attribute to force decryption of a received message, even if the Content-Type header claims the messages is not encrypted.
`static String`	`PA_FORCE_VERIFY` Special attribute to force signature verification of a received message, even if the Content-Type header claims the messages is not signed.
`static String`	`PA_MDN_SUBJECT` Subject sent in MDN messages
`static String`	`PA_MESSAGEID_FORMAT` format to use for message-id if not default
`static String`	`PA_PROTOCOL` AS1 or AS2
`static String`	`PA_RFC3851_MICALGS` Special attribute indicating that the "old" RFC 3851 MIC algorithm names should be used (e.g.
`static String`	`PA_SIGN` Set this to the signature digest algorithm to sign sent messages, check `ECryptoAlgorithmSign` constants for values (using the value of the `getID()` method)
`static String`	`PA_SIGN_INCLUDE_CERT_IN_BODY_PART` Indicates whether the certificate used for signing should be part of the signed content (when `true`) or not (when `false`).
`static String`	`PA_SUBJECT` Subject sent in messages
`static String`	`PA_VERIFY_USE_CERT_IN_BODY_PART` Define whether a certificate passed in the signed MIME body part shall be used to verify the signature (when `true`) or whether to always use the certificate provided in the partnership (when `false`).
`static String`	`PID_AS2` AS2 ID (sender or receiver)
`static String`	`PID_EMAIL` Email address (sender or receiver)
`static String`	`PID_X509_ALIAS` Alias to an X509 Certificate (sender or receiver)

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PID_AS2
```
public static final String PID_AS2
```
    AS2 ID (sender or receiver)
    
    See Also:
    
    Constant Field Values
  - PID_X509_ALIAS
```
public static final String PID_X509_ALIAS
```
    Alias to an X509 Certificate (sender or receiver)
    
    See Also:
    
    Constant Field Values
  - PID_EMAIL
```
public static final String PID_EMAIL
```
    Email address (sender or receiver)
    
    See Also:
    
    Constant Field Values
  - PA_AS2_URL
```
public static final String PA_AS2_URL
```
    URL destination for AS2 transactions
    
    See Also:
    
    Constant Field Values
  - PA_AS2_MDN_TO
```
public static final String PA_AS2_MDN_TO
```
    Fill in to request an MDN for a transaction
    
    See Also:
    
    Constant Field Values
  - PA_AS2_MDN_OPTIONS
```
public static final String PA_AS2_MDN_OPTIONS
```
    Requested options for returned MDN
    
    See Also:
    
    Constant Field Values
  - PA_AS2_RECEIPT_DELIVERY_OPTION
```
public static final String PA_AS2_RECEIPT_DELIVERY_OPTION
```
    URL destination for an async MDN
    
    See Also:
    
    Constant Field Values
  - PA_AS2_RECEIPT_OPTION
```
@Deprecated
 @DevelopersNote(value="Use PA_AS2_RECEIPT_DELIVERY_OPTION instead")
public static final String PA_AS2_RECEIPT_OPTION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PA_MESSAGEID_FORMAT
```
public static final String PA_MESSAGEID_FORMAT
```
    format to use for message-id if not default
    
    See Also:
    
    Constant Field Values
  - PA_MDN_SUBJECT
```
public static final String PA_MDN_SUBJECT
```
    Subject sent in MDN messages
    
    See Also:
    
    Constant Field Values
  - PA_BLOCK_ERROR_MDN
```
public static final String PA_BLOCK_ERROR_MDN
```
    If set and an error occurs while processing a document, an error MDN will not be sent. This flag was made because some AS2 products don't provide email or some other external notification when an error MDN is received.
    
    See Also:
    
    Constant Field Values
  - PA_DATE_FORMAT
```
public static final String PA_DATE_FORMAT
```
    set this to override the date format used when generating message IDs
    
    See Also:
    
    Constant Field Values
  - PA_ENCRYPT
```
public static final String PA_ENCRYPT
```
    Set this to the algorithm to use for encryption, check ECryptoAlgorithmCrypt constants for values (using the value of the getID() method)
    
    See Also:
    
    Constant Field Values
  - PA_SIGN
```
public static final String PA_SIGN
```
    Set this to the signature digest algorithm to sign sent messages, check ECryptoAlgorithmSign constants for values (using the value of the getID() method)
    
    See Also:
    
    Constant Field Values
  - PA_PROTOCOL
```
public static final String PA_PROTOCOL
```
    AS1 or AS2
    
    See Also:
    
    Constant Field Values
  - PA_SUBJECT
```
public static final String PA_SUBJECT
```
    Subject sent in messages
    
    See Also:
    
    Constant Field Values
  - PA_CONTENT_TRANSFER_ENCODING_SEND
```
public static final String PA_CONTENT_TRANSFER_ENCODING_SEND
```
    optional content transfer encoding value for outgoing messages. Legacy name.
    
    See Also:
    
    Constant Field Values
  - PA_CONTENT_TRANSFER_ENCODING
```
@Deprecated
public static final String PA_CONTENT_TRANSFER_ENCODING
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PA_CONTENT_TRANSFER_ENCODING_RECEIVE
```
public static final String PA_CONTENT_TRANSFER_ENCODING_RECEIVE
```
    optional content transfer encoding value for incoming messages if not specified
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_COMPRESSION_TYPE
```
public static final String PA_COMPRESSION_TYPE
```
    Optional compression type. Check ECompressionType constants for values (using the value of the getID() method)
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - PA_COMPRESSION_MODE
```
public static final String PA_COMPRESSION_MODE
```
    Optional compression mode
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - COMPRESS_BEFORE_SIGNING
```
public static final String COMPRESS_BEFORE_SIGNING
```
    Value for PA_COMPRESSION_MODE: compress before sign
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - COMPRESS_AFTER_SIGNING
```
public static final String COMPRESS_AFTER_SIGNING
```
    Value for PA_COMPRESSION_MODE: compress after sign
    
    Since:
    
    2.1.0
    
    See Also:
    
    Constant Field Values
  - PA_FORCE_DECRYPT
```
public static final String PA_FORCE_DECRYPT
```
    Special attribute to force decryption of a received message, even if the Content-Type header claims the messages is not encrypted. This is a work-around for non spec-compliant senders. Must be set to true to take effect.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_DISABLE_DECRYPT
```
public static final String PA_DISABLE_DECRYPT
```
    Special attribute to disable decryption of a received message, even if the Content-Type header claims the messages is encrypted. This is a work-around for non spec-compliant senders. Must be set to true to take effect.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_FORCE_VERIFY
```
public static final String PA_FORCE_VERIFY
```
    Special attribute to force signature verification of a received message, even if the Content-Type header claims the messages is not signed. This is a work-around for non spec-compliant senders. Must be set to true to take effect.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_DISABLE_VERIFY
```
public static final String PA_DISABLE_VERIFY
```
    Special attribute to disable signature verification of a received message, even if the Content-Type header claims the messages is signed. This is a work-around for non spec-compliant senders. Must be set to true to take effect.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_SIGN_INCLUDE_CERT_IN_BODY_PART
```
public static final String PA_SIGN_INCLUDE_CERT_IN_BODY_PART
```
    Indicates whether the certificate used for signing should be part of the signed content (when true) or not (when false). If not set the value of the AS2 session is used. Must be set to true or false to take effect.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_VERIFY_USE_CERT_IN_BODY_PART
```
public static final String PA_VERIFY_USE_CERT_IN_BODY_PART
```
    Define whether a certificate passed in the signed MIME body part shall be used to verify the signature (when true) or whether to always use the certificate provided in the partnership (when false). If not set the value of the AS2 session is used. Must be set to true or false to take effect.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_DISABLE_DECOMPRESS
```
public static final String PA_DISABLE_DECOMPRESS
```
    Special attribute to disable decompression of a received message, even if the Content-Type header claims the messages is compressed. This is a work-around for non spec-compliant senders. Must be set to true to take effect.
    
    Since:
    
    2.2.0
    
    See Also:
    
    Constant Field Values
  - PA_RFC3851_MICALGS
```
public static final String PA_RFC3851_MICALGS
```
    Special attribute indicating that the "old" RFC 3851 MIC algorithm names should be used (e.g. sha1) instead of the default RFC 5751 MIC algorithm names (e.g. sha-1 - note the dash between "sha" and "1").
    
    Since:
    
    2.2.7
    
    See Also:
    
    Constant Field Values

Class CPartnershipIDs

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PID_AS2

PID_X509_ALIAS

PID_EMAIL

PA_AS2_URL

PA_AS2_MDN_TO

PA_AS2_MDN_OPTIONS

PA_AS2_RECEIPT_DELIVERY_OPTION

PA_AS2_RECEIPT_OPTION

PA_MESSAGEID_FORMAT

PA_MDN_SUBJECT

PA_BLOCK_ERROR_MDN

PA_DATE_FORMAT

PA_ENCRYPT

PA_SIGN

PA_PROTOCOL

PA_SUBJECT

PA_CONTENT_TRANSFER_ENCODING_SEND

PA_CONTENT_TRANSFER_ENCODING

PA_CONTENT_TRANSFER_ENCODING_RECEIVE

PA_COMPRESSION_TYPE

PA_COMPRESSION_MODE

COMPRESS_BEFORE_SIGNING

COMPRESS_AFTER_SIGNING

PA_FORCE_DECRYPT

PA_DISABLE_DECRYPT

PA_FORCE_VERIFY

PA_DISABLE_VERIFY

PA_SIGN_INCLUDE_CERT_IN_BODY_PART

PA_VERIFY_USE_CERT_IN_BODY_PART

PA_DISABLE_DECOMPRESS

PA_RFC3851_MICALGS