Package com.salesforce.multicloudj.pubsub.ali

Class AliSubscription

java.lang.Object

com.salesforce.multicloudj.pubsub.driver.AbstractSubscription<AliSubscription>

com.salesforce.multicloudj.pubsub.ali.AliSubscription

All Implemented Interfaces:

Provider, SdkService, AutoCloseable

@AutoService(AbstractSubscription.class)
public class AliSubscription
extends AbstractSubscription<AliSubscription>

Alibaba SMQ (MNS) subscription.

Receives messages from an SMQ queue via batchPopMessage, acknowledges them via batchDeleteMessage, and nacks them via changeMessageVisibility. Receipt handles are modelled as AliSubscription.AliAckID. Registered under the ali provider id.

Of RetryConfig, only attemptTimeout is applied, as the SMQ client's connection and socket timeouts. maxAttempts, mode, the delay fields, multiplier and totalTimeout are ignored because the SMQ SDK cannot honor them; see SmqClientFactory.buildClientConfiguration(java.net.URI, com.salesforce.multicloudj.common.retries.RetryConfig).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AliSubscription.AliAckID	SMQ receipt-handle-backed AckID.
static class	AliSubscription.Builder	Builder for AliSubscription.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_ID

Fields inherited from class com.salesforce.multicloudj.pubsub.driver.AbstractSubscription

credentialsOverrider, endpoint, isShutdown, nackVisibilityTimeout, permanentError, providerId, proxyEndpoint, region, retryConfig, subscriptionName, unreportedAckErr

Constructor Summary

Constructors

Constructor	Description
AliSubscription()

Method Summary

Modifier and Type	Method	Description
AliSubscription.Builder	builder()	Creates and returns a new Builder instance for this provider.
boolean	canNack()
void	close()	Implements AutoCloseable interface for try-with-resources support.
protected Batcher.Options	createAckBatcherOptions()
protected Batcher.Options	createReceiveBatcherOptions()	Creates batcher options for this subscription.
protected List<Message>	doReceiveBatch(int batchSize)	Provider specific implementation must fetch at most batchSize messages from the remote service.
protected void	doSendAcks(List<AckID> ackIDs)
protected void	doSendNacks(List<AckInfo> nacks)	Sends negative acknowledgments for a batch of messages.
GetAttributeResult	getAttributes()
String	getProviderId()	Retrieves the unique identifier for this service implementation.
boolean	isRetryable(Throwable error)
SubstrateSdkException	mapException(Throwable t)	Maps a provider-specific Throwable to a fully-built SubstrateSdkException the caller can throw directly.

Methods inherited from class com.salesforce.multicloudj.pubsub.driver.AbstractSubscription

getNackVisibilityTimeout, receive, sendAck, sendAcks, sendNack, sendNack, sendNacks, sendNacks

Methods inherited from class java.lang.Object

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

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

Constructor Details

AliSubscription

public AliSubscription()

Method Details

getProviderId

public String getProviderId()

Description copied from interface: SdkService

Retrieves the unique identifier for this service implementation.

Specified by:

getProviderId in interface SdkService

Overrides:

getProviderId in class AbstractSubscription<AliSubscription>

Returns:

A String representing the provider's ID such as aws.

doReceiveBatch

protected List<Message> doReceiveBatch(int batchSize)

Description copied from class: AbstractSubscription

Provider specific implementation must fetch at most batchSize messages from the remote service.

Specified by:

doReceiveBatch in class AbstractSubscription<AliSubscription>

doSendAcks

protected void doSendAcks(List<AckID> ackIDs)

Specified by:

doSendAcks in class AbstractSubscription<AliSubscription>

doSendNacks

protected void doSendNacks(List<AckInfo> nacks)

Description copied from class: AbstractSubscription

Sends negative acknowledgments for a batch of messages. Each AckInfo may carry an optional per-message visibility timeout; when null, implementations should fall back to AbstractSubscription.getNackVisibilityTimeout(). All entries passed here have isAck() == false.

Specified by:

doSendNacks in class AbstractSubscription<AliSubscription>

createReceiveBatcherOptions

protected Batcher.Options createReceiveBatcherOptions()

Description copied from class: AbstractSubscription

Creates batcher options for this subscription. Provides defaults that cloud providers can override to provide provider-specific batching configuration that aligns with their service limits and performance characteristics.

Overrides:

createReceiveBatcherOptions in class AbstractSubscription<AliSubscription>

createAckBatcherOptions

protected Batcher.Options createAckBatcherOptions()

Specified by:

createAckBatcherOptions in class AbstractSubscription<AliSubscription>

canNack

public boolean canNack()

Specified by:

canNack in class AbstractSubscription<AliSubscription>

isRetryable

public boolean isRetryable(Throwable error)

Specified by:

isRetryable in class AbstractSubscription<AliSubscription>

getAttributes

public GetAttributeResult getAttributes()

Specified by:

getAttributes in class AbstractSubscription<AliSubscription>

mapException

public SubstrateSdkException mapException(Throwable t)

Description copied from interface: SdkService

Maps a provider-specific Throwable to a fully-built SubstrateSdkException the caller can throw directly. The returned exception carries both the typed mapping (e.g. ResourceNotFoundException for HTTP 404) and an authoritative retryable flag derived from the native cloud SDK signal (e.g. AWS throttling, GCP ApiException.isRetryable(), status codes), or the type's default retryability when the SDK exposes no native signal.

Callers throw the result; they do not inspect or transform it further:

 try {
   ...
 } catch (Throwable t) {
   throw provider.mapException(t);
 }
 

Implementation contract: implementations should compute a typed exception class (typically via their per-service ErrorCodeMapping) and a retryable hint, then return ExceptionHandler.build(exceptionClass, t, retryableHint). Implementations do not need to short-circuit when t is already a SubstrateSdkException: ExceptionHandler.build preserves an already-mapped exception's concrete subtype and retryable flag.

Parameters:

t - the original throwable from the provider SDK

Returns:

a built SubstrateSdkException ready to throw

close

public void close()
           throws Exception

Description copied from class: AbstractSubscription

Implements AutoCloseable interface for try-with-resources support.

Shuts down the subscription and releases all resources.

This method should: - Flush any pending acknowledgments or nacks - Close network connections - Release any other provider-specific resources

After calling this method, the subscription should not accept new operations. It is safe to call this method multiple times.

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractSubscription<AliSubscription>

Throws:

Exception

builder

public AliSubscription.Builder builder()

Description copied from interface: Provider

Creates and returns a new Builder instance for this provider.

Returns:

A Builder instance for constructing this provider.