<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Mon Oct 21 11:07:36 UTC 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ServerAcl (HSQLDB 2.2.9 API)</title>
<meta name="date" content="2013-10-21">
<link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ServerAcl (HSQLDB 2.2.9 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ServerAcl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/hsqldb/server/Server.html" title="class in org.hsqldb.server"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hsqldb/server/ServerAcl.AclFormatException.html" title="class in org.hsqldb.server"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hsqldb/server/ServerAcl.html" target="_top">Frames</a></li>
<li><a href="ServerAcl.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.hsqldb.server</div>
<h2 title="Class ServerAcl" class="title">Class ServerAcl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.hsqldb.server.ServerAcl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">ServerAcl</span>
extends java.lang.Object</pre>
<div class="block">A list of ACL permit and deny entries with a permitAccess method
which tells whether candidate addresses are permitted or denied
by this ACL list.
<P>
The ACL file is reloaded whenever a modification to it is detected.
If you copy in a file with an older file date, you will need to touch it.
</P>
<P>
The public runtime method is permitAccess().
The public setup method is the constructor.
</P> <P>
Each non-comment line in the ACL file must be a rule of the format:
<PRE><CODE>
{allow|deny} <ip_address>[/significant-bits]
</CODE></PRE>
For example
<PRE><CODE>
allow ahostname
deny ahost.domain.com
allow 127.0.0.1
allow 2001:db8::/32
</CODE></PRE>
</P> <P>
In order to detect bit specification mistakes, we require that
non-significant bits be zero in the values.
An undesirable consequence of this is, you can't use a specification like
the following to mean "all of the hosts on the same network as x.admc.com":
<PRE><CODE>
allow x.admc.com/24
</CODE></PRE>
</P></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/server/ServerAcl.html#ServerAcl(java.io.File)"><code>ServerAcl(File)</code></a>,
<a href="../../../org/hsqldb/server/ServerAcl.html#permitAccess(java.lang.String)"><code>permitAccess(java.lang.String)</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.AclFormatException.html" title="class in org.hsqldb.server">ServerAcl.AclFormatException</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#ServerAcl(java.io.File)">ServerAcl</a></strong>(java.io.File aclFile)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#colonNotation(byte[])">colonNotation</a></strong>(byte[] uba)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#dottedNotation(byte[])">dottedNotation</a></strong>(byte[] uba)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] sa)</code>
<div class="block">Utility method that allows interactive testing of individal
ACL records, as well as the net effect of the ACL record list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#permitAccess(byte[])">permitAccess</a></strong>(byte[] addr)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#permitAccess(java.lang.String)">permitAccess</a></strong>(java.lang.String s)</code>
<div class="block">Uses system network libraries to resolve the given String to an IP addr,
then determine whether this address is permitted or denied.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#setPrintWriter(java.io.PrintWriter)">setPrintWriter</a></strong>(java.io.PrintWriter pw)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/server/ServerAcl.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ServerAcl(java.io.File)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServerAcl</h4>
<pre>public ServerAcl(java.io.File aclFile)
throws java.io.IOException,
<a href="../../../org/hsqldb/server/ServerAcl.AclFormatException.html" title="class in org.hsqldb.server">ServerAcl.AclFormatException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code><a href="../../../org/hsqldb/server/ServerAcl.AclFormatException.html" title="class in org.hsqldb.server">ServerAcl.AclFormatException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="dottedNotation(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dottedNotation</h4>
<pre>public static java.lang.String dottedNotation(byte[] uba)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uba</code> - Unsigned byte array</dd></dl>
</li>
</ul>
<a name="colonNotation(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>colonNotation</h4>
<pre>public static java.lang.String colonNotation(byte[] uba)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uba</code> - Unsigned byte array</dd></dl>
</li>
</ul>
<a name="setPrintWriter(java.io.PrintWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrintWriter</h4>
<pre>public void setPrintWriter(java.io.PrintWriter pw)</pre>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="permitAccess(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>permitAccess</h4>
<pre>public boolean permitAccess(java.lang.String s)</pre>
<div class="block">Uses system network libraries to resolve the given String to an IP addr,
then determine whether this address is permitted or denied.
Specified name may be a numerical-based String like "1.2.3.4", a
constant known to the networking libraries, or a host name to be
resolved by the systems name resolution system.
If the given String can't be resolved to an IP addr, false is returned.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/hsqldb/server/ServerAcl.html#permitAccess(byte[])"><code>permitAccess(byte[])</code></a></dd></dl>
</li>
</ul>
<a name="permitAccess(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>permitAccess</h4>
<pre>public boolean permitAccess(byte[] addr)</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if access for the candidate address should be permitted,
false if access should be denied.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.RuntimeException</code> - if no rule covers the candidate address.
This would be the case if this class is applied to some
network protocol other than ipv4 or ipv6, without adding a
default rule for it.</dd></dl>
</li>
</ul>
<a name="main(java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(java.lang.String[] sa)
throws <a href="../../../org/hsqldb/server/ServerAcl.AclFormatException.html" title="class in org.hsqldb.server">ServerAcl.AclFormatException</a>,
java.io.IOException</pre>
<div class="block">Utility method that allows interactive testing of individal
ACL records, as well as the net effect of the ACL record list.
Run "java -cp path/to/hsqldb.jar org.hsqldb.server.ServerAcl --help"
for Syntax help.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../org/hsqldb/server/ServerAcl.AclFormatException.html" title="class in org.hsqldb.server">ServerAcl.AclFormatException</a></code></dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ServerAcl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/hsqldb/server/Server.html" title="class in org.hsqldb.server"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hsqldb/server/ServerAcl.AclFormatException.html" title="class in org.hsqldb.server"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hsqldb/server/ServerAcl.html" target="_top">Frames</a></li>
<li><a href="ServerAcl.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright �� 2001 - 2010 HSQL Development Group.</i></small></p>
</body>
</html>
