851 lines
22 KiB
HTML
851 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.db.Server
|
||
|
</TITLE>
|
||
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||
|
</HEAD>
|
||
|
<SCRIPT>
|
||
|
function asd()
|
||
|
{
|
||
|
parent.document.title="jala.db.Server";
|
||
|
}
|
||
|
</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-Database.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.db.RamDatabase.html"><B>PREV CLASS</B></A><!--
|
||
|
NEXT CLASS
|
||
|
-->
|
||
|
<A HREF="jala.DnsClient.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.db.Server.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.db.Server</H2>
|
||
|
<PRE>Object
|
||
|
|
|
||
|
+--<b>jala.db.Server</b>
|
||
|
</PRE>
|
||
|
|
||
|
|
||
|
<HR>
|
||
|
<DL>
|
||
|
<!-- Class definition -->
|
||
|
<DT>class
|
||
|
<B>jala.db.Server</B>
|
||
|
|
||
|
|
||
|
</DL>
|
||
|
|
||
|
<P>
|
||
|
<BR/>Instances of this class represent a H2 database listener that
|
||
|
allows multiple databases to be accessed via tcp.
|
||
|
<br /><strong>Important:</strong> You need the h2.jar in directory "lib/ext"
|
||
|
of your helma installation for this library to work, which you can get
|
||
|
at http://www.h2database.com/.
|
||
|
<BR/><I>Defined in <a href='overview-summary-Database.js.html'>Database.js</a></I><BR/><BR/>
|
||
|
</P>
|
||
|
|
||
|
<HR>
|
||
|
|
||
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
|
||
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||
|
|
||
|
|
||
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<!-- =========== 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.db.Server.html#jala.db.Server()">jala.db.Server</A>
|
||
|
</B>
|
||
|
(<helma.File> baseDir, <Number> port)
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Returns a new Server instance.
|
||
|
</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> Boolean</CODE>
|
||
|
</FONT>
|
||
|
</TD>
|
||
|
<TD>
|
||
|
<CODE>
|
||
|
<B>
|
||
|
<A HREF="#createOnDemand">createOnDemand</A></B>(<Boolean> bool)
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
If called with boolean true as argument, this server creates databases
|
||
|
on-the-fly, otherwise it only accepts connections to already existing
|
||
|
databases.
|
||
|
</TD>
|
||
|
</TR>
|
||
|
|
||
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
<FONT SIZE="-1">
|
||
|
<CODE> helma.Database</CODE>
|
||
|
</FONT>
|
||
|
</TD>
|
||
|
<TD>
|
||
|
<CODE>
|
||
|
<B>
|
||
|
<A HREF="#getConnection">getConnection</A></B>(<String> name, <String> username, <String> password, <Object> props)
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Returns a connection to a database within this server.
|
||
|
</TD>
|
||
|
</TR>
|
||
|
|
||
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
<FONT SIZE="-1">
|
||
|
<CODE> helma.File</CODE>
|
||
|
</FONT>
|
||
|
</TD>
|
||
|
<TD>
|
||
|
<CODE>
|
||
|
<B>
|
||
|
<A HREF="#getDirectory">getDirectory</A></B>()
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Returns the directory used by this server instance
|
||
|
</TD>
|
||
|
</TR>
|
||
|
|
||
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
<FONT SIZE="-1">
|
||
|
<CODE> Number</CODE>
|
||
|
</FONT>
|
||
|
</TD>
|
||
|
<TD>
|
||
|
<CODE>
|
||
|
<B>
|
||
|
<A HREF="#getPort">getPort</A></B>()
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Returns the port this server listens on
|
||
|
</TD>
|
||
|
</TR>
|
||
|
|
||
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
<FONT SIZE="-1">
|
||
|
<CODE> helma.util.ResourceProperties</CODE>
|
||
|
</FONT>
|
||
|
</TD>
|
||
|
<TD>
|
||
|
<CODE>
|
||
|
<B>
|
||
|
<A HREF="#getProperties">getProperties</A></B>(<String> name, <String> username, <String> password, <Object> props)
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Returns a properties object containing the connection properties
|
||
|
of the database with the given name.
|
||
|
</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="#getUrl">getUrl</A></B>(<String> name, <Object> props)
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Returns the JDBC Url to use for connections to a given database.
|
||
|
</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="#isPublic">isPublic</A></B>(<Boolean> bool)
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
If called with boolean true as argument, this server accepts connections
|
||
|
from outside localhost.
|
||
|
</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="#isRunning">isRunning</A></B>()
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Returns true if the database server is running.
|
||
|
</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="#start">start</A></B>()
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Starts the database server.
|
||
|
</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="#stop">stop</A></B>()
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Stops the database server.
|
||
|
</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="#useSsl">useSsl</A></B>(<Boolean> bool)
|
||
|
</CODE>
|
||
|
<BR>
|
||
|
|
||
|
Toggles the use of Ssl encryption within this server.
|
||
|
</TD>
|
||
|
</TR>
|
||
|
|
||
|
|
||
|
</TABLE>
|
||
|
|
||
|
|
||
|
|
||
|
<P>
|
||
|
<!-- ========== END METHOD SUMMARY =========== -->
|
||
|
|
||
|
|
||
|
<!-- ============ FIELD DETAIL START =========== -->
|
||
|
|
||
|
|
||
|
<!-- ============ 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.db.Server()"><!-- --></A><H3>
|
||
|
jala.db.Server</H3>
|
||
|
<PRE><B>jala.db.Server</B>(<helma.File> baseDir, <Number> port)</PRE>
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
Returns a new Server instance.
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Parameters:</B>
|
||
|
|
||
|
<UL><CODE>baseDir</CODE> - The directory where the database files are located or should be stored
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>port</CODE> - The port to listen on (defaults to 9001)
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>createOnDemand</CODE> - If true this server will create non-existing databases on-the-fly, if false it only accepts connections to already existing databases in the given base directory
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>makePublic</CODE> - If true this database is reachable from outside, if false it's only reachable from localhost
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>useSsl</CODE> - If true SSL will be used to encrypt the connection
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- Constructor return value(s) -->
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
A newly created Server instance
|
||
|
</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="createOnDemand"><!-- --></A>
|
||
|
<H3>createOnDemand</H3>
|
||
|
<PRE>Boolean <B>createOnDemand</B>(<Boolean> bool)</PRE>
|
||
|
|
||
|
<UL>If called with boolean true as argument, this server creates databases
|
||
|
on-the-fly, otherwise it only accepts connections to already existing
|
||
|
databases. This should be set before starting the server.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<UL>
|
||
|
<B>Parameters:</B>
|
||
|
|
||
|
<UL><CODE>bool</CODE> - If true this server creates non-existing databases on demand, if false it only allows connections to existing databases. If no argument is given, this method returns the current setting.
|
||
|
</UL>
|
||
|
|
||
|
</UL>
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
The current setting if no argument is given, or void
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="getConnection"><!-- --></A>
|
||
|
<H3>getConnection</H3>
|
||
|
<PRE>helma.Database <B>getConnection</B>(<String> name, <String> username, <String> password, <Object> props)</PRE>
|
||
|
|
||
|
<UL>Returns a connection to a database within this server.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<UL>
|
||
|
<B>Parameters:</B>
|
||
|
|
||
|
<UL><CODE>name</CODE> - The name of the database running within this server
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>username</CODE> - Optional username to use for this connection
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>password</CODE> - Optional password to use for this connection
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>props</CODE> - An optional parameter object containing connection properties to add to the connection Url.
|
||
|
</UL>
|
||
|
|
||
|
</UL>
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
A connection to the specified database
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="getDirectory"><!-- --></A>
|
||
|
<H3>getDirectory</H3>
|
||
|
<PRE>helma.File <B>getDirectory</B>()</PRE>
|
||
|
|
||
|
<UL>Returns the directory used by this server instance</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
The directory where the databases used by this server are located in
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="getPort"><!-- --></A>
|
||
|
<H3>getPort</H3>
|
||
|
<PRE>Number <B>getPort</B>()</PRE>
|
||
|
|
||
|
<UL>Returns the port this server listens on</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
The port this server listens on
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="getProperties"><!-- --></A>
|
||
|
<H3>getProperties</H3>
|
||
|
<PRE>helma.util.ResourceProperties <B>getProperties</B>(<String> name, <String> username, <String> password, <Object> props)</PRE>
|
||
|
|
||
|
<UL>Returns a properties object containing the connection properties
|
||
|
of the database with the given name.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<UL>
|
||
|
<B>Parameters:</B>
|
||
|
|
||
|
<UL><CODE>name</CODE> - The name of the database
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>username</CODE> - Optional username to use for this connection
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>password</CODE> - Optional password to use for this connection
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>props</CODE> - An optional parameter object containing connection properties to add to the connection Url.
|
||
|
</UL>
|
||
|
|
||
|
</UL>
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
A properties object containing the connection properties
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="getUrl"><!-- --></A>
|
||
|
<H3>getUrl</H3>
|
||
|
<PRE>String <B>getUrl</B>(<String> name, <Object> props)</PRE>
|
||
|
|
||
|
<UL>Returns the JDBC Url to use for connections to a given database.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<UL>
|
||
|
<B>Parameters:</B>
|
||
|
|
||
|
<UL><CODE>name</CODE> - An optional name of a database running
|
||
|
</UL>
|
||
|
|
||
|
<UL><CODE>props</CODE> - Optional connection properties to add
|
||
|
</UL>
|
||
|
|
||
|
</UL>
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
The JDBC Url to use for connecting to a database within this sever
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="isPublic"><!-- --></A>
|
||
|
<H3>isPublic</H3>
|
||
|
<PRE>Boolean <B>isPublic</B>(<Boolean> bool)</PRE>
|
||
|
|
||
|
<UL>If called with boolean true as argument, this server accepts connections
|
||
|
from outside localhost. This should be set before starting the server.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<UL>
|
||
|
<B>Parameters:</B>
|
||
|
|
||
|
<UL><CODE>bool</CODE> - If true this server accepts connections from outside localhost. If no argument is given, this method returns the current setting.
|
||
|
</UL>
|
||
|
|
||
|
</UL>
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
The current setting if no argument is given, or void
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="isRunning"><!-- --></A>
|
||
|
<H3>isRunning</H3>
|
||
|
<PRE>Boolean <B>isRunning</B>()</PRE>
|
||
|
|
||
|
<UL>Returns true if the database server is running.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
True if the database server is running
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="start"><!-- --></A>
|
||
|
<H3>start</H3>
|
||
|
<PRE>Boolean <B>start</B>()</PRE>
|
||
|
|
||
|
<UL>Starts the database server.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
True in case the server started successfully, false otherwise
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="stop"><!-- --></A>
|
||
|
<H3>stop</H3>
|
||
|
<PRE>Boolean <B>stop</B>()</PRE>
|
||
|
|
||
|
<UL>Stops the database server.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
True if stopping the server was successful, false otherwise
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
||
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
<HR>
|
||
|
|
||
|
<A NAME="useSsl"><!-- --></A>
|
||
|
<H3>useSsl</H3>
|
||
|
<PRE>Boolean <B>useSsl</B>(<Boolean> bool)</PRE>
|
||
|
|
||
|
<UL>Toggles the use of Ssl encryption within this server. This should be set
|
||
|
before starting the server.</UL>
|
||
|
|
||
|
|
||
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
||
|
<UL>
|
||
|
<B>Parameters:</B>
|
||
|
|
||
|
<UL><CODE>bool</CODE> - If true SSL encryption will be used, false otherwise. If no argument is given, this method returns the current setting.
|
||
|
</UL>
|
||
|
|
||
|
</UL>
|
||
|
|
||
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
||
|
|
||
|
<UL>
|
||
|
<B>Returns:</B>
|
||
|
<UL>
|
||
|
The current setting if no argument is given, or void
|
||
|
</UL>
|
||
|
</UL>
|
||
|
|
||
|
|
||
|
<!-- 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-Database.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.db.RamDatabase.html"><B>PREV CLASS</B></A><!--
|
||
|
NEXT CLASS
|
||
|
-->
|
||
|
<A HREF="jala.DnsClient.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.db.Server.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>
|