com.jalios.jcms.handler
Class FileHandler

java.lang.Object
  com.jalios.jcms.context.JcmsContext
      com.jalios.jcms.context.JcmsJspContext
          com.jalios.jcms.handler.JcmsFormHandler
              com.jalios.jcms.handler.FileHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class FileHandler
extends JcmsFormHandler

Field Summary

static String	REVISION
String	root Upload directory path

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

contextMap, editFieldSet, noRedirect, noSendRedirect, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, JS_HEADER, jsboMap, jsboSet, jsfoMap, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext

browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDebug, isLogged, loggedMember, request, response, userLang, userLocale, workspace

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DAILY_MAIL_ALERT, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, MONTHLY_MAIL_ALERT, NO_MAIL_ALERT, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WEEKLY_MAIL_ALERT, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

FileHandler()
Set the value of channel

Method Summary

String	addFolder() Add a new folder in the current directory.
String	changeSort() Change the current directory content sorting.
String	cutAndPasteItem() Cut and paste a file or a folder in the current directory.
String	deleteItem() Delete an item which is a file or a directory.
String	executeQuery() Execute a query set by the method setQuery(queryName).
File	getCurrentDir() Get the current subdirectory.
String	getCurrentPath() Get the current subdirectory path ended with a file separator.
Vector	getFiles() Returns a list of the current directory files, not including the subfolders and sorted by the current sorting attribute and the current sorting order.
Vector	getFolders() Returns a list of the current directory subfolders sorted by the current sorting attribute and the current sorting order.
String	getNewItem() Get the value of newItem
String	getQuery() Get the value of query
Vector	getRelativeTree() Get the upload folder tree.
String	getRoot() Get the value of root
File	getSelectedFile() Get the selected file (or folder).
String	getSelectedItem() Get the value of selectedItem
boolean	getSort() Get the value of sort
String	getSortAttr() Get the value of sortAttr
String	getSubdir() Get the value of subdir.
String	pasteItem() Paste a file or a folder in the current directory.
String	renameItem() Rename the selected file or directory.
String	selectItem() Select a file or a directory in the current directory.
void	setNewItem(String ni) Set the value of newItem.
void	setQuery(String query) Set the value of query
void	setSelectedItem(String sel) Set the value of selectedItem
void	setSort(boolean sort) Set the value of sort
void	setSortAttr(String sortAttr) Set the value of sortAttr
void	setSubdir(String sd) Set the value of subdir.
String	update() Check the subdirectory path validity.

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

getControllerContext, getEditFieldSet, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, processStatus, sendRedirect, sendRedirect, setEditField, setNoRedirect, setNoSendRedirect, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, updateUploadedField, updateUploadedFields

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJSHeader, addJSHeader, addJSHeader, addJSHeader, addStyleHeader, addStyleHeader, debugDisplayContext, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBackOfficeJSHeader, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSMap, getFinalJavaScriptSet, getFormElementCount, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getFrontOfficeJSHeader, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSHeaders, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isPrintView, registerDisplayContext, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setFormElementCount, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, workaroundJCMS1967

Methods inherited from class com.jalios.jcms.context.JcmsContext

addCookie, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getInfoMsg, getLoggedMember, getRequest, getResponse, getSession, getUploadedFile, getUploadedFileList, getUrlWithCommonUpdatedParams, getUserLang, getUserLocale, getWarningMsg, glp, isAdmin, isAjaxRequest, isDebug, isInFrontOffice, isLogged, isWebdavAccess, retrieveUploadedFile, sendForbidden, sendForbidden, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, validateRegexp

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

root

public String root

Upload directory path

Constructor Detail

FileHandler

public FileHandler()

Set the value of channel

Method Detail

getSubdir

public String getSubdir()

Get the value of subdir.

Returns:

Value of subdir.

setSubdir

public void setSubdir(String sd)

Set the value of subdir.

Parameters:

sd - Value to assign to subdir.

getSelectedItem

public String getSelectedItem()

Get the value of selectedItem

Returns:

Value of selectedItem.

setSelectedItem

public void setSelectedItem(String sel)

Set the value of selectedItem

Parameters:

sel - Value to assign to selectedItem

setNewItem

public void setNewItem(String ni)

Set the value of newItem.

Parameters:

ni - Value to assign to newItem

getNewItem

public String getNewItem()

Get the value of newItem

Returns:

Value of newItem.

setQuery

public void setQuery(String query)

Set the value of query

Parameters:

query - Value to assign to query

getQuery

public String getQuery()

Get the value of query

Returns:

Value of query.

setSort

public void setSort(boolean sort)

Set the value of sort

Parameters:

sort - Value to assign to sort

getSort

public boolean getSort()

Get the value of sort

Returns:

Value of sort.

setSortAttr

public void setSortAttr(String sortAttr)

Set the value of sortAttr

Parameters:

sortAttr - Value to assign to sortAttr

getSortAttr

public String getSortAttr()

Get the value of sortAttr

Returns:

Value of sortAttr.

getRoot

public String getRoot()

Get the value of root

Returns:

Value of root

getFolders

public Vector getFolders()

Returns a list of the current directory subfolders sorted by the current sorting attribute and the current sorting order. Returns null if the current directory path is invalid.

Returns:

Vector of ChannelFile

getFiles

public Vector getFiles()

Returns a list of the current directory files, not including the subfolders and sorted by the current sorting attribute and the current sorting order. Returns null if the current directory path is invalid.

Returns:

Vector of ChannelFile

getRelativeTree

public Vector getRelativeTree()

Get the upload folder tree. Each element is a subdirectory path relative to the upload root path ended with no file separator.

Returns:

Vector of subdirectories relative path

getCurrentPath

public String getCurrentPath()

Get the current subdirectory path ended with a file separator.

Returns:

the current subdirectory path

getSelectedFile

public File getSelectedFile()

Get the selected file (or folder).

Returns:

File represented the selected item or null if there isn't any.

getCurrentDir

public File getCurrentDir()

Get the current subdirectory.

Returns:

the current subdirectory

executeQuery

public String executeQuery()

Execute a query set by the method setQuery(queryName).
An item is a file or a folder. The queries suported are listed below:

update : set a subdirectory path

selectItem : change the current selection

addFolder : add a new folder in the current subdirectory

deleteItem : delete the selected item

pasteItem : add an item in the current subdirectory

cutAndPasteItem : cut an item and add it in the current subdirectory

renameItem : rename the selected item

changeSort : change the sort

Returns:

a javascript updating message .

update

public String update()

Check the subdirectory path validity. The followingparameter must be set before:

subdir: the current subdirectory

Returns:

a javascript updating message .

selectItem

public String selectItem()

Select a file or a directory in the current directory. The following parameters must be set before:

subdir: the current subdirectory

selectedItem: the selected file or folder

Returns:

an javascript updating message .

addFolder

public String addFolder()

Add a new folder in the current directory.
The following parameters must be set before:

subdir: the current subdirectory

newItem: the new folder name

Returns:

a javascript upating message

deleteItem

public String deleteItem()

Delete an item which is a file or a directory. If the deleted item is a directory, it is recursive. The following parameters must be set before:

subdir: the current subdirectory

selectedItem: the file or folder name which must be deleted

Returns:

a javascript updating message.

pasteItem

public String pasteItem()

Paste a file or a folder in the current directory. The following parameters must be set before:

subdir: the current subdirectory

newItem: the relative path of the file or folder wich must be pasted

Returns:

a javascript updating message

cutAndPasteItem

public String cutAndPasteItem()

Cut and paste a file or a folder in the current directory. The following parameters must be set before:

subdir: the current subdirectory

newItem: the path of the file or folder wich must be cut and pasted

Returns:

a javascript updating message

renameItem

public String renameItem()

Rename the selected file or directory. The following parameters must be set before:

subdir: the current subdirectory

selectedItem: the file or folder name which must be renamed

newItem: the new name

Returns:

a javascript updating message

changeSort

public String changeSort()

Change the current directory content sorting. The followingparameter must be set before:

subdir: the current subdirectory

sortAttr: the sort attribute.

sort: the sort order

Returns:

a javascript updating message .