com.dpslink.flash.servlet.admin

Class AdmVerifySiteImages

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.base.servlet.BaseServlet

com.dpslink.flash.servlet.FlashServlet

com.dpslink.flash.servlet.MainServlet

com.dpslink.flash.servlet.admin.AdmVerifySiteImages

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class AdmVerifySiteImages
extends MainServlet

Writes and processes the admin verify site images page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdmVerifySiteImages.Context Inner class used to store servlet context information.
class	AdmVerifySiteImages.Verified Inner class that defines a verified image for the verified list.

Nested classes/interfaces inherited from class com.dpslink.flash.servlet.FlashServlet

FlashServlet.Stack

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	JQUERY_PATH The file path where jquery components are located.
private static long	serialVersionUID The class' serialization version id.
protected static java.lang.String	SN_EXISTING_LIST The session's key for the current list of existing images.
protected static java.lang.String	SN_MISSING_LIST The session's key for the current list of missing images.

Fields inherited from class com.dpslink.flash.servlet.MainServlet

DISPLAY_MODE, SN_ADMINMODE, SN_CATEGORIES, SN_CATEGORIES_LISTONLY, SN_CATEGORIES_PATH, SN_CATEGORY, SN_CONTINUE_PAGEURL, SN_PRODUCTS, SN_PRODUCTS_INSTOCK, SN_PRODUCTS_NOSTOCK, SN_PRODUCTS_PAFILTERS, SN_PRODUCTS_PAGEHIST, SN_PRODUCTS_PAGENUM, SN_PRODUCTS_PAGEURL, SOURCE_CATALOG, SOURCE_FAVORITES, SOURCE_SEARCH, SOURCE_SHOPCART, SOURCE_SPECIAL

Fields inherited from class com.dpslink.flash.servlet.FlashServlet

SN_CART, SN_LOGON_STATUS, SN_SECPROFILE, SN_USER, SN_USERSFI

Fields inherited from class com.dpslink.base.servlet.BaseServlet

BROWSER_IE, BROWSER_NN, BROWSER_XX, RESP_NULL, RESP_REDIRECTED, RQST_AJAX, RQST_NULL

Constructor Summary

Constructors

Constructor and Description
AdmVerifySiteImages()

Method Summary

Modifier and Type	Method and Description
protected MainServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected boolean	doTypeRequest(AdmVerifySiteImages.Context ctx) Determines if an info type request has been made and, if so, redirects so the type is included in a new servlet request's parameters.
protected boolean	editFormFields(BaseServlet.Context baseCtx) Edits the values from the html template's form fields.
protected java.lang.String	getNextURL(BaseServlet.Context baseCtx) Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.).
protected java.lang.String	getRelativePath(AdmVerifySiteImages.Context ctx, java.io.File file) Returns a file's relative path per the current root being processed.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
protected boolean	isJQueryImages(java.lang.String filepath) Answers if a file path is for a query images folder.
protected boolean	isProductImages(java.lang.String filepath) Answers if a file path is for a product images folder.
protected void	parseFile(AdmVerifySiteImages.Context ctx, java.io.File file) Parses a file's references to images and determines if the references are to existing or missing images.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
protected void	recurseFiles(AdmVerifySiteImages.Context ctx, java.io.File file) Recurses through the site's email templates, html templates, script files and style sheet files and detemines missing, referenced and unreferenced images.
protected void	recurseImages(AdmVerifySiteImages.Context ctx, java.io.File file) Recurses through the site's images and stores a set of existing images.
protected void	recurseProperties(AdmVerifySiteImages.Context ctx, java.io.File file) Recurses through the site's properties files and detemines missing, referenced and unreferenced images.
protected void	resetFormFields(BaseServlet.Context baseCtx) Resets the values for the html template's form fields.
protected void	setCookieValues(BaseServlet.Context baseCtx) Adds one or more values to the http session cookies.
protected void	setSessionValues(BaseServlet.Context baseCtx) Adds one or more values to the http session object.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
protected java.lang.String	subtractRoot(AdmVerifySiteImages.Context ctx, java.io.File file) Substracts (removes) the path for the current root being processed from a file's path.
protected boolean	verifyImages(AdmVerifySiteImages.Context ctx) Verifies the site images and determines which images are missing, which images are referenced and which images are unreferenced.

Methods inherited from class com.dpslink.flash.servlet.MainServlet

confirmSession, getPreviousCategoryList, getPreviousCategoryPath, hasSubcategories, hasSubcategories, isOmitNoStock, isPreshopRequest, isUserHelpRequest, setTemplateCategoryPath, sortCategoryProductData, writePageImpl

Methods inherited from class com.dpslink.flash.servlet.FlashServlet

confirmCart, confirmRequest, confirmRetail, confirmWholesale, createNewCart, createNewSessionImpl, getPageTitle, getServletPath, getUser, initTemplateDataImpl, isLogonRequest, requestComplete, requiresLogon, resetCart, resetCategories, resetProducts, setDefaultUser, setSessionCart, setSFIShoppingUser, useExistingSessionImpl, writeCookie

Methods inherited from class com.dpslink.base.servlet.BaseServlet

createNewSession, determineBrowser, doGet, doPost, getCookie, getInvokerName, getInvokerName, getInvokerParams, getInvokerParams, getInvokerPath, getInvokerPath, getInvokerURL, getPageParams, getRequestURL, getServletName, getServletName, getServletParams, getServletParams, getServletPath, getServletURL, getServletURL, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, initTemplateData, isPrintable, isServerTomcat, log, qualifyURL, redirectURL, setP3PCompactPolicy, showSiteError, showSiteError, showSiteError, useExistingSession, writeCookie, writeTempCookie

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, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

SN_EXISTING_LIST

protected static final java.lang.String SN_EXISTING_LIST

The session's key for the current list of existing images.

See Also:

Constant Field Values

SN_MISSING_LIST

protected static final java.lang.String SN_MISSING_LIST

The session's key for the current list of missing images.

See Also:

Constant Field Values

JQUERY_PATH

protected static final java.lang.String JQUERY_PATH

The file path where jquery components are located.

Constructor Detail

AdmVerifySiteImages

public AdmVerifySiteImages()

Method Detail

editFormFields

protected boolean editFormFields(BaseServlet.Context baseCtx)

Edits the values from the html template's form fields. Invoked by the doPost method. Overrides editFormFields in BaseServlet.

Specified by:

editFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if all the edits are successful, otherwise false.

getNextURL

protected java.lang.String getNextURL(BaseServlet.Context baseCtx)

Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.). Invoked by the writeURL method. Overrides getNextURL in BaseServlet.

Specified by:

getNextURL in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The URL.

getTemplateName

protected java.lang.String getTemplateName(BaseServlet.Context baseCtx)

Returns the name of the html template file used by the servlet. Invoked by the writePage method. Overrides getTemplateName in BaseServlet.

Specified by:

getTemplateName in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The html template's name.

readParameters

protected void readParameters(BaseServlet.Context baseCtx,
                              boolean post)

Reads the parameters passed to the servlet via the http request object. Invoked by the doGet and doPost method. Overrides readParameters in BaseServlet.

Specified by:

readParameters in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

post - (boolean) true if the method is invoked from doPost, otherwise false.

resetFormFields

protected void resetFormFields(BaseServlet.Context baseCtx)

Resets the values for the html template's form fields. Invoked by the doGet and doPost methods. Overrides resetFormFields in BaseServlet.

Specified by:

resetFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setCookieValues

protected void setCookieValues(BaseServlet.Context baseCtx)
                        throws java.io.IOException

Adds one or more values to the http session cookies. Invoked by the writeURL method. Calls should be made to writeCookie for each cookie that needs to be set. Overrides setCookieValues in BaseServlet.

Specified by:

setCookieValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

setSessionValues

protected void setSessionValues(BaseServlet.Context baseCtx)

Adds one or more values to the http session object. Invoked by the writeURL method. Overrides setSessionValues in BaseServlet.

Specified by:

setSessionValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateData

protected void setTemplateData(BaseServlet.Context baseCtx)

Sets the various data required by the html template. Invoked by the writePage method. Overrides setTemplateData in BaseServlet.

Specified by:

setTemplateData in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

doTypeRequest

protected boolean doTypeRequest(AdmVerifySiteImages.Context ctx)

Determines if an info type request has been made and, if so, redirects so the type is included in a new servlet request's parameters. Doing this is necessary so the browser back button will display the proper page.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if this is a type request and a redirect has been invoked, otherwise false.

verifyImages

protected boolean verifyImages(AdmVerifySiteImages.Context ctx)

Verifies the site images and determines which images are missing, which images are referenced and which images are unreferenced.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the verifcation is successful, otherwise false.

recurseImages

protected void recurseImages(AdmVerifySiteImages.Context ctx,
                             java.io.File file)
                      throws java.lang.Exception

Recurses through the site's images and stores a set of existing images.

Parameters:

ctx - (Context) The current servlet context.

file - (File) A File object for the file or folder to be processed. throws Exception - if an error occurs during processing.

Throws:

java.lang.Exception

recurseFiles

protected void recurseFiles(AdmVerifySiteImages.Context ctx,
                            java.io.File file)
                     throws java.lang.Exception

Recurses through the site's email templates, html templates, script files and style sheet files and detemines missing, referenced and unreferenced images.

Parameters:

ctx - (Context) The current servlet context.

file - (File) A File object for the file or folder to be processed. throws Exception - if an error occurs during processing.

Throws:

java.lang.Exception

recurseProperties

protected void recurseProperties(AdmVerifySiteImages.Context ctx,
                                 java.io.File file)
                          throws java.lang.Exception

Recurses through the site's properties files and detemines missing, referenced and unreferenced images.

Parameters:

ctx - (Context) The current servlet context.

file - (File) A File object for the file or folder to be processed. throws Exception - if an error occurs during processing.

Throws:

java.lang.Exception

parseFile

protected void parseFile(AdmVerifySiteImages.Context ctx,
                         java.io.File file)
                  throws java.lang.Exception

Parses a file's references to images and determines if the references are to existing or missing images.

Parameters:

ctx - (Context) The current servlet context.

file - (File) A File object for the file or folder to be processed.

Throws:

java.lang.Exception - - if an error occurs during processing.

getRelativePath

protected java.lang.String getRelativePath(AdmVerifySiteImages.Context ctx,
                                           java.io.File file)
                                    throws java.lang.Exception

Returns a file's relative path per the current root being processed.

Parameters:

ctx - (Context) The current servlet context.

file - (File) A File object for a file.

Throws:

java.lang.Exception - - if an error occurs during processing.

isJQueryImages

protected boolean isJQueryImages(java.lang.String filepath)
                          throws java.lang.Exception

Answers if a file path is for a query images folder.

Returns:

boolean - true if the path is for a jquery images folder, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during processing.

isProductImages

protected boolean isProductImages(java.lang.String filepath)
                           throws java.lang.Exception

Answers if a file path is for a product images folder.

Returns:

boolean - true if the path is for a product images folder, otherwise false.

Throws:

java.lang.Exception - - if an error occurs during processing.

subtractRoot

protected java.lang.String subtractRoot(AdmVerifySiteImages.Context ctx,
                                        java.io.File file)
                                 throws java.lang.Exception

Substracts (removes) the path for the current root being processed from a file's path.

Parameters:

ctx - (Context) The current servlet context.

file - (File) A File object for a file.

Throws:

java.lang.Exception - - if an error occurs during processing.

createContext

protected MainServlet.Context createContext(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)

Creates the servlet context inner class. Overrides createContext in MainServlet. Invoked by doPost and doGet methods.

Overrides:

createContext in class MainServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Returns:

Context - The servlet context.