src.com.ibm.as400.util.html.FileListElement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: FileListElement.java
//
// The source code contained herein is licensed under the IBM Public License
// Version 1.0, which has been approved by the Open Source Initiative.
// Copyright (C) 1997-2003 International Business Machines Corporation and
// others. All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////
package com.ibm.as400.util.html;
import java.io.File;
import java.io.IOException;
import java.text.Collator; // @A2A
import java.beans.PropertyVetoException;
import java.beans.PropertyChangeSupport;
import java.beans.PropertyChangeListener;
import javax.servlet.http.HttpServletRequest;
import com.ibm.as400.access.AS400;
import com.ibm.as400.access.IFSJavaFile;
import com.ibm.as400.access.Trace;
import com.ibm.as400.access.ExtendedIllegalStateException;
import com.ibm.as400.access.IFSFile;
import com.ibm.as400.access.ExtendedIllegalArgumentException;
import com.ibm.as400.util.servlet.ListRowData;
import com.ibm.as400.util.servlet.HTMLTableConverter;
import com.ibm.as400.util.servlet.RowDataException;
/**
* The FileListElement class represents the contents of an Integrated File System directory.
*
* This example creates an FileListElement object:
*
*
*
* // Create a HTMLTree object.
* HTMLTree tree = new HTMLTree(req);
*
* // Create a URLParser object.
* URLParser urlParser = new URLParser(httpServletRequest.getRequestURI());
*
* // Create a object to represent the connection to the system.
* AS400 system = new AS400(mySystem, myUserId, myPassword);
*
* // Create an IFS object.
* IFSJavaFile root = new IFSJavaFile(system, "/QIBM");
*
* // Create a DirFilter object and get the directories.
* DirFilter filter = new DirFilter();
* File[] dirList = root.listFiles(filter);
*
*
* for (int i=0; i < dirList.length; i++)
* {
* // Create a FileTreeElement.
* FileTreeElement element = new FileTreeElement(dirList[i]);
*
* // Set the Icon URL.
* ServletHyperlink sl = new ServletHyperlink(urlParser.getURI());
* sl.setHttpServletResponse(resp);
* element.setIconUrl(sl);
*
* // Set the text url so it calls another
* // servlet to display the contents of the FileTreeElement.
* ServletHyperlink tl = new ServletHyperlink("/servlet/myListServlet");
* tl.setTarget("listFrame");
*
* // Set the TextUrl for the FileTreeElement.
* element.setTextUrl(tl);
*
* // Add the FileTreeElement to the tree.
* tree.addElement(element);
* }
*
*
* // When the user clicks on text url in the HTMLTree it should call another
* // servlet to display the contents. It is here that the FileListElement
* // will be created.
* AS400 sys = new AS400(mySystem, myUserId, myPassword);
*
* // The FileTreeElment will properly create the text url and pass the
* // file and path information through the httpservletrequest. If the
* // list is meant to display the contents of the local file system,
* // then only pass the HttpServletRequest on the constructor.
* FileListElement fileList = new FileListElement(sys, httpservletrequest);
*
* // Output the content of the FileListElement.
* out.println(fileList.list());
*
*
* Once the contents are listed and a user traverses the HTML tree down to /QIBM/ProdData/Http/Public/ and clicks on the
* jt400 directory link, the FileListElement will look something like the following:
*
*
*
*
* Name
* Size
* Type
* Modified
*
*
* ../ (Parent Directory)
*
*
* com
* Directory
* 06/09/2000 11:00:46 AM
*
*
* lib
* Directory
* 09/11/2000 10:32:24 AM
*
*
* MRI2924
* Directory
* 06/09/2000 11:03:12 PM
*
*
* SSL128
* Directory
* 09/22/2000 10:46:29 AM
*
*
* SSL56
* Directory
* 09/22/2000 10:43:52 PM
*
*
* utilities
* Directory
* 06/09/2000 11:01:58 AM
*
*
* ACCESS.LST
* 15950
* File
* 06/29/2000 06:26:25 PM
*
*
* ACCESS.LVL
* 23
* File
* 06/29/2000 06:26:09 PM
*
*
* CKSETUP.INI
* 88
* File
* 06/29/2000 06:26:21 PM
*
*
* GTXSETUP.ini
* 102
* File
* 05/16/2000 05:51:46 PM
*
*
* JT400.PKG
* 19
* File
* 09/08/1999 04:25:51 PM
*
*
* OPNAV.LST
* 16827
* File
* 09/08/1999 04:26:08 PM
*
*
* OPNAV.LVL
* 19
* File
* 05/16/2000 05:51:31 AM
*
*
* OPV4R5M0.LST
* 24121
* File
* 09/08/1999 04:26:14 PM
*
*
* OPV4R5M01.LST
* 104
* File
* 05/16/2000 05:51:46 AM
*
*
* PROXY.LST
* 4636
* File
* 09/08/1999 04:26:00 AM
*
*
* PROXY.LVL
* 29
* File
* 06/29/2000 06:26:26 AM
*
*
* PXV4R5M0.LST
* 7101
* File
* 09/08/1999 04:25:58 PM
*
*
* PXV4R5M01.LST
* 38
* File
* 06/29/2000 06:27:46 PM
*
*
* QSF631215769JC10004R05M00505000000005
* 4518
* File
* 05/10/2000 10:35:10 AM
*
*
* QSF631215769JC10004R05M00505000000006
* 20
* File
* 05/10/2000 10:35:00 AM
*
*
* QSF631215769JC10004R05M00505000000007
* 15
* File
* 05/10/2000 10:35:19 AM
*
*
* QSF631215769JC10004R05M00505000000008
* 15950
* File
* 05/10/2000 10:34:57 AM
*
*
* QSF631215769JC10004R05M00505000000009
* 38
* File
* 05/10/2000 10:35:13 AM
*
*
* QSF631215769JC10004R05M00505000000010
* 38586
* File
* 05/10/2000 10:35:06 AM
*
*
* QSF631215769JC10004R05M00505000000011
* 33
* File
* 05/10/2000 10:35:09 AM
*
*
* QSF631215769JC10004R05M00505000000013
* 88
* File
* 05/10/2000 10:35:03 AM
*
*
* READMEGT.TXT
* 3480
* File
* 05/16/2000 05:52:27 AM
*
*
* READMESP.TXT
* 5161
* File
* 06/29/2000 06:26:14 PM
*
*
* V4R5M0.LST
* 38586
* File
* 06/29/2000 06:26:19 PM
*
*
* V4R5M01.LST
* 33
* File
* 06/29/2000 06:26:33 PM
*
*
* V4R5M02.LST
* 33
* File
* 06/29/2000 06:26:26 PM
*
*
*
* FileListElement objects generate the following events:
*
* - PropertyChangeEvent
*
*
* @see com.ibm.as400.util.html.DirFilter
* @see com.ibm.as400.util.html.FileListRenderer
**/
public class FileListElement implements java.io.Serializable
{
static final long serialVersionUID = 6247154241289547698L;
private AS400 system_;
private HTMLTable table_;
private HttpServletRequest request_;
private FileListRenderer renderer_; // @A4A
private StringBuffer sharePath_; // @B1A
private StringBuffer shareName_; // @B1A
private String parameterPathInfo_; //@CRS
private boolean sort_ = true; // @A2A
transient private Collator collator_ = null; // @A2A @B3C
transient private PropertyChangeSupport changes_;
private int patternMatching_ = -1; //@KKB
/**
* Constructs a default FileListElement object.
**/
public FileListElement()
{
// @B3A
// If the locale is Korean, then this throws
// an ArrayIndexOutOfBoundsException. This is
// a bug in the JDK. The workarond in that case
// is just to use String.compareTo().
try // @B3A
{
collator_ = Collator.getInstance (); // @B3A
collator_.setStrength (Collator.PRIMARY); // @B3A
}
catch (Exception e) // @B3A
{
collator_ = null; // @B3A
}
renderer_ = null;
system_ = null;
request_ = null;
shareName_ = null;
sharePath_ = null;
}
// @A7A
/**
* Constructs an FileListElement for the local file system
* using the pathInfo from the specified request.
*
* Internally a java.io.File object will be used to retrieve
* the contents of the file system.
*
* @param request The Http servlet request.
**/
public FileListElement(HttpServletRequest request)
{
this(); // @B3A
setHttpServletRequest(request);
setRenderer(new FileListRenderer(request));
}
/**
* Constructs an FileListElement for an IBM i file system
* using the pathInfo from the specified request, and
* the designated system.
*
* Internally a com.ibm.as400.access.IFSJavaFile object will be
* used to retrieve the contents of the file system.
*
* @param system The system.
* @param request The Http servlet request.
**/
public FileListElement(AS400 system, HttpServletRequest request)
{
this(); // @B3A
setSystem(system);
setHttpServletRequest(request);
setRenderer(new FileListRenderer(request)); // @A4A
}
//@CRS
/**
* Constructs an FileListElement for an IBM i file system
* using the pathInfo from the specified request, and
* the designated system.
*
* Internally a com.ibm.as400.access.IFSJavaFile object will be
* used to retrieve the contents of the file system.
*
* @param system The system.
* @param request The Http servlet request.
* @param parameterPathInfo
**/
public FileListElement(AS400 system, HttpServletRequest request, String parameterPathInfo)
{
this(); // @B3A
setSystem(system);
setHttpServletRequest(request);
setRenderer(new FileListRenderer(request)); // @A4A
parameterPathInfo_ = parameterPathInfo;
}
/**
* Constructs an FileListElement with the specified system, request, and table.
*
* Internally a com.ibm.as400.access.IFSJavaFile object will be
* used to retrieve the contents of the file system.
*
* @param system The system.
* @param request The Http servlet request.
* @param table The HTML table.
**/
public FileListElement(AS400 system, HttpServletRequest request, HTMLTable table)
{
this(); // @B3A
setSystem(system);
setHttpServletRequest(request);
setTable(table);
setRenderer(new FileListRenderer(request)); // @A4A
}
/**
* Constructs a FileListElement with the specified system, requst, NetServer sharePath, and
* NetServer shareName.
*
* Internally a com.ibm.as400.access.IFSJavaFile object will be
* used to retrieve the contents of the file system at the network share point.
*
* @param system The IBM i system.
* @param request The Http servlet request.
* @param shareName The NetServer share name.
* @param sharePath The NetServer share path.
*
**/
public FileListElement(AS400 system, HttpServletRequest request, String shareName, String sharePath) // @B1A
{
this(); // @B3A
setSystem(system); // @B1A
setHttpServletRequest(request); // @B1A
setRenderer(new FileListRenderer(request, shareName, sharePath)); // @B1A
setShareName(shareName); // @B1A
setSharePath(sharePath); // @B1A
}
//@CRS
/**
* Constructs a FileListElement with the specified system, requst, NetServer sharePath, and
* NetServer shareName.
*
* Internally a com.ibm.as400.access.IFSJavaFile object will be
* used to retrieve the contents of the file system at the network share point.
*
* @param system The IBM i system.
* @param request The Http servlet request.
* @param shareName The NetServer share name.
* @param sharePath The NetServer share path.
* @param parameterPathInfo
*
**/
public FileListElement(AS400 system, HttpServletRequest request, String shareName, String sharePath, String parameterPathInfo) // @B1A
{
this(); // @B3A
setSystem(system); // @B1A
setHttpServletRequest(request); // @B1A
setRenderer(new FileListRenderer(request, shareName, sharePath)); // @B1A
setShareName(shareName); // @B1A
setSharePath(sharePath); // @B1A
parameterPathInfo_ = parameterPathInfo;
}
/**
* Adds a PropertyChangeListener. The specified
* PropertyChangeListener's propertyChange
* method is called each time the value of any
* bound property is changed.
*
* @see #removePropertyChangeListener
* @param listener The PropertyChangeListener.
**/
public void addPropertyChangeListener(PropertyChangeListener listener)
{
if (listener == null)
throw new NullPointerException("listener");
if (changes_ == null) changes_ = new PropertyChangeSupport(this);
changes_.addPropertyChangeListener(listener);
}
/**
* Returns the Collator.
*
* @return The collator.
**/
public Collator getCollator() // @B3A
{
return collator_;
}
/**
* Returns the Http servlet request.
*
* @return The request.
**/
public HttpServletRequest getHttpServletRequest()
{
return request_;
}
/**
* Return the file list renderer.
*
* @return The renderer.
**/
public FileListRenderer getRenderer()
{
return renderer_;
}
/**
* Return the NetServer share point.
*
* @return The NetServer share path.
**/
public String getSharePath() // @B1A
{ // @B1A
// Need to check for null before
// performing a toString().
if (sharePath_ == null)
return null;
else
return sharePath_.toString(); // @B1A
} // @B1A
/**
* Return the name of the NetServer share.
*
* @return The name of the NetServer share.
**/
public String getShareName() // @B1A
{
// Need to check for null before
// performing a toString().
if (shareName_ == null) // @B1A
return null;
else
return shareName_.toString(); // @B1A
} // @B1A
/**
* Returns the system.
*
* @return The system.
*
**/
public AS400 getSystem()
{
return system_;
}
/**
* Returns the HTMLTable.
*
* @return The table.
**/
public HTMLTable getTable()
{
return table_;
}
/**
* Returns a string containing the list of files and directories
* in the path defined in the HttpServletRequest.
*
* If the system has not been set, a java.io.File object
* will be created with the pathInfo from the HttpServletRequest
* to retrieve the list of file and directories from the
* local file system.
*
* @return The list.
**/
public String list()
{
return list(new HTMLTableConverter());
}
//@CRS - Added HTMLTableConverter parameter.
/**
* Returns a string containing the list of files and directories
* in the path defined in the HttpServletRequest.
*
* If the system has not been set, a java.io.File object
* will be created with the pathInfo from the HttpServletRequest
* to retrieve the list of file and directories from the
* local file system.
* @param conv An HTMLTableConverter used to format the list of files.
* @return The list.
**/
public String list(HTMLTableConverter conv)
{
if (conv == null) throw new NullPointerException("conv");
if (request_ == null) throw new ExtendedIllegalStateException("request", ExtendedIllegalStateException.PROPERTY_NOT_SET);
String path = null;
if (parameterPathInfo_ == null)
{
path = request_.getPathInfo();
}
else
{
path = parameterPathInfo_;
}
if (path == null) path = "/";
if (sharePath_ != null) // @B1A
{
try // @B1A
{
path = sharePath_.append(path.substring(path.indexOf('/', 1), path.length())).toString(); // @B1A
} // @B1A
catch (StringIndexOutOfBoundsException e) // @B1A
{
path = sharePath_.insert(0, "/").toString(); // @B1A
}
}
try
{
File rootFile = null;
// @A7A
// If a system_ object is not provided then a java.io.File object will be created with the
// path info from the request.
if (system_ != null) // @A7A
{
rootFile = new IFSJavaFile(system_, path.replace('\\','/'));
if(patternMatching_ != -1) //@KKB specify the pattern matching to be used
{
try{
((IFSJavaFile)rootFile).setPatternMatching(patternMatching_);
}
catch(IOException e)
{
// error occured setting pattern matching for the file, default value will be used
if(Trace.isTraceOn())
Trace.log(Trace.ERROR, e);
}
}
}
else // @A7A
{
rootFile = new File(path); // @A7A
}
if (Trace.isTraceOn()) Trace.log(Trace.INFORMATION, "FileListElement path: " + path); // @A6A @C1C
// Set the default table properties if the user has not set the table.
if (table_ == null)
{
table_ = new HTMLTable();
table_.setCellPadding(7);
// Set the converter meta data property.
conv.setUseMetaData(true);
}
else
{
// If the table has been set and the headers are empty, use
// the default headers from the meta data.
if (table_.getHeader() == null) conv.setUseMetaData(true);
}
// Set the converter table property.
conv.setTable(table_);
// Use the default renderer if one has not been set. // $C2A
if (renderer_ == null) renderer_ = new FileListRenderer(request_); // $C2A
ListRowData rowData = renderer_.getRowData(rootFile, sort_, collator_); // $C2C
if (rowData.length() > 0) // @A6C
{
HTMLTable[] tables = conv.convertToTables(rowData); //@CRS
StringBuffer buf = new StringBuffer(); //@CRS
for (int i=0; icollator. The collator allows the tree to perform
* locale-sensitive String comparisons when sorting the file list elements.
*
* @param collator The Collator.
**/
public void setCollator(Collator collator) // @B3A
{
if (collator == null)
throw new NullPointerException("collator");
Collator old = collator_;
collator_ = collator;
if (changes_ != null) changes_.firePropertyChange("collator", old, collator_);
}
/**
* Sets the Http servlet request for the element.
*
* @param request The Http servlet request.
**/
public void setHttpServletRequest(HttpServletRequest request)
{
if (request == null)
throw new NullPointerException("request");
HttpServletRequest old = request_;
request_ = request;
if (changes_ != null) changes_.firePropertyChange("request", old, request_);
}
/**
* Set the renderer for the FileListElement. The default
* is FileListRenderer.
*
* @param renderer The file list renderer.
**/
public void setRenderer(FileListRenderer renderer)
{
if (renderer == null)
throw new NullPointerException("renderer");
FileListRenderer old = renderer_;
renderer_ = renderer;
if (changes_ != null) changes_.firePropertyChange("renderer", old, renderer_);
}
/**
* Set the NetServer share path.
*
* @param sharePath The NetServer share path.
**/
public void setSharePath(String sharePath) // @B1A
{ // @B1A
if (sharePath == null) // @B1A
throw new NullPointerException("sharePath"); // @B1A
// @B1A
StringBuffer old = sharePath_; // @B1A
// @B1A
sharePath_ = new StringBuffer(sharePath); // @B1A
// @B1A
if (changes_ != null) changes_.firePropertyChange("sharePath",
old==null ? null : old.toString(), sharePath_.toString()); // @B1A
}
/**
* Set the name of the NetServer share.
*
* @param shareName The NetServer share name.
**/
public void setShareName(String shareName) // @B1A
{ // @B1A
if (shareName == null) // @B1A
throw new NullPointerException("shareName"); // @B1A
// @B1A
StringBuffer old = shareName_; // @B1A
// @B1A
shareName_ = new StringBuffer(shareName); // @B1A
// @B1A
if (changes_ != null) changes_.firePropertyChange("shareName",
old==null ? null : old.toString(), shareName_.toString()); // @B1A
}
/**
* Set the system.
*
* @param system The system.
**/
public void setSystem(AS400 system)
{
if (system == null)
throw new NullPointerException("system");
AS400 old = system_;
system_ = system;
if (changes_ != null) changes_.firePropertyChange("system", old, system_);
}
/**
* Set the HTMLTable to use when displaying the file list.
* This will replace the default HTMLTable used.
*
* @param table The HTML table.
**/
public void setTable(HTMLTable table)
{
if (table == null)
throw new NullPointerException("table");
HTMLTable old = table;
table_ = table;
if (changes_ != null) changes_.firePropertyChange("table", old, table_);
}
/**
* Sorts the list elements.
*
* @param sort true if the elements are sorted; false otherwise.
* The default is true.
**/
public void sort(boolean sort) // @A2A
{
sort_ = sort;
}
// @KKB give users a way to specify what pattern should be used when listing files
/**
* Sets the pattern-matching behavior used when files are listed. The default is PATTERN_POSIX.
* @param patternMatching Either {@link IFSFile#PATTERN_POSIX PATTERN_POSIX}, {@link IFSFile#PATTERN_POSIX_ALL PATTERN_POSIX_ALL}, or {@link IFSFile#PATTERN_OS2 PATTERN_OS2}
*/
public void setPatternMatching(int patternMatching){
if(patternMatching < IFSFile.PATTERN_POSIX || patternMatching > IFSFile.PATTERN_OS2)
throw new ExtendedIllegalArgumentException("patternMatching",
ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
patternMatching_ = patternMatching;
}
}