filehandler.html

turbine教程

</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="FileHandler()"><!-- --></A><H3>
FileHandler</H3>
<PRE>
public <B>FileHandler</B>()</PRE>
<DL>
<DD>Default Constructor</DL>

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

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

<A NAME="send(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
send</H3>
<PRE>
public boolean <B>send</B>(java.lang.String&nbsp;fileContents,
                    java.lang.String&nbsp;targetLocationProperty,
                    java.lang.String&nbsp;fileName)</PRE>
<DL>
<DD>The client has indicated that it would like
 to send a file to the server and have it
 stored in a certain location on the server.

 So a client Turbine application might use the
 following bit of code to send a file to a server
 Turbine application:

 TurbineXmlRpc.executeRpc("file.send", params)

 Where:

 params.get(0) = contents of the file as a string.
 params.get(1) = the name the file should have when it lands.
 params.get(2) = property describing where the file should land.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fileContents:</CODE> - The contents of the file to store. It
    is assumed that any xml content is properly encoded!<DD><CODE>fileName:</CODE> - Name to give the file created to store
    the contents.<DD><CODE>targetLocationProperty:</CODE> - storage location of this file
    is controlled by this property that is specified in 
    the TR.props file or an included properties file.</DL>
</DD>
</DL>
<HR>

<A NAME="get(java.lang.String, java.lang.String)"><!-- --></A><H3>
get</H3>
<PRE>
public java.lang.String <B>get</B>(java.lang.String&nbsp;targetLocationProperty,
                            java.lang.String&nbsp;fileName)</PRE>
<DL>
<DD>The client has indicated that it would like
 to get a file from the server.

 So a client Turbine application might use the
 following bit of code to get a file from a server
 Turbine application:

 TurbineXmlRpc.executeRpc("file.get", params)

 Where:

 params.get(0) = the name the file should have when it lands.
 params.get(1) = property describing where the file should land.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fileName:</CODE> - Name to give the file created to store
    the contents.<DD><CODE>targetLocationProperty:</CODE> - storage location of this file
    is controlled by this property that is specified in 
    the TR.props file or an included properties file.<DT><B>Returns:</B><DD>the file contents encoded with base64.</DL>
</DD>
</DL>
<HR>

<A NAME="readFileContents(java.lang.String, java.lang.String)"><!-- --></A><H3>
readFileContents</H3>
<PRE>
public static java.lang.String <B>readFileContents</B>(java.lang.String&nbsp;targetLocationProperty,
                                                java.lang.String&nbsp;fileName)</PRE>
<DL>
<DD>Return the content of file encoded for transfer<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file:</CODE> - path to file to encode.<DT><B>Returns:</B><DD>String encoded contents of the requested file.</DL>
</DD>
</DL>
<HR>

<A NAME="writeFileContents(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
writeFileContents</H3>
<PRE>
public static boolean <B>writeFileContents</B>(java.lang.String&nbsp;fileContents,
                                        java.lang.String&nbsp;targetLocationProperty,
                                        java.lang.String&nbsp;fileName)</PRE>
<DL>
</DL>
<HR>

<A NAME="remove(java.lang.String, java.lang.String)"><!-- --></A><H3>
remove</H3>
<PRE>
public static void <B>remove</B>(java.lang.String&nbsp;sourceLocationProperty,
                          java.lang.String&nbsp;sourceFileName)</PRE>
<DL>
<DD>Method to allow a client to remove a file from
 the server<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serverURL</CODE> - &nbsp;<DD><CODE>sourceLocationProperty</CODE> - &nbsp;<DD><CODE>sourceFileName</CODE> - &nbsp;</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FileHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/apache/turbine/services/xmlrpc/util/AuthenticatedFileHandler.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/turbine/services/xmlrpc/util/FileTransfer.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="FileHandler.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2000-2002 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>