com.bea.campaign.servlets
Class CampaignCleanupServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--com.bea.campaign.servlets.CampaignCleanupServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class CampaignCleanupServlet

extends HttpServlet

A servlet which can handle cleaning up campaigns.

This supports the following servlet parameters:

• campaignId: the id/uri of the campaign.
• cleanup: this multi-valued parameter can one or more of the following values:
  • all - do all cleanup
  • endStates - cleanup end states
  • adBuckets - cleanup ad buckets
  • adCounts - cleanup ad counts
  • mailBatches - cleanup mail batches

It alse expects the following ejb-refs:

• java:comp/env/ejb/CampaignService
• java:comp/env/ejb/AdBucketService (optional)
• java:comp/env/ejb/AdService (optional)
• java:comp/env/ejb/MailService (optional)

If all the request cleanups succeed, a OK (200) status code will be returned. If one or more failed, a INTERNAL_ERROR (500) status code will be returned, plus the header 'BEA-CAMPAIGN-Cleanup-Failures' will be set to the comma-separate list of cleanUp values that failed.

See Also:

Serialized Form

Field Summary

protected static int	CLEANUP_AD_BUCKETS Mask signifying ad bucket cleanup.
protected static int	CLEANUP_AD_COUNTS Mask signifying ad count cleanup.
protected static int	CLEANUP_ALL Mask signifying all cleanup.
protected static int	CLEANUP_END_STATES Mask signifying end state cleanup.
protected static int	CLEANUP_MAIL_BATCHES Mask signifying mail batches cleanup.
static String	FAILED_REFRESH
static String	REFRESH_STATUS
static String	SUCCESSFUL_REFRESH

Constructor Summary

CampaignCleanupServlet()

Method Summary

protected void	cleanupAdBuckets(String campaignId) Cleanup a campaign's ad buckets.
protected void	cleanupAdCounts(String campaignId) Cleanup a campaign's ad count.
protected void	cleanupEndStates(String campaignId) Cleanup a campaign's end states.
protected void	cleanupMailBatches(String campaignId) Cleanup a campaign's mail batches.
void	doGet(HttpServletRequest req, HttpServletResponse resp) Service a request.
void	doPost(HttpServletRequest req, HttpServletResponse resp) Service a request.
protected AdBucketService	getAdBucketService() Get our java:comp/env/ejb/AdBucketService.
protected AdService	getAdService() Get our java:comp/env/ejb/AdService.
protected CampaignService	getCampaignService() Get our java:comp/env/ejb/CampaignService.
protected MailService	getMailService() Get our java:comp/env/ejb/MailService.
protected int	handleCleanup(String campaignId, int options) Handle the request cleanup options.
void	init() Initialize this servlet.
protected void	resetCampaign(String campaignId) Reset a campaign's internal state.
protected void	sendError(HttpServletResponse resp, int status, String mesg) Send an error message.
protected static String	toHTML(String in) Convert a string to html.

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

Field Detail

CLEANUP_END_STATES

protected static final int CLEANUP_END_STATES

Mask signifying end state cleanup.

See Also:

Constant Field Values

CLEANUP_AD_BUCKETS

protected static final int CLEANUP_AD_BUCKETS

Mask signifying ad bucket cleanup.

See Also:

Constant Field Values

CLEANUP_AD_COUNTS

protected static final int CLEANUP_AD_COUNTS

Mask signifying ad count cleanup.

See Also:

Constant Field Values

CLEANUP_MAIL_BATCHES

protected static final int CLEANUP_MAIL_BATCHES

Mask signifying mail batches cleanup.

See Also:

Constant Field Values

CLEANUP_ALL

protected static final int CLEANUP_ALL

Mask signifying all cleanup.

See Also:

Constant Field Values

SUCCESSFUL_REFRESH

public static final String SUCCESSFUL_REFRESH

See Also:

Constant Field Values

FAILED_REFRESH

public static final String FAILED_REFRESH

See Also:

Constant Field Values

REFRESH_STATUS

public static final String REFRESH_STATUS

See Also:

Constant Field Values

Constructor Detail

CampaignCleanupServlet

public CampaignCleanupServlet()

Method Detail

init

public void init()
          throws ServletException

Initialize this servlet.

This will initialize the various services.

Overrides:

init in class GenericServlet

ServletException

See Also:

getCampaignService(), getAdBucketService(), getAdService(), getMailService()

doGet

public void doGet(HttpServletRequest req,
                  HttpServletResponse resp)
           throws ServletException,
                  IOException

Service a request.

Overrides:

doGet in class HttpServlet

ServletException

IOException

doPost

public void doPost(HttpServletRequest req,
                   HttpServletResponse resp)
            throws ServletException,
                   IOException

Service a request.

Overrides:

doPost in class HttpServlet

ServletException

IOException

See Also:

doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

handleCleanup

protected int handleCleanup(String campaignId,
                            int options)

Handle the request cleanup options.

Returns:

the bit-ORed list of options that failed.

resetCampaign

protected void resetCampaign(String campaignId)
                      throws CreateException,
                             EJBException,
                             RemoteException

Reset a campaign's internal state.

CreateException

EJBException

RemoteException

See Also:

CampaignService.resetCampaign(java.lang.String)

cleanupEndStates

protected void cleanupEndStates(String campaignId)
                         throws CreateException,
                                EJBException,
                                RemoteException

Cleanup a campaign's end states.

CreateException

EJBException

RemoteException

See Also:

CampaignService.clearEndStates(java.lang.String)

cleanupAdBuckets

protected void cleanupAdBuckets(String campaignId)
                         throws CreateException,
                                EJBException,
                                RemoteException,
                                ContentException

Cleanup a campaign's ad buckets.

CreateException

EJBException

RemoteException

ContentException

See Also:

AdBucketService.cleanupAdBucket(java.lang.String)

cleanupAdCounts

protected void cleanupAdCounts(String campaignId)
                        throws CreateException,
                               EJBException,
                               RemoteException,
                               ContentException

Cleanup a campaign's ad count.

CreateException

EJBException

RemoteException

ContentException

See Also:

AdService.cleanupAdService(java.lang.String)

cleanupMailBatches

protected void cleanupMailBatches(String campaignId)
                           throws CreateException,
                                  EJBException,
                                  RemoteException,
                                  MailServiceException

Cleanup a campaign's mail batches.

CreateException

EJBException

RemoteException

MailServiceException

See Also:

MailService.deleteBatch(java.lang.String)

sendError

protected void sendError(HttpServletResponse resp,
                         int status,
                         String mesg)
                  throws ServletException,
                         IOException

Send an error message.

ServletException

IOException

getAdService

protected AdService getAdService()
                          throws CreateException,
                                 RemoteException

Get our java:comp/env/ejb/AdService.

This will use the ejb-ref if getCampaignService().getAdService() fails.

CreateException

RemoteException

getAdBucketService

protected AdBucketService getAdBucketService()
                                      throws CreateException,
                                             RemoteException

Get our java:comp/env/ejb/AdBucketService.

This will use the ejb-ref if getCampaignService().getAdBucketService() fails.

CreateException

RemoteException

getCampaignService

protected CampaignService getCampaignService()
                                      throws CreateException,
                                             RemoteException

Get our java:comp/env/ejb/CampaignService.

CreateException

RemoteException

getMailService

protected MailService getMailService()
                              throws CreateException,
                                     RemoteException

Get our java:comp/env/ejb/MailService.

This will use the ejb-ref if getCampaignService().getMailService() fails.

CreateException

RemoteException

toHTML

protected static String toHTML(String in)

Convert a string to html.

See Also:

AdHelper.toHTML(java.lang.String)