blob: fe1c1c56dc641a9770ee4a6d1f5a0ce391daae34 [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>
<title>JwtValidationGenerator</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="JwtValidationGenerator";
}
}
catch(err) {
}
//-->
var methods = {"i0":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="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="../../../../../../org/apache/tomee/microprofile/jwt/bval/GeneratedConstraintsMissingException.html" title="class in org.apache.tomee.microprofile.jwt.bval"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MethodConstraints.html" title="class in org.apache.tomee.microprofile.jwt.bval"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/tomee/microprofile/jwt/bval/JwtValidationGenerator.html" target="_top">Frames</a></li>
<li><a href="JwtValidationGenerator.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><a href="#nested.classes.inherited.from.class.org.apache.tomee.microprofile.jwt.bval.ValidationGenerator">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.tomee.microprofile.jwt.bval.ValidationGenerator">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>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.tomee.microprofile.jwt.bval</div>
<h2 title="Class JwtValidationGenerator" class="title">Class JwtValidationGenerator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">org.apache.tomee.microprofile.jwt.bval.ValidationGenerator</a></li>
<li>
<ul class="inheritance">
<li>org.apache.tomee.microprofile.jwt.bval.JwtValidationGenerator</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JwtValidationGenerator</span>
extends <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator</a></pre>
<div class="block">We allow CDI and EJB beans to use BeanValidation to validate a JsonWebToken
instance by simply creating contstraints and putting them on that method.
BeanValidation doesn't "see" them there so we have to generate a class
that has the annotations in a place BeanValidation can see.
To accomplish this, for every method that has BeanValidation constraints
we generate an equivalent method that has those same annotations and
returns JsonWebToken.
We can then pass the generated method to BeanValidation's
ExecutableValidator.validateReturnValue and pass in the JsonWebToken instance
The only purpose of this generated class and these generated methods is to
make BeanValidation happy. If BeanValidation added something like this:
getValidator().validate(Object instance, Annotation[] annotations);
Then all the code here could be deleted.
A short example of the kind of code it generates.
This class:
public class Colors {</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.apache.tomee.microprofile.jwt.bval.ValidationGenerator">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.tomee.microprofile.jwt.bval.<a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator</a></h3>
<code><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.ConstrainedMethodVisitor.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator.ConstrainedMethodVisitor</a>, <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.CopyMethodAnnotations.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator.CopyMethodAnnotations</a></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.apache.tomee.microprofile.jwt.bval.ValidationGenerator">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.tomee.microprofile.jwt.bval.<a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator</a></h3>
<code><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#clazz">clazz</a>, <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#constraints">constraints</a>, <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#generatedMethods">generatedMethods</a>, <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#suffix">suffix</a></code></li>
</ul>
</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/tomee/microprofile/jwt/bval/JwtValidationGenerator.html#JwtValidationGenerator-java.lang.Class-java.util.List-">JwtValidationGenerator</a></span>(java.lang.Class&lt;?&gt;&nbsp;clazz,
java.util.List&lt;<a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MethodConstraints.html" title="class in org.apache.tomee.microprofile.jwt.bval">MethodConstraints</a>&gt;&nbsp;constraints)</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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/JwtValidationGenerator.html#generateMethods-ClassWriter-">generateMethods</a></span>(ClassWriter&nbsp;cw)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.tomee.microprofile.jwt.bval.ValidationGenerator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.tomee.microprofile.jwt.bval.<a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator</a></h3>
<code><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#generate--">generate</a>, <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#generateAndLoad--">generateAndLoad</a>, <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#getName--">getName</a>, <a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#loadOrCreate--">loadOrCreate</a></code></li>
</ul>
<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="JwtValidationGenerator-java.lang.Class-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JwtValidationGenerator</h4>
<pre>public&nbsp;JwtValidationGenerator(java.lang.Class&lt;?&gt;&nbsp;clazz,
java.util.List&lt;<a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MethodConstraints.html" title="class in org.apache.tomee.microprofile.jwt.bval">MethodConstraints</a>&gt;&nbsp;constraints)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="generateMethods-ClassWriter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateMethods</h4>
<pre>protected&nbsp;void&nbsp;generateMethods(ClassWriter&nbsp;cw)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html#generateMethods-ClassWriter-">generateMethods</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator</a></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="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="../../../../../../org/apache/tomee/microprofile/jwt/bval/GeneratedConstraintsMissingException.html" title="class in org.apache.tomee.microprofile.jwt.bval"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MethodConstraints.html" title="class in org.apache.tomee.microprofile.jwt.bval"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/tomee/microprofile/jwt/bval/JwtValidationGenerator.html" target="_top">Frames</a></li>
<li><a href="JwtValidationGenerator.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><a href="#nested.classes.inherited.from.class.org.apache.tomee.microprofile.jwt.bval.ValidationGenerator">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.tomee.microprofile.jwt.bval.ValidationGenerator">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>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 ======= -->
</body>
</html>