|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xerox.amazonws.sns.NotificationService
public class NotificationService
This class provides an interface with the Amazon Simple Notification Service.
Constructor Summary | |
---|---|
NotificationService(String awsAccessId,
String awsSecretKey)
Initializes the Simple Notification service with your AWS login information. |
|
NotificationService(String awsAccessId,
String awsSecretKey,
boolean isSecure)
Initializes the Simple Notification service with your AWS login information. |
|
NotificationService(String awsAccessId,
String awsSecretKey,
boolean isSecure,
String server)
Initializes the Simple Notification service with your AWS login information. |
|
NotificationService(String awsAccessId,
String awsSecretKey,
boolean isSecure,
String server,
int port)
Initializes the Simple Notification service with your AWS login information. |
Method Summary | ||
---|---|---|
void |
addPermission(String topicArn,
String label,
List<String> accountIds,
List<String> actionNames)
Adds to the topic's access control policy. |
|
Result<String> |
confirmSubscription(String topicArn,
String token,
boolean authenticateOnUnsubscribe)
Verifies an endpoint intends to receive messages |
|
Result<String> |
createTopic(String name)
Creates a topic |
|
void |
deleteTopic(String topicArn)
Deletes a topic |
|
AWSQueryConnection |
getConnectionDelegate()
Returns connection object, so connection params can be tweaked |
|
Map<String,String> |
getTopicAttributes(String topicArn)
Gets attributes for the topic |
|
ListResult<SubscriptionInfo> |
listSubscriptions(String nextToken)
Lists the subscriptions |
|
ListResult<SubscriptionInfo> |
listSubscriptionsByTopic(String topicArn,
String nextToken)
Lists subscriptions for a topic |
|
ListResult<String> |
listTopics(String nextToken)
Lists topics for this account |
|
protected
|
makeRequestInt(org.apache.http.client.methods.HttpRequestBase method,
String action,
Map<String,String> params,
Class<T> respType)
|
|
Result<String> |
publish(String topicArn,
String message,
String subject)
Publishes a message to a topic's subscribed endpoints |
|
void |
removePermission(String topicArn,
String label)
Removes permissions from a topic |
|
void |
setTopicAttributes(String topicArn,
String name,
String value)
Set a topic attribute. |
|
Result<String> |
subscribe(String topicArn,
String protocol,
String endpoint)
Subscribe this account to a topic |
|
void |
unsubscribe(String subscriptionArn)
Unsubscribe this account from a topic |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NotificationService(String awsAccessId, String awsSecretKey)
awsAccessId
- The your user key into AWSawsSecretKey
- The secret string used to generate signatures for authentication.public NotificationService(String awsAccessId, String awsSecretKey, boolean isSecure)
awsAccessId
- The your user key into AWSawsSecretKey
- The secret string used to generate signatures for authentication.isSecure
- True if the data should be encrypted on the wire on the way to or from LS.public NotificationService(String awsAccessId, String awsSecretKey, boolean isSecure, String server)
awsAccessId
- The your user key into AWSawsSecretKey
- The secret string used to generate signatures for authentication.isSecure
- True if the data should be encrypted on the wire on the way to or from LS.server
- Which host to connect to. Usually, this will be sns.amazonaws.compublic NotificationService(String awsAccessId, String awsSecretKey, boolean isSecure, String server, int port)
awsAccessId
- The your user key into AWSawsSecretKey
- The secret string used to generate signatures for authentication.isSecure
- True if the data should be encrypted on the wire on the way to or from LS.server
- Which host to connect to. Usually, this will be sns.amazonaws.comport
- Which port to use.Method Detail |
---|
public AWSQueryConnection getConnectionDelegate()
public void addPermission(String topicArn, String label, List<String> accountIds, List<String> actionNames) throws SNSException
topicArn
- the ARN for the topiclabel
- the unique identifier for the new policy statementaccountIds
- users being given accessactionNames
- actions you are allowing
SNSException
- wraps checked exceptionspublic Result<String> confirmSubscription(String topicArn, String token, boolean authenticateOnUnsubscribe) throws SNSException
topicArn
- the ARN for the topictoken
- subscription tokenauthenticateOnUnsubscribe
- requires authenticated unsubscribe from the topic
SNSException
- wraps checked exceptionspublic Result<String> createTopic(String name) throws SNSException
name
- name of the new topic
SNSException
- wraps checked exceptionspublic void deleteTopic(String topicArn) throws SNSException
topicArn
- the ARN for the topic
SNSException
- wraps checked exceptionspublic Map<String,String> getTopicAttributes(String topicArn) throws SNSException
topicArn
- the ARN for the topic
SNSException
- wraps checked exceptionspublic ListResult<SubscriptionInfo> listSubscriptions(String nextToken) throws SNSException
nextToken
- the user token
SNSException
- wraps checked exceptionspublic ListResult<SubscriptionInfo> listSubscriptionsByTopic(String topicArn, String nextToken) throws SNSException
nextToken
- the user token
SNSException
- wraps checked exceptionspublic ListResult<String> listTopics(String nextToken) throws SNSException
nextToken
- the user token
SNSException
- wraps checked exceptionspublic Result<String> publish(String topicArn, String message, String subject) throws SNSException
topicArn
- the ARN for the topicmessage
- the message to be sentsubject
- the optional subject for the message
SNSException
- wraps checked exceptionspublic void removePermission(String topicArn, String label) throws SNSException
topicArn
- the ARN for the topiclabel
- the label for the permission statement
SNSException
- wraps checked exceptionspublic void setTopicAttributes(String topicArn, String name, String value) throws SNSException
topicArn
- the ARN for the topicname
- name of the attributevalue
- value of the attribute
SNSException
- wraps checked exceptionspublic Result<String> subscribe(String topicArn, String protocol, String endpoint) throws SNSException
topicArn
- the ARN for the topic
SNSException
- wraps checked exceptionspublic void unsubscribe(String subscriptionArn) throws SNSException
topicArn
- the ARN for the topic
SNSException
- wraps checked exceptionsprotected <T> T makeRequestInt(org.apache.http.client.methods.HttpRequestBase method, String action, Map<String,String> params, Class<T> respType) throws SNSException
SNSException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |