abstracttransfercontroller.html

both http and ftp file upload

<DD>Top TransferController.
 It provides basic implementation for all sub-classes.
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="init()"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>()
          throws <A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></PRE>
<DL>
<DD>Initialize TransferController.
 It instantiates custom TransferFilter (if any) and calls init().
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html#init()">init</A></CODE> in interface <CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html" title="interface in javazoom.transfer.client.core">TransferController</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="execute()"><!-- --></A><H3>
execute</H3>
<PRE>
public abstract java.lang.Object <B>execute</B>()
                                  throws <A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html#execute()">TransferController</A></CODE></B></DD>
<DD>Start synchroneous transfer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html#execute()">execute</A></CODE> in interface <CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html" title="interface in javazoom.transfer.client.core">TransferController</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="begin()"><!-- --></A><H3>
begin</H3>
<PRE>
public abstract void <B>begin</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html#begin()">TransferController</A></CODE></B></DD>
<DD>Start (fire and forget) asynchroneous transfer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html#begin()">begin</A></CODE> in interface <CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html" title="interface in javazoom.transfer.client.core">TransferController</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="cancel()"><!-- --></A><H3>
cancel</H3>
<PRE>
public abstract void <B>cancel</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html#cancel()">TransferController</A></CODE></B></DD>
<DD>Cancel transfer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html#cancel()">cancel</A></CODE> in interface <CODE><A HREF="../../../../javazoom/transfer/client/core/TransferController.html" title="interface in javazoom.transfer.client.core">TransferController</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAllowedSourceFiles()"><!-- --></A><H3>
getAllowedSourceFiles</H3>
<PRE>
protected java.util.ArrayList <B>getAllowedSourceFiles</B>()
                                             throws <A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></PRE>
<DL>
<DD>Returns all files (flat list) allowed to be transfered.
 It checks file constraints (maxfiles, maxsize, whitelist, depth, hidden).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>File array
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="isAllowed(java.io.File)"><!-- --></A><H3>
isAllowed</H3>
<PRE>
public boolean <B>isAllowed</B>(java.io.File&nbsp;current)
                  throws <A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></PRE>
<DL>
<DD>Check if file is allowed for transfer.
 <br>policy checking
 <br>size checking
 <br>whitelist checking
 <br>hidden checking
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>current</CODE> - 
<DT><B>Returns:</B><DD>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="recurse(java.io.File, java.util.ArrayList, long, long)"><!-- --></A><H3>
recurse</H3>
<PRE>
protected void <B>recurse</B>(java.io.File&nbsp;dir,
                       java.util.ArrayList&nbsp;target,
                       long&nbsp;level,
                       long&nbsp;depth)</PRE>
<DL>
<DD>Recurse directory to find all files given a depth.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dir</CODE> - <DD><CODE>target</CODE> - <DD><CODE>level</CODE> - current depth<DD><CODE>depth</CODE> - max depth allowed</DL>
</DD>
</DL>
<HR>

<A NAME="getChunks(java.io.File)"><!-- --></A><H3>
getChunks</H3>
<PRE>
protected long <B>getChunks</B>(java.io.File&nbsp;file)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLastChunkSize(java.io.File)"><!-- --></A><H3>
getLastChunkSize</H3>
<PRE>
protected long <B>getLastChunkSize</B>(java.io.File&nbsp;file)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="executeFilter(java.lang.Object)"><!-- --></A><H3>
executeFilter</H3>
<PRE>
protected java.lang.Object <B>executeFilter</B>(java.lang.Object&nbsp;input)
                                  throws <A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></PRE>
<DL>
<DD>Calls execute() method on pre-processing filter.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - 
<DT><B>Returns:</B><DD>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javazoom/transfer/client/core/ClientException.html" title="class in javazoom.transfer.client.core">ClientException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="cleanFilter()"><!-- --></A><H3>
cleanFilter</H3>
<PRE>
protected void <B>cleanFilter</B>()</PRE>
<DL>
<DD>Calls clean() method on pre-processing filter.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="compress(java.io.File)"><!-- --></A><H3>
compress</H3>
<PRE>
protected java.io.File <B>compress</B>(java.io.File&nbsp;file)</PRE>
<DL>
<DD>Zip input file.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - 
<DT><B>Returns:</B><DD>Compressed file.</DL>
</DD>
</DL>
<HR>

<A NAME="compress(java.io.File, java.lang.String)"><!-- --></A><H3>
compress</H3>
<PRE>
protected java.io.File <B>compress</B>(java.io.File&nbsp;file,
                                java.lang.String&nbsp;alg)</PRE>
<DL>
<DD>Compress input file.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - <DD><CODE>alg</CODE> - zip or gzip
<DT><B>Returns:</B><DD></DL>
</DD>
</DL>
<HR>

<A NAME="compressFolder(java.io.File, java.io.File)"><!-- --></A><H3>
compressFolder</H3>
<PRE>
protected java.io.File <B>compressFolder</B>(java.io.File&nbsp;folder,
                                      java.io.File&nbsp;zipfile)</PRE>
<DL>
<DD>Compress a folder (recursively) to a given file.
 Empty folders are included.

 Known limitation : Non-ASCII characters such as 能漩