blob: ae205b84655c7009f9ca985517d5fdc35bd6448b [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>org.apache.tomee.microprofile.jwt.bval</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="org.apache.tomee.microprofile.jwt.bval";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/tomee/microprofile/jwt/cdi/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/tomee/microprofile/jwt/bval/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.tomee.microprofile.jwt.bval</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/BValInterceptor.html" title="class in org.apache.tomee.microprofile.jwt.bval">BValInterceptor</a></td>
<td class="colLast">
<div class="block">This interceptor is a specialized version of the org.apache.bval.cdi.BValInterceptor
To support the JWT+BeanValidation feature we will split any JWT-validating annotations
into a dedicated class with a '$$JwtConstraints' suffix, and the other annotations into a
dedicated class with a '$$ReturnConstraints' suffix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ClassValidationData.html" title="class in org.apache.tomee.microprofile.jwt.bval">ClassValidationData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ClassValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ClassValidationGenerator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/JwtValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">JwtValidationGenerator</a></td>
<td class="colLast">
<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.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MethodConstraints.html" title="class in org.apache.tomee.microprofile.jwt.bval">MethodConstraints</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MethodMap.html" title="class in org.apache.tomee.microprofile.jwt.bval">MethodMap</a></td>
<td class="colLast">
<div class="block">Given a class like the following:
public class Green {
@ReturnValidation("bar")
public void sage() {
}
}
We will have generated a class like the following</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ReturnValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ReturnValidationGenerator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationConstraints.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationConstraints</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator</a></td>
<td class="colLast">
<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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerator.ConstrainedMethodVisitor.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerator.ConstrainedMethodVisitor</a></td>
<td class="colLast">
<div class="block">Wraps a MethodVisitor and ignores all annotations that are not
bean validation annotations that should be on this method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationInterceptor.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationInterceptor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationInterceptorsFeature.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationInterceptorsFeature</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ConstraintsClassInstantiationException.html" title="class in org.apache.tomee.microprofile.jwt.bval">ConstraintsClassInstantiationException</a></td>
<td class="colLast">
<div class="block">This should never be thrown.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/GeneratedConstraintsMissingException.html" title="class in org.apache.tomee.microprofile.jwt.bval">GeneratedConstraintsMissingException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MissingConstraintsException.html" title="class in org.apache.tomee.microprofile.jwt.bval">MissingConstraintsException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/MissingConstraintsMethodException.html" title="class in org.apache.tomee.microprofile.jwt.bval">MissingConstraintsMethodException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationConstraintException.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationConstraintException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/ValidationGenerationException.html" title="class in org.apache.tomee.microprofile.jwt.bval">ValidationGenerationException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/tomee/microprofile/jwt/bval/Generated.html" title="annotation in org.apache.tomee.microprofile.jwt.bval">Generated</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/tomee/microprofile/jwt/cdi/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/tomee/microprofile/jwt/bval/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>