JOTFileBrowserSession

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.jot.web.filebrowser
Class JOTFileBrowserSession

java.lang.Object
  net.jot.web.filebrowser.JOTFileBrowserSession

public class JOTFileBrowserSession
extends java.lang.Object
extends java.lang.Object

This reprsents a user current "view" of a file manager. (ie: which folder he is in, how the file listing is ordered etc...) It stores that "filemanager view" data into the user session. This "view" is originally configured by the programmer to allow certain actions and expect certain results. It is a lightweight object, just varibales and get/setters. Most of the "Logic" going with this is in JotFileBrowserHelper

Author:: thibautc

Field Summary
`protected boolean`	`allowBrowsing` wether stuck in exisiting folder or can browse around.
`protected boolean`	`allowCreateFolders`
`protected boolean`	`allowDelete`
`protected boolean`	`allowDeleteFilledFolders` allow deleting recursively a filled folder or not
`protected boolean`	`allowDownloadFile` allo view/download files ?
`protected boolean`	`allowListFiles` If false then user won't se the existing files at all.
`protected boolean`	`allowListHiddenFiles`
`protected boolean`	`allowPickRootFolder` when selecting a folder, can the user pick the root folder itself (or only a subfolder of it) ?
`protected boolean`	`allowRenaming` allow renaming files/folders
`protected boolean`	`allowShowPath` wether to show the current directory full path or not (ex: /home/blah/files/)
`protected boolean`	`allowUpdateFile` allow updating/uplaoding a new version of an existing file ?
`protected boolean`	`allowUploadFile`
`protected int`	`browseType` You will want to set this depending what you want the user to do: ie: upload a file, select a file, just browse etc....
`protected java.io.File`	`currentFolder` internal value
`protected java.lang.String`	`currentWarning` internal value
`protected java.lang.String`	`failedWarning`
`protected java.util.Vector`	`fileListing` internal value
`protected java.lang.String`	`fileNameWarning` warning messages : null = no warning, not null.
`protected java.lang.String`	`forbiddenWarning`
`protected java.lang.String`	`fullFolderWarning`
`protected long`	`maxFolderNameLength`
`protected long`	`maxUploadSize` maximum TOTAL size in bytes of file(s) uploaded.
`protected java.lang.String`	`multipleFilesWarning` warning messages : null = no warning, not null.
`protected java.lang.Integer`	`nbOfUploadFields` If file uploads are enabled, how many file do we allow to upload at a time ?
`protected java.lang.String`	`newDirPattern` pattern for new dir names (for security reasons), default:letters,numbers,-,_ only
`protected java.lang.String`	`newFilePattern` pattern for new/uploaded file names (for security reasons), default:letters,numbers,-,_,.
`protected java.lang.String`	`oneFileWarning` warning messages : null = no warning, not null.
`protected java.lang.String`	`oneFolderWarning` warning messages : null = no warning, not null.
`protected java.io.File`	`rootFolder` user can not browse "higher" than this folder.
`protected java.lang.String`	`sessionTimeoutWarning` warning messages : null = no warning, not null.
`protected int`	`sortBy` by default sort by filename in alphabetical order
`protected java.io.File`	`startFolder` which folder to start in (rootFolder if null)
`protected java.lang.String`	`tempUploadFolder` where the temporary upload data will be stored during a file upload.
`protected java.lang.String`	`title` if you want to set a title (ie: "Please choose a file")
`protected java.lang.String`	`updateWarning` warning messages : null = no warning, not null.
`protected java.io.File`	`upFolder` internal value

Constructor Summary
`JOTFileBrowserSession(java.io.File rootFolder, java.io.File startFolder, int browseType)` Generic constructor, setting "Default" permissions

Method Summary
`int`	`getBrowseType()`
`java.io.File`	`getCurrentFolder()`
`java.lang.String`	`getCurrentWarning()`
`java.lang.String`	`getFailedWarning()`
`java.util.Vector`	`getFileListing()`
`java.lang.String`	`getFileNameWarning()`
`java.lang.String`	`getForbiddenWarning()`
`java.lang.String`	`getFullFolderWarning()`
`long`	`getMaxFolderNameLength()`
`long`	`getMaxUploadSize()`
`java.lang.String`	`getMultipleFilesWarning()`
`java.lang.Integer`	`getNbOfUploadFields()`
`java.lang.String`	`getNewDirPattern()`
`java.lang.String`	`getNewFilePattern()`
`java.lang.String`	`getOneFileWarning()`
`java.lang.String`	`getOneFolderWarning()`
`java.io.File`	`getRootFolder()`
`java.lang.String`	`getSessionTimeoutWarning()`
`int`	`getSortBy()`
`java.io.File`	`getStartFolder()`
`java.lang.String`	`getTempUploadFolder()`
`java.lang.String`	`getTitle()`
`java.lang.String`	`getUpdateWarning()`
`java.io.File`	`getUpFolder()`
`boolean`	`isAllowBrowsing()`
`boolean`	`isAllowCreateFolders()`
`boolean`	`isAllowDelete()`
`boolean`	`isAllowDeleteFilledFolders()`
`boolean`	`isAllowDownloadFile()`
`boolean`	`isAllowListFiles()`
`boolean`	`isAllowListHiddenFiles()`
`boolean`	`isAllowPickRootFolder()`
`boolean`	`isAllowRenaming()`
`boolean`	`isAllowShowPath()`
`boolean`	`isAllowUpdateFile()`
`boolean`	`isAllowUploadFile()`
`java.lang.Boolean`	`lookingForFile()`
`java.lang.Boolean`	`lookingForFolder()`
`java.lang.Boolean`	`lookingForSingleFileUpload()`
`void`	`setAllowBrowsing(boolean allowBrowsing)`
`void`	`setAllowCreateFolders(boolean allowCreateFolders)`
`void`	`setAllowDelete(boolean allowDelete)`
`void`	`setAllowDeleteFilledFolders(boolean allowDeleteFilledFolders)`
`void`	`setAllowDownloadFile(boolean allowDownloadFile)`
`void`	`setAllowListFiles(boolean allowListFiles)`
`void`	`setAllowListHiddenFiles(boolean showHiddenFiles)`
`void`	`setAllowPickRootFolder(boolean allowPickRootFolder)`
`void`	`setAllowRenaming(boolean allowRenaming)`
`void`	`setAllowShowPath(boolean allowShowPath)`
`void`	`setAllowUpdateFile(boolean allowUpdateFile)`
`void`	`setAllowUploadFile(boolean allowUploadFile)`
`void`	`setBrowseType(int browseType)`
`void`	`setCurrentFolder(java.io.File currentFolder)`
`void`	`setCurrentWarning(java.lang.String currentWarning)`
`void`	`setFailedWarning(java.lang.String failedWarning)`
`void`	`setFileListing(java.util.Vector folderListing)`
`void`	`setFileNameWarning(java.lang.String fileNameWarning)`
`void`	`setForbiddenWarning(java.lang.String forbiddenWarning)`
`void`	`setFullFolderWarning(java.lang.String fullFolderWarning)`
`void`	`setMaxFolderNameLength(long maxFolderNameLength)`
`void`	`setMaxUploadSize(long maxUploadSize)`
`void`	`setMultipleFilesWarning(java.lang.String multipleFilesWarning)`
`void`	`setNbOfUploadFields(int nb)`
`void`	`setNewDirPattern(java.lang.String pattern)`
`void`	`setNewFilePattern(java.lang.String newFilePattern)`
`void`	`setOneFileWarning(java.lang.String oneFileWarning)`
`void`	`setOneFolderWarning(java.lang.String oneFolderWarning)`
`void`	`setRootFolder(java.io.File rootFolder)`
`void`	`setSessionTimeoutWarning(java.lang.String sessionTimeoutWarning)`
`void`	`setSortBy(int sortBy)`
`void`	`setStartFolder(java.io.File startFolder)`
`void`	`setTempUploadFolder(java.lang.String tempUploadFolder)`
`void`	`setTitle(java.lang.String title)`
`void`	`setUpdateWarning(java.lang.String updateWarning)`
`void`	`setUpFolder(java.io.File upFolder)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

rootFolder

protected java.io.File rootFolder

user can not browse "higher" than this folder.

startFolder

protected java.io.File startFolder

which folder to start in (rootFolder if null)

browseType

protected int browseType

You will want to set this depending what you want the user to do: ie: upload a file, select a file, just browse etc....

title

protected java.lang.String title

if you want to set a title (ie: "Please choose a file")

tempUploadFolder

protected java.lang.String tempUploadFolder

where the temporary upload data will be stored during a file upload.

allowListFiles

protected boolean allowListFiles

If false then user won't se the existing files at all.

allowBrowsing

protected boolean allowBrowsing

wether stuck in exisiting folder or can browse around.

allowShowPath

protected boolean allowShowPath

wether to show the current directory full path or not (ex: /home/blah/files/)

allowListHiddenFiles

protected boolean allowListHiddenFiles

allowCreateFolders

protected boolean allowCreateFolders

allowDelete

protected boolean allowDelete

allowRenaming

protected boolean allowRenaming

allow renaming files/folders

allowDeleteFilledFolders

protected boolean allowDeleteFilledFolders

allow deleting recursively a filled folder or not

allowUploadFile

protected boolean allowUploadFile

allowUpdateFile

protected boolean allowUpdateFile

allow updating/uplaoding a new version of an existing file ?

allowDownloadFile

protected boolean allowDownloadFile

allo view/download files ?

allowPickRootFolder

protected boolean allowPickRootFolder

when selecting a folder, can the user pick the root folder itself (or only a subfolder of it) ?

maxUploadSize

protected long maxUploadSize

maximum TOTAL size in bytes of file(s) uploaded. Default : ~5MB

maxFolderNameLength

protected long maxFolderNameLength

nbOfUploadFields

protected java.lang.Integer nbOfUploadFields

If file uploads are enabled, how many file do we allow to upload at a time ?

newDirPattern

protected java.lang.String newDirPattern

pattern for new dir names (for security reasons), default:letters,numbers,-,_ only

newFilePattern

protected java.lang.String newFilePattern

pattern for new/uploaded file names (for security reasons), default:letters,numbers,-,_,. only

sortBy

protected int sortBy

by default sort by filename in alphabetical order

updateWarning

protected java.lang.String updateWarning

warning messages : null = no warning, not null. Warning if a file with same name already exists

fullFolderWarning

protected java.lang.String fullFolderWarning

forbiddenWarning

protected java.lang.String forbiddenWarning

failedWarning

protected java.lang.String failedWarning

fileNameWarning

protected java.lang.String fileNameWarning

warning messages : null = no warning, not null. File/folder name contains unallowed characters

sessionTimeoutWarning

protected java.lang.String sessionTimeoutWarning

warning messages : null = no warning, not null. The session timed out, need to start over

oneFileWarning

protected java.lang.String oneFileWarning

warning messages : null = no warning, not null. We want the user to pick only 1 file

multipleFilesWarning

protected java.lang.String multipleFilesWarning

warning messages : null = no warning, not null. We want the user to pick 1 or more file(s)

oneFolderWarning

protected java.lang.String oneFolderWarning

warning messages : null = no warning, not null. We want the user to pick a folder

currentFolder

protected java.io.File currentFolder

internal value

fileListing

protected java.util.Vector fileListing

internal value

currentWarning

protected java.lang.String currentWarning

internal value

upFolder

protected java.io.File upFolder

internal value

Constructor Detail