893 lines
22 KiB
HTML
893 lines
22 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
||
|
|
<!--NewPage-->
|
||
|
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<TITLE>
|
||
|
|
jala.RemoteContent
|
||
|
|
</TITLE>
|
||
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||
|
|
</HEAD>
|
||
|
|
<SCRIPT>
|
||
|
|
function asd()
|
||
|
|
{
|
||
|
|
parent.document.title="jala.RemoteContent";
|
||
|
|
}
|
||
|
|
</SCRIPT>
|
||
|
|
<BODY BGCOLOR="white" onload="asd();">
|
||
|
|
|
||
|
|
<!-- ========== START OF NAVBAR ========== -->
|
||
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
||
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
||
|
|
<TR>
|
||
|
|
<TD COLSPAN=3 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> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-RemoteContent.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
</TD>
|
||
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||
|
|
<B>Jala 1.3</B>
|
||
|
|
</EM>
|
||
|
|
</TD
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="jala.PodcastWriter.html"><B>PREV CLASS</B></A><!--
|
||
|
|
NEXT CLASS
|
||
|
|
-->
|
||
|
|
<A HREF="jala.Rss20Writer.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>
|
||
|
|
<A HREF="jala.RemoteContent.html" TARGET="_top"><B>NO FRAMES</B></A>
|
||
|
|
|
||
|
|
<SCRIPT>
|
||
|
|
<!--
|
||
|
|
if(window==top) {
|
||
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</SCRIPT>
|
||
|
|
<NOSCRIPT>
|
||
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
||
|
|
</NOSCRIPT>
|
||
|
|
</FONT></TD>
|
||
|
|
</TR>
|
||
|
|
<TR>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<!-- =========== END OF NAVBAR =========== -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
|
<H2>Class jala.RemoteContent</H2>
|
||
|
|
<PRE>Object
|
||
|
|
|
|
||
|
|
+--helma.Http
|
||
|
|
|
|
||
|
|
+--<b>jala.RemoteContent</b>
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
<DL>
|
||
|
|
<!-- Class definition -->
|
||
|
|
<DT>class
|
||
|
|
<B>jala.RemoteContent</B>
|
||
|
|
|
||
|
|
<DT>extends helma.Http
|
||
|
|
|
||
|
|
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<BR/>API to define, fetch and update content
|
||
|
|
from a remote site.
|
||
|
|
<BR/><I>Defined in <a href='overview-summary-RemoteContent.js.html'>RemoteContent.js</a></I><BR/><BR/>
|
||
|
|
</P>
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
|
|
||
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
|
||
|
|
<A NAME="field_summary"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
||
|
|
<B>Field Summary</B></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<!-- This is one instance field summary -->
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> File</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!CACHEDIR">CACHEDIR</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
The default cache directory.</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!HTTP">HTTP</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
A constant representing the HTTP retrieval method.</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> String</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!SUFFIX">SUFFIX</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
The default name of the cache directory.</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!XMLRPC">XMLRPC</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
A constant representing the XML-RPC retrieval method.</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== END FIELD SUMMARY =========== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
|
||
|
|
<A NAME="constructor_summary"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
||
|
|
<B>Constructor Summary</B></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="jala.RemoteContent.html#jala.RemoteContent()">jala.RemoteContent</A>
|
||
|
|
</B>
|
||
|
|
(<String> url, <Integer> method, <File> storage)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Construct a new remote content handler.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
|
|
||
|
|
<A NAME="method_summary"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
||
|
|
<B>Method Summary</B></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> void</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#clear">clear</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Flushes (empties) the cached remote content.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#get">get</A></B>(<String> key)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Get an arbitrary property of the remote content.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Array</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#getKeys">getKeys</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Get all available property names.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Boolean</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#needsUpdate">needsUpdate</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Tests whether the remote content needs to be updated.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> void</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#setInterval">setInterval</A></B>(<Number> interval)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Set the interval the remote content's
|
||
|
|
cache is bound to be updated.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> String</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#toString">toString</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Get a string representation of the remote content.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> String</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#update">update</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Get the updated and cached remote content.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#valueOf">valueOf</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Get the value of the remote content.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE><static> void</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#!s!exec">exec</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Apply a custom method on all remote content in a file-based cache.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE><static> void</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#!s!flush">flush</A></B>(<File> cache)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Remove all remote content from a file-based cache.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE><static> void</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#!s!forEach">forEach</A></B>(<Function> callback, <File> cache)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Apply a custom method on all remote content in a file-based cache.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
||
|
|
|
||
|
|
<A NAME="field_detail"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
|
||
|
|
<A NAME="!s!CACHEDIR"><!-- --></A>
|
||
|
|
<H3>CACHEDIR</H3>
|
||
|
|
<PRE><static> <final> File <B>CACHEDIR</B></PRE>
|
||
|
|
<UL>
|
||
|
|
The default cache directory.
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!HTTP"><!-- --></A>
|
||
|
|
<H3>HTTP</H3>
|
||
|
|
<PRE><static> <final> int <B>HTTP</B></PRE>
|
||
|
|
<UL>
|
||
|
|
A constant representing the HTTP retrieval method.
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!SUFFIX"><!-- --></A>
|
||
|
|
<H3>SUFFIX</H3>
|
||
|
|
<PRE><static> <final> String <B>SUFFIX</B></PRE>
|
||
|
|
<UL>
|
||
|
|
The default name of the cache directory.
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!XMLRPC"><!-- --></A>
|
||
|
|
<H3>XMLRPC</H3>
|
||
|
|
<PRE><static> <final> int <B>XMLRPC</B></PRE>
|
||
|
|
<UL>
|
||
|
|
A constant representing the XML-RPC retrieval method.
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============ FIELD DETAIL END =========== -->
|
||
|
|
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
||
|
|
|
||
|
|
<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="jala.RemoteContent()"><!-- --></A><H3>
|
||
|
|
jala.RemoteContent</H3>
|
||
|
|
<PRE><B>jala.RemoteContent</B>(<String> url, <Integer> method, <File> storage)</PRE>
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
Construct a new remote content handler.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>url</CODE> - The URL string of the remote site.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<UL><CODE>method</CODE> - The method to retrieve the remote content.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<UL><CODE>storage</CODE> - The cache directory.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Constructor return value(s) -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
A new remote content handler.
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- End constructor return value(s) -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES -->
|
||
|
|
|
||
|
|
<HR/>
|
||
|
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
||
|
|
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============ METHOD DETAIL START ========== -->
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<!-- One single method detail entry -->
|
||
|
|
|
||
|
|
<A NAME="clear"><!-- --></A>
|
||
|
|
<H3>clear</H3>
|
||
|
|
<PRE>void <B>clear</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Flushes (empties) the cached remote content.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="get"><!-- --></A>
|
||
|
|
<H3>get</H3>
|
||
|
|
<PRE>Object <B>get</B>(<String> key)</PRE>
|
||
|
|
|
||
|
|
<UL>Get an arbitrary property of the remote content.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>key</CODE> - The name of the property.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
The value of the property.
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getKeys"><!-- --></A>
|
||
|
|
<H3>getKeys</H3>
|
||
|
|
<PRE>Array <B>getKeys</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Get all available property names.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
The list of property names.
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="needsUpdate"><!-- --></A>
|
||
|
|
<H3>needsUpdate</H3>
|
||
|
|
<PRE>Boolean <B>needsUpdate</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Tests whether the remote content needs to be updated.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
True if the remote content needs to be updated.
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setInterval"><!-- --></A>
|
||
|
|
<H3>setInterval</H3>
|
||
|
|
<PRE>void <B>setInterval</B>(<Number> interval)</PRE>
|
||
|
|
|
||
|
|
<UL>Set the interval the remote content's
|
||
|
|
cache is bound to be updated.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>interval</CODE> - The interval value in milliseconds.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="toString"><!-- --></A>
|
||
|
|
<H3>toString</H3>
|
||
|
|
<PRE>String <B>toString</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Get a string representation of the remote content.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
The remote content as string.
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="update"><!-- --></A>
|
||
|
|
<H3>update</H3>
|
||
|
|
<PRE>String <B>update</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Get the updated and cached remote content.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
The content as retrieved from the remote site.
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="valueOf"><!-- --></A>
|
||
|
|
<H3>valueOf</H3>
|
||
|
|
<PRE>Object <B>valueOf</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Get the value of the remote content.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
The remote content including response header data.
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!exec"><!-- --></A>
|
||
|
|
<H3>exec</H3>
|
||
|
|
<PRE><static> void <B>exec</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Apply a custom method on all remote content in a file-based cache.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>callback</CODE> - The callback method to be executed for each remote content file.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<UL><CODE>cache</CODE> - An optional target directory.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Deprecated</B> <I>Use <a href="#!s!forEach">forEach()</a> instead. </I><BR/><BR/>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!flush"><!-- --></A>
|
||
|
|
<H3>flush</H3>
|
||
|
|
<PRE><static> void <B>flush</B>(<File> cache)</PRE>
|
||
|
|
|
||
|
|
<UL>Remove all remote content from a file-based cache.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>cache</CODE> - An optional target directory.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!forEach"><!-- --></A>
|
||
|
|
<H3>forEach</H3>
|
||
|
|
<PRE><static> void <B>forEach</B>(<Function> callback, <File> cache)</PRE>
|
||
|
|
|
||
|
|
<UL>Apply a custom method on all remote content in a file-based cache.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>callback</CODE> - The callback method to be executed for each remote content file.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<UL><CODE>cache</CODE> - An optional target directory.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============ METHOD DETAIL END ========== -->
|
||
|
|
|
||
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
|
|
||
|
|
<!-- ========== START OF NAVBAR ========== -->
|
||
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
||
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
||
|
|
<TR>
|
||
|
|
<TD COLSPAN=3 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> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-RemoteContent.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
||
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
</TD>
|
||
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||
|
|
<B>Jala 1.3</B>
|
||
|
|
</EM>
|
||
|
|
</TD
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="jala.PodcastWriter.html"><B>PREV CLASS</B></A><!--
|
||
|
|
NEXT CLASS
|
||
|
|
-->
|
||
|
|
<A HREF="jala.Rss20Writer.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>
|
||
|
|
<A HREF="jala.RemoteContent.html" TARGET="_top"><B>NO FRAMES</B></A>
|
||
|
|
|
||
|
|
<SCRIPT>
|
||
|
|
<!--
|
||
|
|
if(window==top) {
|
||
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
</SCRIPT>
|
||
|
|
<NOSCRIPT>
|
||
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
||
|
|
</NOSCRIPT>
|
||
|
|
</FONT></TD>
|
||
|
|
</TR>
|
||
|
|
<TR>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<!-- =========== END OF NAVBAR =========== -->
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
|
||
|
|
</FONT>
|
||
|
|
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan 8 15:45:31 2008</div>
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|