SNSReceiverService

java.lang.Object

org.deltava.service.WebService

org.deltava.service.aws.SNSReceiverService

Direct Known Subclasses:: SESDeliveryService, SESFeedbackService

abstract class SNSReceiverService extends WebService

A Web Service to receive Amazon SNS messages.

Since:: 8.5
Version:: 11.1
Author:: Luke

Constructor Summary

Constructors

Constructor

Description

SNSReceiverService()
Method Summary

Modifier and Type

Method

Description

protected static boolean

confirm(SNSPayload sns)

Confirms an SNS subscription.

protected abstract int

execute(SNSContext ctx)

Processes the SNS payload.

final int

execute(ServiceContext ctx)

Executes the Web Service.

protected static void

validate(SNSPayload sns)

Validates an SNS message.

Methods inherited from class org.deltava.service.WebService
error, error, error, getCount, isLogged, isSecure

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SNSReceiverService
  
  SNSReceiverService()
Method Details
- validate
  
  protected static void validate(SNSPayload sns) throws ServiceException
  
  Validates an SNS message.
  
  Parameters:
  
  sns - an SNSPayload
  
  Throws:
  
  ServiceException - the payload fails validation
- confirm
  
  protected static boolean confirm(SNSPayload sns) throws ServiceException
  
  Confirms an SNS subscription.
  
  Parameters:
  
  sns - the SNS payload
  
  Returns:
  
  TRUE if successfully confirmed, otherwise FALSE
  
  Throws:
  
  ServiceException - if an error occurs
- execute
  
  public final int execute(ServiceContext ctx) throws ServiceException
  
  Executes the Web Service.
  
  Specified by:
  
  execute in class WebService
  
  Parameters:
  
  ctx - the Web Service context
  
  Returns:
  
  200 Always
  
  Throws:
  
  ServiceException - if an error occurs
- execute
  
  protected abstract int execute(SNSContext ctx) throws ServiceException
  
  Processes the SNS payload.
  
  Parameters:
  
  ctx - the SNSContext
  
  Returns:
  
  an HTTP status code
  
  Throws:
  
  ServiceException - if an error occurs