com.amazonaws.services.sns.message

Class SnsSubscriptionConfirmation

java.lang.Object

com.amazonaws.services.sns.message.SnsMessage

com.amazonaws.services.sns.message.SnsSubscriptionConfirmation

public final class SnsSubscriptionConfirmation
extends SnsMessage

After you subscribe an HTTP/HTTPS endpoint, Amazon SNS sends a subscription confirmation message to the HTTP/HTTPS endpoint. This message contains a SubscribeURL value that you must visit to confirm the subscription (alternatively, you can use the Token value with the ConfirmSubscription). Note that Amazon SNS will not send notifications to this endpoint until the subscription is confirmed. Use the confirmSubscription() method to visit the confirmation URL via this object.

Method Summary

Modifier and Type	Method and Description
ConfirmSubscriptionResult	confirmSubscription() Will attempt to confirm the subscription by visiting the URL at getSubscribeUrl().
String	getMessage()
URL	getSubscribeUrl()
String	getToken()
void	handle(SnsMessageHandler handler) Calls the appropriate 'handle' method on SnsMessageHandler depending on the subtype.

Methods inherited from class com.amazonaws.services.sns.message.SnsMessage

getMessageId, getTimestamp, getTopicArn

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public String getMessage()

Returns:

A string that describes the message. For subscription confirmation, this string looks like this: You have chosen to subscribe to the topic arn:aws:sns:us-east-1:123456789012:MyTopic.\nTo confirm the subscription, visit the SubscribeURL included in this message.

getSubscribeUrl

public URL getSubscribeUrl()

Returns:

The URL that you must visit in order to confirm the subscription. Alternatively, you can instead use the Token with the AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest) action to confirm the subscription.

getToken

public String getToken()

Returns:

A value you can use with the AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest) action to confirm the subscription. Alternatively, you can simply visit the SubscribeURL.

handle

public void handle(SnsMessageHandler handler)

Description copied from class: SnsMessage

Calls the appropriate 'handle' method on SnsMessageHandler depending on the subtype.

Specified by:

handle in class SnsMessage

Parameters:

handler - Handler to deliver message to.

confirmSubscription

public ConfirmSubscriptionResult confirmSubscription()
                                              throws SdkClientException

Will attempt to confirm the subscription by visiting the URL at getSubscribeUrl().

Returns:

ConfirmSubscriptionResult if confirmation was successful.

Throws:

SdkClientException - if confirmation could not be confirmed.