| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JWTCallerPrincipalFactory</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="JWTCallerPrincipalFactory"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":6,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/principal/JWTCallerPrincipal.html" title="class in org.apache.tomee.microprofile.jwt.principal"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html" target="_top">Frames</a></li> |
| <li><a href="JWTCallerPrincipalFactory.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.tomee.microprofile.jwt.principal</div> |
| <h2 title="Class JWTCallerPrincipalFactory" class="title">Class JWTCallerPrincipalFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.tomee.microprofile.jwt.principal.JWTCallerPrincipalFactory</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/DefaultJWTCallerPrincipalFactory.html" title="class in org.apache.tomee.microprofile.jwt.principal">DefaultJWTCallerPrincipalFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">JWTCallerPrincipalFactory</span> |
| extends java.lang.Object</pre> |
| <div class="block">The factory class that provides the token string to JWTCallerPrincipal parsing for a given implementation.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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/principal/JWTCallerPrincipalFactory.html#JWTCallerPrincipalFactory--">JWTCallerPrincipalFactory</a></span>()</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="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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html" title="class in org.apache.tomee.microprofile.jwt.principal">JWTCallerPrincipalFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html#instance--">instance</a></span>()</code> |
| <div class="block">Obtain the JWTCallerPrincipalFactory that has been set or by using the ServiceLoader pattern.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipal.html" title="class in org.apache.tomee.microprofile.jwt.principal">JWTCallerPrincipal</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html#parse-java.lang.String-org.apache.tomee.microprofile.jwt.config.JWTAuthContextInfo-">parse</a></span>(java.lang.String token, |
| <a href="../../../../../../org/apache/tomee/microprofile/jwt/config/JWTAuthContextInfo.html" title="class in org.apache.tomee.microprofile.jwt.config">JWTAuthContextInfo</a> authContextInfo)</code> |
| <div class="block">Parse the given bearer token string into a JWTCallerPrincipal instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html#setInstance-org.apache.tomee.microprofile.jwt.principal.JWTCallerPrincipalFactory-">setInstance</a></span>(<a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html" title="class in org.apache.tomee.microprofile.jwt.principal">JWTCallerPrincipalFactory</a> resolver)</code> |
| <div class="block">Set the instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="JWTCallerPrincipalFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JWTCallerPrincipalFactory</h4> |
| <pre>public JWTCallerPrincipalFactory()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="instance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>instance</h4> |
| <pre>public static <a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html" title="class in org.apache.tomee.microprofile.jwt.principal">JWTCallerPrincipalFactory</a> instance()</pre> |
| <div class="block">Obtain the JWTCallerPrincipalFactory that has been set or by using the ServiceLoader pattern.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the factory instance</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html#setInstance-org.apache.tomee.microprofile.jwt.principal.JWTCallerPrincipalFactory-"><code>setInstance(JWTCallerPrincipalFactory)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInstance-org.apache.tomee.microprofile.jwt.principal.JWTCallerPrincipalFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInstance</h4> |
| <pre>public static void setInstance(<a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html" title="class in org.apache.tomee.microprofile.jwt.principal">JWTCallerPrincipalFactory</a> resolver)</pre> |
| <div class="block">Set the instance. It is used by OSGi environment where service loader pattern is not supported.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resolver</code> - the instance to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="parse-java.lang.String-org.apache.tomee.microprofile.jwt.config.JWTAuthContextInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>parse</h4> |
| <pre>public abstract <a href="../../../../../../org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipal.html" title="class in org.apache.tomee.microprofile.jwt.principal">JWTCallerPrincipal</a> parse(java.lang.String token, |
| <a href="../../../../../../org/apache/tomee/microprofile/jwt/config/JWTAuthContextInfo.html" title="class in org.apache.tomee.microprofile.jwt.config">JWTAuthContextInfo</a> authContextInfo) |
| throws <a href="../../../../../../org/apache/tomee/microprofile/jwt/ParseException.html" title="class in org.apache.tomee.microprofile.jwt">ParseException</a></pre> |
| <div class="block">Parse the given bearer token string into a JWTCallerPrincipal instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>token</code> - - the bearer token provided for authorization</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A JWTCallerPrincipal representation for the token.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/tomee/microprofile/jwt/ParseException.html" title="class in org.apache.tomee.microprofile.jwt">ParseException</a></code> - on parse or verification failure.</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/principal/JWTCallerPrincipal.html" title="class in org.apache.tomee.microprofile.jwt.principal"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/tomee/microprofile/jwt/principal/JWTCallerPrincipalFactory.html" target="_top">Frames</a></li> |
| <li><a href="JWTCallerPrincipalFactory.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 ======= --> |
| </body> |
| </html> |
