com.amazonaws.services.transfer.model

Class As2ConnectorConfig

java.lang.Object

com.amazonaws.services.transfer.model.As2ConnectorConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class As2ConnectorConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
As2ConnectorConfig()

Method Summary

Modifier and Type	Method and Description
As2ConnectorConfig	clone()
boolean	equals(Object obj)
String	getBasicAuthSecretId() Provides Basic authentication support to the AS2 Connectors API.
String	getCompression() Specifies whether the AS2 file is compressed.
String	getEncryptionAlgorithm() The algorithm that is used to encrypt the file.
String	getLocalProfileId() A unique identifier for the AS2 local profile.
String	getMdnResponse() Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous.
String	getMdnSigningAlgorithm() The signing algorithm for the MDN response.
String	getMessageSubject() Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.
String	getPartnerProfileId() A unique identifier for the partner profile for the connector.
String	getSigningAlgorithm() The algorithm that is used to sign the AS2 messages sent with the connector.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBasicAuthSecretId(String basicAuthSecretId) Provides Basic authentication support to the AS2 Connectors API.
void	setCompression(String compression) Specifies whether the AS2 file is compressed.
void	setEncryptionAlgorithm(String encryptionAlgorithm) The algorithm that is used to encrypt the file.
void	setLocalProfileId(String localProfileId) A unique identifier for the AS2 local profile.
void	setMdnResponse(String mdnResponse) Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous.
void	setMdnSigningAlgorithm(String mdnSigningAlgorithm) The signing algorithm for the MDN response.
void	setMessageSubject(String messageSubject) Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.
void	setPartnerProfileId(String partnerProfileId) A unique identifier for the partner profile for the connector.
void	setSigningAlgorithm(String signingAlgorithm) The algorithm that is used to sign the AS2 messages sent with the connector.
String	toString() Returns a string representation of this object.
As2ConnectorConfig	withBasicAuthSecretId(String basicAuthSecretId) Provides Basic authentication support to the AS2 Connectors API.
As2ConnectorConfig	withCompression(CompressionEnum compression) Specifies whether the AS2 file is compressed.
As2ConnectorConfig	withCompression(String compression) Specifies whether the AS2 file is compressed.
As2ConnectorConfig	withEncryptionAlgorithm(EncryptionAlg encryptionAlgorithm) The algorithm that is used to encrypt the file.
As2ConnectorConfig	withEncryptionAlgorithm(String encryptionAlgorithm) The algorithm that is used to encrypt the file.
As2ConnectorConfig	withLocalProfileId(String localProfileId) A unique identifier for the AS2 local profile.
As2ConnectorConfig	withMdnResponse(MdnResponse mdnResponse) Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous.
As2ConnectorConfig	withMdnResponse(String mdnResponse) Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous.
As2ConnectorConfig	withMdnSigningAlgorithm(MdnSigningAlg mdnSigningAlgorithm) The signing algorithm for the MDN response.
As2ConnectorConfig	withMdnSigningAlgorithm(String mdnSigningAlgorithm) The signing algorithm for the MDN response.
As2ConnectorConfig	withMessageSubject(String messageSubject) Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.
As2ConnectorConfig	withPartnerProfileId(String partnerProfileId) A unique identifier for the partner profile for the connector.
As2ConnectorConfig	withSigningAlgorithm(SigningAlg signingAlgorithm) The algorithm that is used to sign the AS2 messages sent with the connector.
As2ConnectorConfig	withSigningAlgorithm(String signingAlgorithm) The algorithm that is used to sign the AS2 messages sent with the connector.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

As2ConnectorConfig

public As2ConnectorConfig()

Method Detail

setLocalProfileId

public void setLocalProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

getLocalProfileId

public String getLocalProfileId()

A unique identifier for the AS2 local profile.

Returns:

A unique identifier for the AS2 local profile.

withLocalProfileId

public As2ConnectorConfig withLocalProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPartnerProfileId

public void setPartnerProfileId(String partnerProfileId)

A unique identifier for the partner profile for the connector.

Parameters:

partnerProfileId - A unique identifier for the partner profile for the connector.

getPartnerProfileId

public String getPartnerProfileId()

A unique identifier for the partner profile for the connector.

Returns:

A unique identifier for the partner profile for the connector.

withPartnerProfileId

public As2ConnectorConfig withPartnerProfileId(String partnerProfileId)

A unique identifier for the partner profile for the connector.

Parameters:

partnerProfileId - A unique identifier for the partner profile for the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMessageSubject

public void setMessageSubject(String messageSubject)

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

Parameters:

messageSubject - Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

getMessageSubject

public String getMessageSubject()

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

Returns:

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

withMessageSubject

public As2ConnectorConfig withMessageSubject(String messageSubject)

Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

Parameters:

messageSubject - Used as the Subject HTTP header attribute in AS2 messages that are being sent with the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCompression

public void setCompression(String compression)

Specifies whether the AS2 file is compressed.

Parameters:

compression - Specifies whether the AS2 file is compressed.

See Also:

CompressionEnum

getCompression

public String getCompression()

Specifies whether the AS2 file is compressed.

Returns:

Specifies whether the AS2 file is compressed.

See Also:

CompressionEnum

withCompression

public As2ConnectorConfig withCompression(String compression)

Specifies whether the AS2 file is compressed.

Parameters:

compression - Specifies whether the AS2 file is compressed.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CompressionEnum

withCompression

public As2ConnectorConfig withCompression(CompressionEnum compression)

Specifies whether the AS2 file is compressed.

Parameters:

compression - Specifies whether the AS2 file is compressed.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CompressionEnum

setEncryptionAlgorithm

public void setEncryptionAlgorithm(String encryptionAlgorithm)

The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

Parameters:

encryptionAlgorithm - The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

See Also:

EncryptionAlg

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

Returns:

The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

See Also:

EncryptionAlg

withEncryptionAlgorithm

public As2ConnectorConfig withEncryptionAlgorithm(String encryptionAlgorithm)

The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

Parameters:

encryptionAlgorithm - The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlg

withEncryptionAlgorithm

public As2ConnectorConfig withEncryptionAlgorithm(EncryptionAlg encryptionAlgorithm)

The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

Parameters:

encryptionAlgorithm - The algorithm that is used to encrypt the file.

Note the following:

• Do not use the DES_EDE3_CBC algorithm unless you must support a legacy client that requires it, as it is a weak encryption algorithm.

• You can only specify NONE if the URL for your connector uses HTTPS. Using HTTPS ensures that no traffic is sent in clear text.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionAlg

setSigningAlgorithm

public void setSigningAlgorithm(String signingAlgorithm)

The algorithm that is used to sign the AS2 messages sent with the connector.

Parameters:

signingAlgorithm - The algorithm that is used to sign the AS2 messages sent with the connector.

See Also:

SigningAlg

getSigningAlgorithm

public String getSigningAlgorithm()

The algorithm that is used to sign the AS2 messages sent with the connector.

Returns:

The algorithm that is used to sign the AS2 messages sent with the connector.

See Also:

SigningAlg

withSigningAlgorithm

public As2ConnectorConfig withSigningAlgorithm(String signingAlgorithm)

The algorithm that is used to sign the AS2 messages sent with the connector.

Parameters:

signingAlgorithm - The algorithm that is used to sign the AS2 messages sent with the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlg

withSigningAlgorithm

public As2ConnectorConfig withSigningAlgorithm(SigningAlg signingAlgorithm)

The algorithm that is used to sign the AS2 messages sent with the connector.

Parameters:

signingAlgorithm - The algorithm that is used to sign the AS2 messages sent with the connector.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SigningAlg

setMdnSigningAlgorithm

public void setMdnSigningAlgorithm(String mdnSigningAlgorithm)

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

Parameters:

mdnSigningAlgorithm - The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

See Also:

MdnSigningAlg

getMdnSigningAlgorithm

public String getMdnSigningAlgorithm()

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

Returns:

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

See Also:

MdnSigningAlg

withMdnSigningAlgorithm

public As2ConnectorConfig withMdnSigningAlgorithm(String mdnSigningAlgorithm)

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

Parameters:

mdnSigningAlgorithm - The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnSigningAlg

withMdnSigningAlgorithm

public As2ConnectorConfig withMdnSigningAlgorithm(MdnSigningAlg mdnSigningAlgorithm)

The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

Parameters:

mdnSigningAlgorithm - The signing algorithm for the MDN response.

If set to DEFAULT (or not set at all), the value for SigningAlgorithm is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnSigningAlg

setMdnResponse

public void setMdnResponse(String mdnResponse)

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

Parameters:

mdnResponse - Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

See Also:

MdnResponse

getMdnResponse

public String getMdnResponse()

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

Returns:

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

See Also:

MdnResponse

withMdnResponse

public As2ConnectorConfig withMdnResponse(String mdnResponse)

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

Parameters:

mdnResponse - Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnResponse

withMdnResponse

public As2ConnectorConfig withMdnResponse(MdnResponse mdnResponse)

Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

Parameters:

mdnResponse - Used for outbound requests (from an Transfer Family server to a partner AS2 server) to determine whether the partner response for transfers is synchronous or asynchronous. Specify either of the following values:

• SYNC: The system expects a synchronous MDN response, confirming that the file was transferred successfully (or not).

• NONE: Specifies that no MDN response is required.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MdnResponse

setBasicAuthSecretId

public void setBasicAuthSecretId(String basicAuthSecretId)

Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

• You are storing these credentials in Secrets Manager, not passing them directly into this API.

• If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

Parameters:

basicAuthSecretId - Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

• You are storing these credentials in Secrets Manager, not passing them directly into this API.

• If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

getBasicAuthSecretId

public String getBasicAuthSecretId()

Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

• You are storing these credentials in Secrets Manager, not passing them directly into this API.

• If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

Returns:

Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

• You are storing these credentials in Secrets Manager, not passing them directly into this API.

• If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

withBasicAuthSecretId

public As2ConnectorConfig withBasicAuthSecretId(String basicAuthSecretId)

Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

• You are storing these credentials in Secrets Manager, not passing them directly into this API.

• If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

Parameters:

basicAuthSecretId - Provides Basic authentication support to the AS2 Connectors API. To use Basic authentication, you must provide the name or Amazon Resource Name (ARN) of a secret in Secrets Manager.

The default value for this parameter is null, which indicates that Basic authentication is not enabled for the connector.

If the connector should use Basic authentication, the secret needs to be in the following format:

{ "Username": "user-name", "Password": "user-password" }

Replace user-name and user-password with the credentials for the actual user that is being authenticated.

Note the following:

• You are storing these credentials in Secrets Manager, not passing them directly into this API.

• If you are using the API, SDKs, or CloudFormation to configure your connector, then you must create the secret before you can enable Basic authentication. However, if you are using the Amazon Web Services management console, you can have the system create the secret for you.

If you have previously enabled Basic authentication for a connector, you can disable it by using the UpdateConnector API call. For example, if you are using the CLI, you can run the following command to remove Basic authentication:

update-connector --connector-id my-connector-id --as2-config 'BasicAuthSecretId=""'

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public As2ConnectorConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.