com.dpslink.flash.servlet.admin

Class AdmProductDescriptionEdit

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.MainPagingServlet

com.dpslink.flash.servlet.admin.AdmProductServlet

com.dpslink.flash.servlet.admin.AdmProductDescriptionEdit

All Implemented Interfaces:

FileUploadListener, PagingServlet, java.io.Serializable, java.util.EventListener, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AdmPendingProductEditDescriptions

public class AdmProductDescriptionEdit
extends AdmProductServlet
implements FileUploadListener

Writes and processes the admin product description edit page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdmProductDescriptionEdit.Context Inner class used to store servlet context information.

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

FlashServlet.Stack

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

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
AdmProductDescriptionEdit()

Method Summary

Modifier and Type	Method and Description
protected AdmProductServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected boolean	editFormFields(BaseServlet.Context baseCtx) Edits the values from the html template's form fields.
protected java.io.File	getDescriptionFile(AdmProductDescriptionEdit.Context ctx, int size) Returns the description file for the given size.
protected java.lang.String	getDescriptionFileContent(AdmProductDescriptionEdit.Context ctx, int size, boolean prune) Returns the description file content for the given size.
protected java.lang.String	getDescriptionRootName(AdmProductDescriptionEdit.Context ctx, int size) Returns the description root name for the given size.
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	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
protected boolean	isDefaultCode(AdmProductDescriptionEdit.Context ctx) Answers if the code for the current product is "default".
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
protected void	resetFormFields(BaseServlet.Context baseCtx) Resets the values for the html template's form fields.
protected boolean	saveFiles(AdmProductDescriptionEdit.Context ctx) Saves the product description files (large and small) to their respective locations.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
protected boolean	setTemplateError(AdmProductDescriptionEdit.Context ctx, java.lang.String errName) Sets the html template error fields for the given error name.
protected boolean	switchFile(AdmProductDescriptionEdit.Context ctx) Switches the product description file (large or small) to a selected file name.
protected boolean	switchFileExtension(AdmProductDescriptionEdit.Context ctx, java.lang.String path, java.lang.String root) Switches the file extension for a product-specific description (small or large) by renaming the existing file to the new extension.
protected boolean	switchFileFromDefault(AdmProductDescriptionEdit.Context ctx, java.lang.String path, java.lang.String root) Switches from a default description file (small or large) to a product-specific description by creating the product-specific file.
protected boolean	switchFileToDefault(AdmProductDescriptionEdit.Context ctx, java.lang.String path, java.lang.String root) Switches from a product-specific description file (small or large) to a default description by deleting the product-specific file(s).
void	uploadComplete(FileUploadEvent event) Handles a file upload completion event.
protected boolean	uploadFiles(AdmProductDescriptionEdit.Context ctx, boolean upload) Uploads the requested description file(s).

Methods inherited from class com.dpslink.flash.servlet.admin.AdmProductServlet

getProductObject, setCookieValues, setSessionValues

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

setTemplatePagingBegIndex, setTemplatePagingEndIndex, setTemplatePagingLinks

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

Constructor Detail

AdmProductDescriptionEdit

public AdmProductDescriptionEdit()

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.

Overrides:

readParameters in class AdmProductServlet

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.

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.

uploadComplete

public void uploadComplete(FileUploadEvent event)

Handles a file upload completion event. Sent to file upload event listeners when an attempt has been made to upload a file (success or failure).

Specified by:

uploadComplete in interface FileUploadListener

Parameters:

event - (FileUploadEvent) The upload event to process.

setTemplateError

protected boolean setTemplateError(AdmProductDescriptionEdit.Context ctx,
                                   java.lang.String errName)

Sets the html template error fields for the given error name.

Parameters:

ctx - (Context) The current servlet context.

errName - (String) The name of error that is to be set, used to determine which message (or messages) to retrieve from the message properties.

Returns:

boolean - Always returns false.

getDescriptionFile

protected java.io.File getDescriptionFile(AdmProductDescriptionEdit.Context ctx,
                                          int size)

Returns the description file for the given size.

Parameters:

ctx - (Context) The current servlet context.

size - (int) The size of the desired description file (Product.SIZE_SMALL, Product.SIZE_LARGE).

Returns:

File - The description file.

getDescriptionFileContent

protected java.lang.String getDescriptionFileContent(AdmProductDescriptionEdit.Context ctx,
                                                     int size,
                                                     boolean prune)

Returns the description file content for the given size.

Parameters:

ctx - (Context) The current servlet context.

size - (int) The size of the desired description file (Product.SIZE_SMALL, Product.SIZE_LARGE).

prune - (boolean) true if the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Returns:

String - The description file content.

getDescriptionRootName

protected java.lang.String getDescriptionRootName(AdmProductDescriptionEdit.Context ctx,
                                                  int size)

Returns the description root name for the given size.

Parameters:

ctx - (Context) The current servlet context.

size - (int) The size of the desired description root name (Product.SIZE_SMALL, Product.SIZE_LARGE).

Returns:

String - The description root name.

isDefaultCode

protected boolean isDefaultCode(AdmProductDescriptionEdit.Context ctx)

Answers if the code for the current product is "default".

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the product's code is "default", otherwise false.

saveFiles

protected boolean saveFiles(AdmProductDescriptionEdit.Context ctx)

Saves the product description files (large and small) to their respective locations.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the saves are successful, otherwise false.

switchFile

protected boolean switchFile(AdmProductDescriptionEdit.Context ctx)

Switches the product description file (large or small) to a selected file name.

Parameters:

ctx - (Context) The current servlet context.

Returns:

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

switchFileExtension

protected boolean switchFileExtension(AdmProductDescriptionEdit.Context ctx,
                                      java.lang.String path,
                                      java.lang.String root)

Switches the file extension for a product-specific description (small or large) by renaming the existing file to the new extension.

Parameters:

ctx - (Context) The current servlet context.

path - (String) The path to the small or large description folder.

root - (String) The root name for the small or large description file.

Returns:

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

switchFileFromDefault

protected boolean switchFileFromDefault(AdmProductDescriptionEdit.Context ctx,
                                        java.lang.String path,
                                        java.lang.String root)

Switches from a default description file (small or large) to a product-specific description by creating the product-specific file.

Parameters:

ctx - (Context) The current servlet context.

path - (String) The path to the small or large description folder.

root - (String) The root name for the small or large description file.

Returns:

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

switchFileToDefault

protected boolean switchFileToDefault(AdmProductDescriptionEdit.Context ctx,
                                      java.lang.String path,
                                      java.lang.String root)

Switches from a product-specific description file (small or large) to a default description by deleting the product-specific file(s).

Parameters:

ctx - (Context) The current servlet context.

path - (String) The path to the small or large description folder.

root - (String) The root name for the small or large description file.

Returns:

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

uploadFiles

protected boolean uploadFiles(AdmProductDescriptionEdit.Context ctx,
                              boolean upload)

Uploads the requested description file(s). The descriptions are initially uploaded to a temporary folder and then moved to the appropriate description file location. The moved file(s) are automatically renamed so they conform to the naming required for the current product.

Parameters:

ctx - (Context) The current servlet context.

upload - (boolean) true to initiate the file upload processing, otherwise false to complete the processing.

Returns:

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

createContext

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

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

Overrides:

createContext in class AdmProductServlet

Parameters:

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

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

Returns:

Context - The servlet context.