Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 0.8.4 / apidocs / org / apache / mina / io / filter / BlacklistFilter.html
blob: c78786e5e499d6d26443dfd2f1fa06e9db262ad1 [file] [log] [blame]
<!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 (1.8.0_191) on Fri Mar 15 10:07:11 CET 2019 -->
<title>BlacklistFilter (Apache MINA API Documentation)</title>
<meta name="date" content="2019-03-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BlacklistFilter (Apache MINA API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/BlacklistFilter.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/mina/io/filter/IoLoggingFilter.html" title="class in org.apache.mina.io.filter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/io/filter/BlacklistFilter.html" target="_top">Frames</a></li>
<li><a href="BlacklistFilter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.apache.mina.io.filter</div>
<h2 title="Class BlacklistFilter" class="title">Class BlacklistFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/mina/io/IoFilterAdapter.html" title="class in org.apache.mina.io">org.apache.mina.io.IoFilterAdapter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mina.io.filter.BlacklistFilter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/mina/io/IoFilter.html" title="interface in org.apache.mina.io">IoFilter</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">BlacklistFilter</span>
extends <a href="../../../../../org/apache/mina/io/IoFilterAdapter.html" title="class in org.apache.mina.io">IoFilterAdapter</a></pre>
<div class="block">A <a href="../../../../../org/apache/mina/io/IoFilter.html" title="interface in org.apache.mina.io"><code>IoFilter</code></a> which blocks connections from blacklisted remote
address.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 326586 $, $Date: 2005-10-19 17:50:29 +0200 (Wed, 19 Oct 2005) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache Directory Project (dev@directory.apache.org)</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.mina.io.IoFilter">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.mina.io.<a href="../../../../../org/apache/mina/io/IoFilter.html" title="interface in org.apache.mina.io">IoFilter</a></h3>
<code><a href="../../../../../org/apache/mina/io/IoFilter.NextFilter.html" title="interface in org.apache.mina.io">IoFilter.NextFilter</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/io/filter/BlacklistFilter.html#BlacklistFilter--">BlacklistFilter</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/io/filter/BlacklistFilter.html#block-java.net.InetAddress-">block</a></span>(java.net.InetAddress&nbsp;address)</code>
<div class="block">Blocks the specified endpoint.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/io/filter/BlacklistFilter.html#dataRead-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-org.apache.mina.common.ByteBuffer-">dataRead</a></span>(<a href="../../../../../org/apache/mina/io/IoFilter.NextFilter.html" title="interface in org.apache.mina.io">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io">IoSession</a>&nbsp;session,
<a href="../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</a>&nbsp;buf)</code>
<div class="block">Forwards event if and if only the remote address of session is not
blacklisted.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/io/filter/BlacklistFilter.html#sessionOpened-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-">sessionOpened</a></span>(<a href="../../../../../org/apache/mina/io/IoFilter.NextFilter.html" title="interface in org.apache.mina.io">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io">IoSession</a>&nbsp;session)</code>
<div class="block">Close connection immediately if the remote address of session is
blacklisted.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/io/filter/BlacklistFilter.html#unblock-java.net.InetAddress-">unblock</a></span>(java.net.InetAddress&nbsp;address)</code>
<div class="block">Unblocks the specified endpoint.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.io.IoFilterAdapter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mina.io.<a href="../../../../../org/apache/mina/io/IoFilterAdapter.html" title="class in org.apache.mina.io">IoFilterAdapter</a></h3>
<code><a href="../../../../../org/apache/mina/io/IoFilterAdapter.html#dataWritten-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-java.lang.Object-">dataWritten</a>, <a href="../../../../../org/apache/mina/io/IoFilterAdapter.html#exceptionCaught-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-java.lang.Throwable-">exceptionCaught</a>, <a href="../../../../../org/apache/mina/io/IoFilterAdapter.html#filterWrite-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-org.apache.mina.common.ByteBuffer-java.lang.Object-">filterWrite</a>, <a href="../../../../../org/apache/mina/io/IoFilterAdapter.html#sessionClosed-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-">sessionClosed</a>, <a href="../../../../../org/apache/mina/io/IoFilterAdapter.html#sessionIdle-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-org.apache.mina.common.IdleStatus-">sessionIdle</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="BlacklistFilter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BlacklistFilter</h4>
<pre>public&nbsp;BlacklistFilter()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="block-java.net.InetAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>block</h4>
<pre>public&nbsp;void&nbsp;block(java.net.InetAddress&nbsp;address)</pre>
<div class="block">Blocks the specified endpoint.</div>
</li>
</ul>
<a name="unblock-java.net.InetAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unblock</h4>
<pre>public&nbsp;void&nbsp;unblock(java.net.InetAddress&nbsp;address)</pre>
<div class="block">Unblocks the specified endpoint.</div>
</li>
</ul>
<a name="dataRead-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-org.apache.mina.common.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dataRead</h4>
<pre>public&nbsp;void&nbsp;dataRead(<a href="../../../../../org/apache/mina/io/IoFilter.NextFilter.html" title="interface in org.apache.mina.io">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io">IoSession</a>&nbsp;session,
<a href="../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</a>&nbsp;buf)
throws java.lang.Exception</pre>
<div class="block">Forwards event if and if only the remote address of session is not
blacklisted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/io/IoFilter.html#dataRead-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-org.apache.mina.common.ByteBuffer-">dataRead</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/io/IoFilter.html" title="interface in org.apache.mina.io">IoFilter</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/io/IoFilterAdapter.html#dataRead-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-org.apache.mina.common.ByteBuffer-">dataRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/mina/io/IoFilterAdapter.html" title="class in org.apache.mina.io">IoFilterAdapter</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="sessionOpened-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sessionOpened</h4>
<pre>public&nbsp;void&nbsp;sessionOpened(<a href="../../../../../org/apache/mina/io/IoFilter.NextFilter.html" title="interface in org.apache.mina.io">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../../org/apache/mina/io/IoSession.html" title="interface in org.apache.mina.io">IoSession</a>&nbsp;session)
throws java.lang.Exception</pre>
<div class="block">Close connection immediately if the remote address of session is
blacklisted.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/io/IoFilter.html#sessionOpened-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-">sessionOpened</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/mina/io/IoFilter.html" title="interface in org.apache.mina.io">IoFilter</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/mina/io/IoFilterAdapter.html#sessionOpened-org.apache.mina.io.IoFilter.NextFilter-org.apache.mina.io.IoSession-">sessionOpened</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/mina/io/IoFilterAdapter.html" title="class in org.apache.mina.io">IoFilterAdapter</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/BlacklistFilter.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/mina/io/filter/IoLoggingFilter.html" title="class in org.apache.mina.io.filter"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/io/filter/BlacklistFilter.html" target="_top">Frames</a></li>
<li><a href="BlacklistFilter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>