| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>WriterInterceptorContext</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="WriterInterceptorContext"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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="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="../../../../javax/ws/rs/ext/WriterInterceptor.html" title="interface in javax.ws.rs.ext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/ws/rs/ext/WriterInterceptorContext.html" target="_top">Frames</a></li> |
| <li><a href="WriterInterceptorContext.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">javax.ws.rs.ext</div> |
| <h2 title="Interface WriterInterceptorContext" class="title">Interface WriterInterceptorContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../javax/ws/rs/ext/InterceptorContext.html" title="interface in javax.ws.rs.ext">InterceptorContext</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">WriterInterceptorContext</span> |
| extends <a href="../../../../javax/ws/rs/ext/InterceptorContext.html" title="interface in javax.ws.rs.ext">InterceptorContext</a></pre> |
| <div class="block">Context class used by <a href="../../../../javax/ws/rs/ext/WriterInterceptor.html" title="interface in javax.ws.rs.ext"><code>WriterInterceptor</code></a> |
| to intercept calls to <a href="../../../../javax/ws/rs/ext/MessageBodyWriter.html#writeTo-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-javax.ws.rs.core.MediaType-javax.ws.rs.core.MultivaluedMap-java.io.OutputStream-"><code>MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)</code></a>. |
| The getters and setters in this context class correspond to the |
| parameters of the intercepted method.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../javax/ws/rs/ext/WriterInterceptor.html" title="interface in javax.ws.rs.ext"><code>WriterInterceptor</code></a>, |
| <a href="../../../../javax/ws/rs/ext/MessageBodyWriter.html" title="interface in javax.ws.rs.ext"><code>MessageBodyWriter</code></a></dd> |
| </dl> |
| </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>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/ext/WriterInterceptorContext.html#getEntity--">getEntity</a></span>()</code> |
| <div class="block">Get object to be written as HTTP entity.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/ws/rs/core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.Object></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/ext/WriterInterceptorContext.html#getHeaders--">getHeaders</a></span>()</code> |
| <div class="block">Get mutable map of HTTP headers.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.io.OutputStream</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/ext/WriterInterceptorContext.html#getOutputStream--">getOutputStream</a></span>()</code> |
| <div class="block">Get the output stream for the object to be written.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/ext/WriterInterceptorContext.html#proceed--">proceed</a></span>()</code> |
| <div class="block">Proceed to the next interceptor in the chain.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/ext/WriterInterceptorContext.html#setEntity-java.lang.Object-">setEntity</a></span>(java.lang.Object entity)</code> |
| <div class="block">Update object to be written as HTTP entity.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/ext/WriterInterceptorContext.html#setOutputStream-java.io.OutputStream-">setOutputStream</a></span>(java.io.OutputStream os)</code> |
| <div class="block">Set a new output stream for the object to be written.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.ws.rs.ext.InterceptorContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.ws.rs.ext.<a href="../../../../javax/ws/rs/ext/InterceptorContext.html" title="interface in javax.ws.rs.ext">InterceptorContext</a></h3> |
| <code><a href="../../../../javax/ws/rs/ext/InterceptorContext.html#getAnnotations--">getAnnotations</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#getGenericType--">getGenericType</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#getMediaType--">getMediaType</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#getProperty-java.lang.String-">getProperty</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#getPropertyNames--">getPropertyNames</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#getType--">getType</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#removeProperty-java.lang.String-">removeProperty</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#setAnnotations-java.lang.annotation.Annotation:A-">setAnnotations</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#setGenericType-java.lang.reflect.Type-">setGenericType</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#setMediaType-javax.ws.rs.core.MediaType-">setMediaType</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#setProperty-java.lang.String-java.lang.Object-">setProperty</a>, <a href="../../../../javax/ws/rs/ext/InterceptorContext.html#setType-java.lang.Class-">setType</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="proceed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>proceed</h4> |
| <pre>void proceed() |
| throws java.io.IOException, |
| <a href="../../../../javax/ws/rs/WebApplicationException.html" title="class in javax.ws.rs">WebApplicationException</a></pre> |
| <div class="block">Proceed to the next interceptor in the chain. |
| |
| Interceptors MUST explicitly call this method to continue the execution chain; |
| the call to this method in the last interceptor of the chain will invoke |
| the wrapped <a href="../../../../javax/ws/rs/ext/MessageBodyWriter.html#writeTo-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-javax.ws.rs.core.MediaType-javax.ws.rs.core.MultivaluedMap-java.io.OutputStream-"><code>MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)</code></a> method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if an IO error arises or is thrown by the wrapped |
| <code>MessageBodyWriter.writeTo</code> method.</dd> |
| <dd><code><a href="../../../../javax/ws/rs/WebApplicationException.html" title="class in javax.ws.rs">WebApplicationException</a></code> - thrown by the wrapped <code>MessageBodyWriter.writeTo</code> method.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEntity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntity</h4> |
| <pre>java.lang.Object getEntity()</pre> |
| <div class="block">Get object to be written as HTTP entity.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>object to be written as HTTP entity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEntity-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEntity</h4> |
| <pre>void setEntity(java.lang.Object entity)</pre> |
| <div class="block">Update object to be written as HTTP entity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>entity</code> - new object to be written.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputStream--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputStream</h4> |
| <pre>java.io.OutputStream getOutputStream()</pre> |
| <div class="block">Get the output stream for the object to be written. The runtime |
| is responsible for closing the output stream.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>output stream for the object to be written.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOutputStream-java.io.OutputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutputStream</h4> |
| <pre>void setOutputStream(java.io.OutputStream os)</pre> |
| <div class="block">Set a new output stream for the object to be written. For example, by wrapping |
| it with another output stream. The runtime is responsible for closing |
| the output stream that is set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>os</code> - new output stream for the object to be written.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre><a href="../../../../javax/ws/rs/core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a><java.lang.String,java.lang.Object> getHeaders()</pre> |
| <div class="block">Get mutable map of HTTP headers.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>map of HTTP headers.</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="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="../../../../javax/ws/rs/ext/WriterInterceptor.html" title="interface in javax.ws.rs.ext"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/ws/rs/ext/WriterInterceptorContext.html" target="_top">Frames</a></li> |
| <li><a href="WriterInterceptorContext.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 ======= --> |
| </body> |
| </html> |
