Package software.amazon.awssdk.services.transfer.model

Class As2ConnectorConfig

java.lang.Object
software.amazon.awssdk.services.transfer.model.As2ConnectorConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<As2ConnectorConfig.Builder,As2ConnectorConfig>
@Generated("software.amazon.awssdk:codegen") public final class As2ConnectorConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<As2ConnectorConfig.Builder,As2ConnectorConfig>

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:

  • Method Details

    • localProfileId

      public final String localProfileId()

      A unique identifier for the AS2 local profile.

      Returns:
      A unique identifier for the AS2 local profile.

    • partnerProfileId

      public final String partnerProfileId()

      A unique identifier for the partner profile for the connector.

      Returns:
      A unique identifier for the partner profile for the connector.

    • messageSubject

      public final String messageSubject()

      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.

    • compression

      public final CompressionEnum compression()

      Specifies whether the AS2 file is compressed.

      If the service returns an enum value that is not available in the current SDK version, compression will return CompressionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionAsString().

      Returns:
      Specifies whether the AS2 file is compressed.
      See Also:

    • compressionAsString

      public final String compressionAsString()

      Specifies whether the AS2 file is compressed.

      If the service returns an enum value that is not available in the current SDK version, compression will return CompressionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionAsString().

      Returns:
      Specifies whether the AS2 file is compressed.
      See Also:

    • encryptionAlgorithm

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, encryptionAlgorithm will return EncryptionAlg.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionAlgorithmAsString().

      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:

    • encryptionAlgorithmAsString

      public final String encryptionAlgorithmAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, encryptionAlgorithm will return EncryptionAlg.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionAlgorithmAsString().

      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:

    • signingAlgorithm

      public final SigningAlg signingAlgorithm()

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

      If the service returns an enum value that is not available in the current SDK version, signingAlgorithm will return SigningAlg.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingAlgorithmAsString().

      Returns:
      The algorithm that is used to sign the AS2 messages sent with the connector.
      See Also:

    • signingAlgorithmAsString

      public final String signingAlgorithmAsString()

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

      If the service returns an enum value that is not available in the current SDK version, signingAlgorithm will return SigningAlg.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signingAlgorithmAsString().

      Returns:
      The algorithm that is used to sign the AS2 messages sent with the connector.
      See Also:

    • mdnSigningAlgorithm

      public final MdnSigningAlg mdnSigningAlgorithm()

      The signing algorithm for the MDN response.

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

      If the service returns an enum value that is not available in the current SDK version, mdnSigningAlgorithm will return MdnSigningAlg.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mdnSigningAlgorithmAsString().

      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:

    • mdnSigningAlgorithmAsString

      public final String mdnSigningAlgorithmAsString()

      The signing algorithm for the MDN response.

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

      If the service returns an enum value that is not available in the current SDK version, mdnSigningAlgorithm will return MdnSigningAlg.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mdnSigningAlgorithmAsString().

      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:

    • mdnResponse

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, mdnResponse will return MdnResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mdnResponseAsString().

      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:

    • mdnResponseAsString

      public final String mdnResponseAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, mdnResponse will return MdnResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mdnResponseAsString().

      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:

    • basicAuthSecretId

      public final 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=""'

      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=""'

    • toBuilder

      public As2ConnectorConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<As2ConnectorConfig.Builder,As2ConnectorConfig>
      Returns:
      a builder for type T

    • builder

      public static As2ConnectorConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends As2ConnectorConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.