net.rim.pushsdk.subscription.web
Class SuspendServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          net.rim.pushsdk.subscription.web.SubscriptionServlet
              net.rim.pushsdk.subscription.web.SuspendServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SuspendServlet
extends SubscriptionServlet

Servlet responsible for handling a suspend subscription operation.

The following HTTP request parameters are needed for a suspend: appid.
If not using container-managed authentication, the following two HTTP request parameters will also be needed: username, and password.

The following return codes can come back from this servlet: SUCCESS, INVALID_PUSH_APPLICATION, INVALID_SUBSCRIBER_ID, SUBSCRIBER_NOT_FOUND, CANNOT_SUSPEND_SINCE_UNSUBSCRIBED, INVALID_USERNAME, INVALID_PASSWORD, SUBSCRIPTION_NOT_SUPPORTED, SUBSCRIBER_AUTHENTICATION_FAILED, CONTENT_PROVIDER_SUBSCRIPTION_FAILED , SYSTEM_ERROR

Author:

mdandrea

See Also:

Serialized Form

Field Summary

Fields inherited from class net.rim.pushsdk.subscription.web.SubscriptionServlet

CACHE_CONTROL, contentProviderAuthenticationService, NO_CACHE, PRAGMA, SUBSCRIBER_USERNAME, subscriptionRequestParser, subscriptionService

Constructor Summary

SuspendServlet()

Method Summary
BaseRequest	getRequest(javax.servlet.http.HttpServletRequest req) Returns the subscription operation details parsed out of the HTTP request.
SubscriptionType	getSubscriptionType() Returns the type of subscription operation being performed.
void	performSubscriptionOperation(BaseRequest baseRequest, javax.servlet.http.HttpServletResponse resp) Suspends a user's subscription to a push application.

Methods inherited from class net.rim.pushsdk.subscription.web.SubscriptionServlet

addAuthenticationCredentials, authenticateSubscriber, authenticateSubscriber, checkEncoding, doGet, doPost, getAuthenticationRequest, init, setContentProviderAuthenticationService, setResponse, setSubscriptionRequestParser, setSubscriptionService

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

SuspendServlet

public SuspendServlet()

Method Detail

performSubscriptionOperation

public void performSubscriptionOperation(BaseRequest baseRequest,
                                         javax.servlet.http.HttpServletResponse resp)
                                  throws IOException

Suspends a user's subscription to a push application.

Specified by:

performSubscriptionOperation in class SubscriptionServlet

Parameters:

baseRequest - the suspend request details

resp - the HTTP response

Throws:

IOException - if any IO errors occurred

getRequest

public BaseRequest getRequest(javax.servlet.http.HttpServletRequest req)

Description copied from class: SubscriptionServlet

Returns the subscription operation details parsed out of the HTTP request.

Specified by:

getRequest in class SubscriptionServlet

Parameters:

req - the HTTP request

Returns:

the subscription operation request details

getSubscriptionType

public SubscriptionType getSubscriptionType()

Description copied from class: SubscriptionServlet

Returns the type of subscription operation being performed.

Specified by:

getSubscriptionType in class SubscriptionServlet

Returns:

the subscription type