| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Destination (Apache CXF JavaDoc 3.2.0 API)</title> |
| <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="Destination (Apache CXF JavaDoc 3.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Destination.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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cxf/transport/ConduitInitiatorManager.html" title="interface in org.apache.cxf.transport"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cxf/transport/DestinationFactory.html" title="interface in org.apache.cxf.transport"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cxf/transport/Destination.html" target="_top">Frames</a></li> |
| <li><a href="Destination.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.cxf.transport</div> |
| <h2 title="Interface Destination" class="title">Interface Destination</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/cxf/transport/Observable.html" title="interface in org.apache.cxf.transport">Observable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/cxf/transport/MultiplexDestination.html" title="interface in org.apache.cxf.transport">MultiplexDestination</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/cxf/transport/AbstractDestination.html" title="class in org.apache.cxf.transport">AbstractDestination</a>, <a href="../../../../org/apache/cxf/transport/http/AbstractHTTPDestination.html" title="class in org.apache.cxf.transport.http">AbstractHTTPDestination</a>, <a href="../../../../org/apache/cxf/transport/AbstractMultiplexDestination.html" title="class in org.apache.cxf.transport">AbstractMultiplexDestination</a>, <a href="../../../../org/apache/cxf/transport/sse/atmosphere/AtmosphereSseServletDestination.html" title="class in org.apache.cxf.transport.sse.atmosphere">AtmosphereSseServletDestination</a>, <a href="../../../../org/apache/cxf/transport/websocket/atmosphere/AtmosphereWebSocketJettyDestination.html" title="class in org.apache.cxf.transport.websocket.atmosphere">AtmosphereWebSocketJettyDestination</a>, <a href="../../../../org/apache/cxf/transport/websocket/atmosphere/AtmosphereWebSocketServletDestination.html" title="class in org.apache.cxf.transport.websocket.atmosphere">AtmosphereWebSocketServletDestination</a>, <a href="../../../../org/apache/cxf/transport/websocket/atmosphere/AtmosphereWebSocketUndertowDestination.html" title="class in org.apache.cxf.transport.websocket.atmosphere">AtmosphereWebSocketUndertowDestination</a>, <a href="../../../../org/apache/cxf/binding/corba/CorbaDestination.html" title="class in org.apache.cxf.binding.corba">CorbaDestination</a>, <a href="../../../../org/apache/cxf/transport/http_jaxws_spi/JAXWSHttpSpiDestination.html" title="class in org.apache.cxf.transport.http_jaxws_spi">JAXWSHttpSpiDestination</a>, <a href="../../../../org/apache/cxf/transport/websocket/jetty9/Jetty9WebSocketDestination.html" title="class in org.apache.cxf.transport.websocket.jetty9">Jetty9WebSocketDestination</a>, <a href="../../../../org/apache/cxf/transport/http_jetty/JettyHTTPDestination.html" title="class in org.apache.cxf.transport.http_jetty">JettyHTTPDestination</a>, <a href="../../../../org/apache/cxf/transport/jms/JMSDestination.html" title="class in org.apache.cxf.transport.jms">JMSDestination</a>, <a href="../../../../org/apache/cxf/transport/local/LocalDestination.html" title="class in org.apache.cxf.transport.local">LocalDestination</a>, <a href="../../../../org/apache/cxf/transport/http/netty/server/NettyHttpDestination.html" title="class in org.apache.cxf.transport.http.netty.server">NettyHttpDestination</a>, <a href="../../../../org/apache/cxf/transport/servlet/ServletDestination.html" title="class in org.apache.cxf.transport.servlet">ServletDestination</a>, <a href="../../../../org/apache/cxf/transport/udp/UDPDestination.html" title="class in org.apache.cxf.transport.udp">UDPDestination</a>, <a href="../../../../org/apache/cxf/transport/http_undertow/UndertowHTTPDestination.html" title="class in org.apache.cxf.transport.http_undertow">UndertowHTTPDestination</a>, <a href="../../../../org/apache/cxf/transport/websocket/undertow/UndertowWebSocketDestination.html" title="class in org.apache.cxf.transport.websocket.undertow">UndertowWebSocketDestination</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Destination</span> |
| extends <a href="../../../../org/apache/cxf/transport/Observable.html" title="interface in org.apache.cxf.transport">Observable</a></pre> |
| <div class="block">A Destination is a transport-level endpoint capable of receiving |
| unsolicited incoming messages from different peers.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>org.apache.cxf.ws.addressing.EndpointReferenceType</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/transport/Destination.html#getAddress--">getAddress</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/transport/Conduit.html" title="interface in org.apache.cxf.transport">Conduit</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/transport/Destination.html#getBackChannel-org.apache.cxf.message.Message-">getBackChannel</a></span>(<a href="../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> inMessage)</code> |
| <div class="block">Retreive a back-channel Conduit, which must be policy-compatible |
| with the current Message and associated Destination.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cxf/transport/MessageObserver.html" title="interface in org.apache.cxf.transport">MessageObserver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cxf/transport/Destination.html#getMessageObserver--">getMessageObserver</a></span>()</code> |
| <div class="block">Retrieves the message observer for incoming messages</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/cxf/transport/Destination.html#shutdown--">shutdown</a></span>()</code> |
| <div class="block">Shutdown the Destination, i.e.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cxf.transport.Observable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cxf.transport.<a href="../../../../org/apache/cxf/transport/Observable.html" title="interface in org.apache.cxf.transport">Observable</a></h3> |
| <code><a href="../../../../org/apache/cxf/transport/Observable.html#setMessageObserver-org.apache.cxf.transport.MessageObserver-">setMessageObserver</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ 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>org.apache.cxf.ws.addressing.EndpointReferenceType getAddress()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the reference associated with this Destination</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBackChannel-org.apache.cxf.message.Message-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBackChannel</h4> |
| <pre><a href="../../../../org/apache/cxf/transport/Conduit.html" title="interface in org.apache.cxf.transport">Conduit</a> getBackChannel(<a href="../../../../org/apache/cxf/message/Message.html" title="interface in org.apache.cxf.message">Message</a> inMessage) |
| throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Retreive a back-channel Conduit, which must be policy-compatible |
| with the current Message and associated Destination. For example |
| compatible Quality of Protection must be asserted on the back-channel.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>inMessage</code> - the current message</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a suitable Conduit</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>void shutdown()</pre> |
| <div class="block">Shutdown the Destination, i.e. stop accepting incoming messages.</div> |
| </li> |
| </ul> |
| <a name="getMessageObserver--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMessageObserver</h4> |
| <pre><a href="../../../../org/apache/cxf/transport/MessageObserver.html" title="interface in org.apache.cxf.transport">MessageObserver</a> getMessageObserver()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/cxf/transport/Observable.html#getMessageObserver--">Observable</a></code></span></div> |
| <div class="block">Retrieves the message observer for incoming messages</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cxf/transport/Observable.html#getMessageObserver--">getMessageObserver</a></code> in interface <code><a href="../../../../org/apache/cxf/transport/Observable.html" title="interface in org.apache.cxf.transport">Observable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the MessageObserver for incoming messages</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/Destination.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 class="aboutLanguage">Apache CXF API</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/cxf/transport/ConduitInitiatorManager.html" title="interface in org.apache.cxf.transport"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cxf/transport/DestinationFactory.html" title="interface in org.apache.cxf.transport"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cxf/transport/Destination.html" target="_top">Frames</a></li> |
| <li><a href="Destination.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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>Apache CXF</small></p> |
| </body> |
| </html> |