Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 1.1.0 / apidocs / org / apache / mina / integration / spring / Binding.html
blob: e62eb9112c950e7fc72325d67c8f10131b3d3da0 [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 Sat Mar 16 10:06:17 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Binding (Apache MINA 1.1.0 API Documentation)</title>
<meta name="date" content="2019-03-16">
<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="Binding (Apache MINA 1.1.0 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/Binding.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/integration/spring/DefaultIoFilterChainBuilderFactoryBean.html" title="class in org.apache.mina.integration.spring"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/integration/spring/Binding.html" target="_top">Frames</a></li>
<li><a href="Binding.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.integration.spring</div>
<h2 title="Class Binding" class="title">Class Binding</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.mina.integration.spring.Binding</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.springframework.beans.factory.InitializingBean</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Binding</span>
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean</pre>
<div class="block">Defines an address to <a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common"><code>IoHandler</code></a> binding.
This is used when specifying the addresses to accept new connections on when
creating <a href="../../../../../org/apache/mina/common/IoAcceptor.html" title="interface in org.apache.mina.common"><code>IoAcceptor</code></a> objects using
<a href="../../../../../org/apache/mina/integration/spring/IoAcceptorFactoryBean.html" title="class in org.apache.mina.integration.spring"><code>IoAcceptorFactoryBean</code></a>.
<p>
Note that the <code>address</code> property is of <code>SocketAddress</code>
type. Use <a href="../../../../../org/apache/mina/integration/spring/InetSocketAddressEditor.html" title="class in org.apache.mina.integration.spring"><code>InetSocketAddressEditor</code></a> or <a href="../../../../../org/apache/mina/integration/spring/VmPipeAddressEditor.html" title="class in org.apache.mina.integration.spring"><code>VmPipeAddressEditor</code></a> in
your Spring configuration file to simply the creation of
<code>SocketAddress</code> instances using Spring.
</p>
<p>
This class also allows for an optional service configuration using
<a href="../../../../../org/apache/mina/integration/spring/Binding.html#setServiceConfig-org.apache.mina.common.IoServiceConfig-"><code>setServiceConfig(IoServiceConfig)</code></a> to be specified. If the binding
specifies an <a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common"><code>IoServiceConfig</code></a> <a href="../../../../../org/apache/mina/integration/spring/IoAcceptorFactoryBean.html" title="class in org.apache.mina.integration.spring"><code>IoAcceptorFactoryBean</code></a> will
use <a href="../../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-org.apache.mina.common.IoServiceConfig-"><code>IoAcceptor.bind(SocketAddress, IoHandler, IoServiceConfig)</code></a> instead
of <a href="../../../../../org/apache/mina/common/IoAcceptor.html#bind-java.net.SocketAddress-org.apache.mina.common.IoHandler-"><code>IoAcceptor.bind(SocketAddress, IoHandler)</code></a> when binding. The
<a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common"><code>IoServiceConfig</code></a> object lets you specify transport specific
confiuration options and define port specific filters. This makes it possible
to specify different filters depending on the port the client is connecting
on (e.g. using an <a href="../../../../../org/apache/mina/filter/SSLFilter.html" title="class in org.apache.mina.filter"><code>SSLFilter</code></a> when connecting
on port 443 but not on port 80).
</p></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 437002 $, $Date: 2006-08-26 00:47:20 +0200 (Sat, 26 Aug 2006) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache Directory Project (mina-dev@directory.apache.org)</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/integration/spring/Binding.html#Binding--">Binding</a></span>()</code>
<div class="block">Creates a new empty instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#Binding-java.net.SocketAddress-org.apache.mina.common.IoHandler-">Binding</a></span>(java.net.SocketAddress&nbsp;address,
<a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a>&nbsp;handler)</code>
<div class="block">Creates a new instance using the specified values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#Binding-java.net.SocketAddress-org.apache.mina.common.IoHandler-org.apache.mina.common.IoServiceConfig-">Binding</a></span>(java.net.SocketAddress&nbsp;address,
<a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a>&nbsp;handler,
<a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a>&nbsp;serviceConfig)</code>
<div class="block">Creates a new instance using the specified values.</div>
</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/integration/spring/Binding.html#afterPropertiesSet--">afterPropertiesSet</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.net.SocketAddress</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#getAddress--">getAddress</a></span>()</code>
<div class="block">Returns the address the handler of this object will be bound to.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#getHandler--">getHandler</a></span>()</code>
<div class="block">Returns the handler of this binding object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#getServiceConfig--">getServiceConfig</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#setAddress-java.net.SocketAddress-">setAddress</a></span>(java.net.SocketAddress&nbsp;address)</code>
<div class="block">Sets the address the handler of this object will be bound to.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#setHandler-org.apache.mina.common.IoHandler-">setHandler</a></span>(<a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a>&nbsp;handler)</code>
<div class="block">Sets the handler of this binding object.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/integration/spring/Binding.html#setServiceConfig-org.apache.mina.common.IoServiceConfig-">setServiceConfig</a></span>(<a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a>&nbsp;serviceConfig)</code>&nbsp;</td>
</tr>
</table>
<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="Binding--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Binding</h4>
<pre>public&nbsp;Binding()</pre>
<div class="block">Creates a new empty instance.</div>
</li>
</ul>
<a name="Binding-java.net.SocketAddress-org.apache.mina.common.IoHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Binding</h4>
<pre>public&nbsp;Binding(java.net.SocketAddress&nbsp;address,
<a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a>&nbsp;handler)</pre>
<div class="block">Creates a new instance using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address</code> - the address.</dd>
<dd><code>handler</code> - the handler.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the any of the specified values are
<code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="Binding-java.net.SocketAddress-org.apache.mina.common.IoHandler-org.apache.mina.common.IoServiceConfig-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Binding</h4>
<pre>public&nbsp;Binding(java.net.SocketAddress&nbsp;address,
<a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a>&nbsp;handler,
<a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a>&nbsp;serviceConfig)</pre>
<div class="block">Creates a new instance using the specified values.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address</code> - the address.</dd>
<dd><code>handler</code> - the handler.</dd>
<dd><code>serviceConfig</code> - the service configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the any of the specified values are
<code>null</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="getAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre>public&nbsp;java.net.SocketAddress&nbsp;getAddress()</pre>
<div class="block">Returns the address the handler of this object will be bound to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the address.</dd>
</dl>
</li>
</ul>
<a name="setAddress-java.net.SocketAddress-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAddress</h4>
<pre>public&nbsp;void&nbsp;setAddress(java.net.SocketAddress&nbsp;address)</pre>
<div class="block">Sets the address the handler of this object will be bound to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address</code> - the address.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the specified value is
<code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a>&nbsp;getHandler()</pre>
<div class="block">Returns the handler of this binding object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the handler.</dd>
</dl>
</li>
</ul>
<a name="setHandler-org.apache.mina.common.IoHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHandler</h4>
<pre>public&nbsp;void&nbsp;setHandler(<a href="../../../../../org/apache/mina/common/IoHandler.html" title="interface in org.apache.mina.common">IoHandler</a>&nbsp;handler)</pre>
<div class="block">Sets the handler of this binding object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - the handler.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the specified value is
<code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="getServiceConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServiceConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a>&nbsp;getServiceConfig()</pre>
</li>
</ul>
<a name="setServiceConfig-org.apache.mina.common.IoServiceConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServiceConfig</h4>
<pre>public&nbsp;void&nbsp;setServiceConfig(<a href="../../../../../org/apache/mina/common/IoServiceConfig.html" title="interface in org.apache.mina.common">IoServiceConfig</a>&nbsp;serviceConfig)</pre>
</li>
</ul>
<a name="afterPropertiesSet--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre>public&nbsp;void&nbsp;afterPropertiesSet()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</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/Binding.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/integration/spring/DefaultIoFilterChainBuilderFactoryBean.html" title="class in org.apache.mina.integration.spring"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/integration/spring/Binding.html" target="_top">Frames</a></li>
<li><a href="Binding.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 ======= -->
<p class="legalCopy"><small>Copyright © 2004-2019 <a href="http://mina.apace.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>