| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>DefaultProtocolInterceptor (Apache CXF JavaDoc 3.1.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DefaultProtocolInterceptor (Apache CXF JavaDoc 3.1.0 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/DefaultProtocolInterceptor.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"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/AtmosphereWebSocketServletDestination.html" title="class in org.apache.cxf.transport.websocket.atmosphere"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html" target="_top">Frames</a></li> |
| <li><a href="DefaultProtocolInterceptor.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><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.apache.cxf.transport.websocket.atmosphere</div> |
| <h2 title="Class DefaultProtocolInterceptor" class="title">Class DefaultProtocolInterceptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.atmosphere.cpr.AtmosphereInterceptorAdapter</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cxf.transport.websocket.atmosphere.DefaultProtocolInterceptor</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.atmosphere.cpr.AtmosphereInterceptor, org.atmosphere.interceptor.InvokationOrder</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@AtmosphereInterceptorService |
| public class <span class="strong">DefaultProtocolInterceptor</span> |
| extends org.atmosphere.cpr.AtmosphereInterceptorAdapter</pre> |
| <div class="block">DefaultProtocolInterceptor provides the default CXF's WebSocket protocol that uses.</div> |
| </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.atmosphere.interceptor.InvokationOrder"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.atmosphere.interceptor.InvokationOrder</h3> |
| <code>org.atmosphere.interceptor.InvokationOrder.PRIORITY</code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.atmosphere.interceptor.InvokationOrder"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.atmosphere.interceptor.InvokationOrder</h3> |
| <code>AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT</code></li> |
| </ul> |
| </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/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#DefaultProtocolInterceptor()">DefaultProtocolInterceptor</a></strong>()</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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#configure(org.atmosphere.cpr.AtmosphereConfig)">configure</a></strong>(org.atmosphere.cpr.AtmosphereConfig config)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.atmosphere.cpr.AtmosphereRequest</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#createAtmosphereRequest(org.atmosphere.cpr.AtmosphereRequest,%20byte[])">createAtmosphereRequest</a></strong>(org.atmosphere.cpr.AtmosphereRequest r, |
| byte[] data)</code> |
| <div class="block">Creates a virtual request using the specified parent request and the actual data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#createResponse(org.atmosphere.cpr.AtmosphereResponse,%20byte[],%20boolean)">createResponse</a></strong>(org.atmosphere.cpr.AtmosphereResponse response, |
| byte[] payload, |
| boolean parent)</code> |
| <div class="block">Creates a response data based on the specified payload.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html" title="class in org.apache.cxf.transport.websocket.atmosphere">DefaultProtocolInterceptor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#excludedheaders(java.lang.String)">excludedheaders</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> p)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html" title="class in org.apache.cxf.transport.websocket.atmosphere">DefaultProtocolInterceptor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#includedheaders(java.lang.String)">includedheaders</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> p)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>org.atmosphere.cpr.Action</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#inspect(org.atmosphere.cpr.AtmosphereResource)">inspect</a></strong>(org.atmosphere.cpr.AtmosphereResource r)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#setExcludedheaders(java.util.regex.Pattern)">setExcludedheaders</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> excludedheaders)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html#setIncludedheaders(java.util.regex.Pattern)">setIncludedheaders</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> includedheaders)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.atmosphere.cpr.AtmosphereInterceptorAdapter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter</h3> |
| <code>postInspect, priority, toString</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="DefaultProtocolInterceptor()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultProtocolInterceptor</h4> |
| <pre>public DefaultProtocolInterceptor()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="configure(org.atmosphere.cpr.AtmosphereConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre>public void configure(org.atmosphere.cpr.AtmosphereConfig config)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>configure</code> in interface <code>org.atmosphere.cpr.AtmosphereInterceptor</code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>configure</code> in class <code>org.atmosphere.cpr.AtmosphereInterceptorAdapter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="includedheaders(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>includedheaders</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html" title="class in org.apache.cxf.transport.websocket.atmosphere">DefaultProtocolInterceptor</a> includedheaders(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> p)</pre> |
| </li> |
| </ul> |
| <a name="setIncludedheaders(java.util.regex.Pattern)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncludedheaders</h4> |
| <pre>public void setIncludedheaders(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> includedheaders)</pre> |
| </li> |
| </ul> |
| <a name="excludedheaders(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>excludedheaders</h4> |
| <pre>public <a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html" title="class in org.apache.cxf.transport.websocket.atmosphere">DefaultProtocolInterceptor</a> excludedheaders(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> p)</pre> |
| </li> |
| </ul> |
| <a name="setExcludedheaders(java.util.regex.Pattern)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExcludedheaders</h4> |
| <pre>public void setExcludedheaders(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> excludedheaders)</pre> |
| </li> |
| </ul> |
| <a name="inspect(org.atmosphere.cpr.AtmosphereResource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>inspect</h4> |
| <pre>public org.atmosphere.cpr.Action inspect(org.atmosphere.cpr.AtmosphereResource r)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>inspect</code> in interface <code>org.atmosphere.cpr.AtmosphereInterceptor</code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>inspect</code> in class <code>org.atmosphere.cpr.AtmosphereInterceptorAdapter</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createAtmosphereRequest(org.atmosphere.cpr.AtmosphereRequest, byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAtmosphereRequest</h4> |
| <pre>protected org.atmosphere.cpr.AtmosphereRequest createAtmosphereRequest(org.atmosphere.cpr.AtmosphereRequest r, |
| byte[] data) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Creates a virtual request using the specified parent request and the actual data.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>r</code> - </dd><dd><code>data</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/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="createResponse(org.atmosphere.cpr.AtmosphereResponse, byte[], boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createResponse</h4> |
| <pre>protected byte[] createResponse(org.atmosphere.cpr.AtmosphereResponse response, |
| byte[] payload, |
| boolean parent)</pre> |
| <div class="block">Creates a response data based on the specified payload.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>response</code> - </dd><dd><code>payload</code> - </dd><dd><code>parent</code> - </dd> |
| <dt><span class="strong">Returns:</span></dt><dd></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/DefaultProtocolInterceptor.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"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/cxf/transport/websocket/atmosphere/AtmosphereWebSocketServletDestination.html" title="class in org.apache.cxf.transport.websocket.atmosphere"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/cxf/transport/websocket/atmosphere/DefaultProtocolInterceptor.html" target="_top">Frames</a></li> |
| <li><a href="DefaultProtocolInterceptor.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><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>Apache CXF</small></p> |
| </body> |
| </html> |
