blob: 8f02e69e094b317d69dd775814bd7928a3e2be03 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JweWriterInterceptor (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="JweWriterInterceptor (Apache CXF JavaDoc 3.2.0 API)";
}
}
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/JweWriterInterceptor.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/rs/security/jose/jaxrs/JweJsonWriterInterceptor.html" title="class in org.apache.cxf.rs.security.jose.jaxrs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/jose/jaxrs/JwsClientResponseFilter.html" title="class in org.apache.cxf.rs.security.jose.jaxrs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html" target="_top">Frames</a></li>
<li><a href="JweWriterInterceptor.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.cxf.rs.security.jose.jaxrs</div>
<h2 title="Class JweWriterInterceptor" class="title">Class JweWriterInterceptor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/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.apache.cxf.rs.security.jose.jaxrs.JweWriterInterceptor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>javax.ws.rs.ext.WriterInterceptor</dd>
</dl>
<hr>
<br>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/javax/annotation/Priority.html?is-external=true" title="class or interface in javax.annotation">@Priority</a>(<a href="http://docs.oracle.com/javase/8/docs/api/javax/annotation/Priority.html?is-external=true#value--" title="class or interface in javax.annotation">value</a>=1001)
public class <span class="typeNameLabel">JweWriterInterceptor</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements javax.ws.rs.ext.WriterInterceptor</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
</table>
</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/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#JweWriterInterceptor--">JweWriterInterceptor</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/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#aroundWriteTo-javax.ws.rs.ext.WriterInterceptorContext-">aroundWriteTo</a></span>(javax.ws.rs.ext.WriterInterceptorContext&nbsp;ctx)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweEncryptionProvider.html" title="interface in org.apache.cxf.rs.security.jose.jwe">JweEncryptionProvider</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#getInitializedEncryptionProvider-org.apache.cxf.rs.security.jose.jwe.JweHeaders-">getInitializedEncryptionProvider</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweHeaders.html" title="class in org.apache.cxf.rs.security.jose.jwe">JweHeaders</a>&nbsp;headers)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#protectHttpHeadersIfNeeded-javax.ws.rs.ext.WriterInterceptorContext-org.apache.cxf.rs.security.jose.jwe.JweHeaders-">protectHttpHeadersIfNeeded</a></span>(javax.ws.rs.ext.WriterInterceptorContext&nbsp;ctx,
<a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweHeaders.html" title="class in org.apache.cxf.rs.security.jose.jwe">JweHeaders</a>&nbsp;jweHeaders)</code>&nbsp;</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/rs/security/jose/jaxrs/JweWriterInterceptor.html#setEncryptionProvider-org.apache.cxf.rs.security.jose.jwe.JweEncryptionProvider-">setEncryptionProvider</a></span>(<a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweEncryptionProvider.html" title="interface in org.apache.cxf.rs.security.jose.jwe">JweEncryptionProvider</a>&nbsp;encryptionProvider)</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/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#setProtectedHttpHeaders-java.util.Set-">setProtectedHttpHeaders</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;protectedHttpHeaders)</code>&nbsp;</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/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#setProtectHttpHeaders-boolean-">setProtectHttpHeaders</a></span>(boolean&nbsp;protectHttpHeaders)</code>&nbsp;</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/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html#setUseJweOutputStream-boolean-">setUseJweOutputStream</a></span>(boolean&nbsp;useJweOutputStream)</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.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="LOG">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LOG</h4>
<pre>protected static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a> LOG</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JweWriterInterceptor--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JweWriterInterceptor</h4>
<pre>public&nbsp;JweWriterInterceptor()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="aroundWriteTo-javax.ws.rs.ext.WriterInterceptorContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aroundWriteTo</h4>
<pre>public&nbsp;void&nbsp;aroundWriteTo(javax.ws.rs.ext.WriterInterceptorContext&nbsp;ctx)
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>,
javax.ws.rs.WebApplicationException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>aroundWriteTo</code>&nbsp;in interface&nbsp;<code>javax.ws.rs.ext.WriterInterceptor</code></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>
<dd><code>javax.ws.rs.WebApplicationException</code></dd>
</dl>
</li>
</ul>
<a name="getInitializedEncryptionProvider-org.apache.cxf.rs.security.jose.jwe.JweHeaders-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitializedEncryptionProvider</h4>
<pre>protected&nbsp;<a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweEncryptionProvider.html" title="interface in org.apache.cxf.rs.security.jose.jwe">JweEncryptionProvider</a>&nbsp;getInitializedEncryptionProvider(<a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweHeaders.html" title="class in org.apache.cxf.rs.security.jose.jwe">JweHeaders</a>&nbsp;headers)</pre>
</li>
</ul>
<a name="setUseJweOutputStream-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseJweOutputStream</h4>
<pre>public&nbsp;void&nbsp;setUseJweOutputStream(boolean&nbsp;useJweOutputStream)</pre>
</li>
</ul>
<a name="setEncryptionProvider-org.apache.cxf.rs.security.jose.jwe.JweEncryptionProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncryptionProvider</h4>
<pre>public&nbsp;void&nbsp;setEncryptionProvider(<a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweEncryptionProvider.html" title="interface in org.apache.cxf.rs.security.jose.jwe">JweEncryptionProvider</a>&nbsp;encryptionProvider)</pre>
</li>
</ul>
<a name="protectHttpHeadersIfNeeded-javax.ws.rs.ext.WriterInterceptorContext-org.apache.cxf.rs.security.jose.jwe.JweHeaders-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>protectHttpHeadersIfNeeded</h4>
<pre>protected&nbsp;void&nbsp;protectHttpHeadersIfNeeded(javax.ws.rs.ext.WriterInterceptorContext&nbsp;ctx,
<a href="../../../../../../../org/apache/cxf/rs/security/jose/jwe/JweHeaders.html" title="class in org.apache.cxf.rs.security.jose.jwe">JweHeaders</a>&nbsp;jweHeaders)</pre>
</li>
</ul>
<a name="setProtectHttpHeaders-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProtectHttpHeaders</h4>
<pre>public&nbsp;void&nbsp;setProtectHttpHeaders(boolean&nbsp;protectHttpHeaders)</pre>
</li>
</ul>
<a name="setProtectedHttpHeaders-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setProtectedHttpHeaders</h4>
<pre>public&nbsp;void&nbsp;setProtectedHttpHeaders(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;protectedHttpHeaders)</pre>
</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/JweWriterInterceptor.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/rs/security/jose/jaxrs/JweJsonWriterInterceptor.html" title="class in org.apache.cxf.rs.security.jose.jaxrs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/cxf/rs/security/jose/jaxrs/JwsClientResponseFilter.html" title="class in org.apache.cxf.rs.security.jose.jaxrs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/cxf/rs/security/jose/jaxrs/JweWriterInterceptor.html" target="_top">Frames</a></li>
<li><a href="JweWriterInterceptor.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>Apache CXF</small></p>
</body>
</html>