Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.10.1 / shiro-support / shiro-jaxrs / apidocs / index-all.html
blob: f42a72bd39ddae0fd117ba389dcc30c1be769ddd [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Index (Apache Shiro :: Support :: JAX-RS 1.10.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (Apache Shiro :: Support :: JAX-RS 1.10.1 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code -->
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="org/apache/shiro/web/jaxrs/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/apache/shiro/web/jaxrs/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="contentContainer"><a href="#I:A">A</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="allpackages-index.html">All&nbsp;Packages</a><a id="I:A">
<!-- -->
</a>
<h2 class="title">A</h2>
<dl>
<dt><a href="org/apache/shiro/web/jaxrs/AnnotationAuthorizationFilter.html" title="class in org.apache.shiro.web.jaxrs"><span class="typeNameLink">AnnotationAuthorizationFilter</span></a> - Class in <a href="org/apache/shiro/web/jaxrs/package-summary.html">org.apache.shiro.web.jaxrs</a></dt>
<dd>
<div class="block">A filter that grants or denies access to a JAX-RS resource based on the Shiro annotations on it.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/AnnotationAuthorizationFilter.html#%3Cinit%3E(java.util.Collection)">AnnotationAuthorizationFilter(Collection&lt;Annotation&gt;)</a></span> - Constructor for class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/AnnotationAuthorizationFilter.html" title="class in org.apache.shiro.web.jaxrs">AnnotationAuthorizationFilter</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:C">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroAnnotationFilterFeature.html#configure(javax.ws.rs.container.ResourceInfo,javax.ws.rs.core.FeatureContext)">configure(ResourceInfo, FeatureContext)</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroAnnotationFilterFeature.html" title="class in org.apache.shiro.web.jaxrs">ShiroAnnotationFilterFeature</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroFeature.html#configure(javax.ws.rs.core.FeatureContext)">configure(FeatureContext)</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroFeature.html" title="class in org.apache.shiro.web.jaxrs">ShiroFeature</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:E">
<!-- -->
</a>
<h2 class="title">E</h2>
<dl>
<dt><a href="org/apache/shiro/web/jaxrs/ExceptionMapper.html" title="class in org.apache.shiro.web.jaxrs"><span class="typeNameLink">ExceptionMapper</span></a> - Class in <a href="org/apache/shiro/web/jaxrs/package-summary.html">org.apache.shiro.web.jaxrs</a></dt>
<dd>
<div class="block">JAX-RS exception mapper used to map Shiro <code>AuthorizationExceptions</code> to HTTP status codes.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ExceptionMapper.html#%3Cinit%3E()">ExceptionMapper()</a></span> - Constructor for class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ExceptionMapper.html" title="class in org.apache.shiro.web.jaxrs">ExceptionMapper</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:F">
<!-- -->
</a>
<h2 class="title">F</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/AnnotationAuthorizationFilter.html#filter(javax.ws.rs.container.ContainerRequestContext)">filter(ContainerRequestContext)</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/AnnotationAuthorizationFilter.html" title="class in org.apache.shiro.web.jaxrs">AnnotationAuthorizationFilter</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/SubjectPrincipalRequestFilter.html#filter(javax.ws.rs.container.ContainerRequestContext)">filter(ContainerRequestContext)</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/SubjectPrincipalRequestFilter.html" title="class in org.apache.shiro.web.jaxrs">SubjectPrincipalRequestFilter</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:G">
<!-- -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html#getAuthenticationScheme()">getAuthenticationScheme()</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html" title="class in org.apache.shiro.web.jaxrs">ShiroSecurityContext</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html#getUserPrincipal()">getUserPrincipal()</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html" title="class in org.apache.shiro.web.jaxrs">ShiroSecurityContext</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:I">
<!-- -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html#isSecure()">isSecure()</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html" title="class in org.apache.shiro.web.jaxrs">ShiroSecurityContext</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html#isUserInRole(java.lang.String)">isUserInRole(String)</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html" title="class in org.apache.shiro.web.jaxrs">ShiroSecurityContext</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:O">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><a href="org/apache/shiro/web/jaxrs/package-summary.html">org.apache.shiro.web.jaxrs</a> - package org.apache.shiro.web.jaxrs</dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><a href="org/apache/shiro/web/jaxrs/ShiroAnnotationFilterFeature.html" title="class in org.apache.shiro.web.jaxrs"><span class="typeNameLink">ShiroAnnotationFilterFeature</span></a> - Class in <a href="org/apache/shiro/web/jaxrs/package-summary.html">org.apache.shiro.web.jaxrs</a></dt>
<dd>
<div class="block">Wraps <code>filters</code> around JAX-RS resources that are annotated with Shiro annotations.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroAnnotationFilterFeature.html#%3Cinit%3E()">ShiroAnnotationFilterFeature()</a></span> - Constructor for class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroAnnotationFilterFeature.html" title="class in org.apache.shiro.web.jaxrs">ShiroAnnotationFilterFeature</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/shiro/web/jaxrs/ShiroFeature.html" title="class in org.apache.shiro.web.jaxrs"><span class="typeNameLink">ShiroFeature</span></a> - Class in <a href="org/apache/shiro/web/jaxrs/package-summary.html">org.apache.shiro.web.jaxrs</a></dt>
<dd>
<div class="block">Shiro JAX-RS feature which includes <a href="org/apache/shiro/web/jaxrs/ExceptionMapper.html" title="class in org.apache.shiro.web.jaxrs"><code>ExceptionMapper</code></a>, <a href="org/apache/shiro/web/jaxrs/SubjectPrincipalRequestFilter.html" title="class in org.apache.shiro.web.jaxrs"><code>SubjectPrincipalRequestFilter</code></a>, and
<a href="org/apache/shiro/web/jaxrs/ShiroAnnotationFilterFeature.html" title="class in org.apache.shiro.web.jaxrs"><code>ShiroAnnotationFilterFeature</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroFeature.html#%3Cinit%3E()">ShiroFeature()</a></span> - Constructor for class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroFeature.html" title="class in org.apache.shiro.web.jaxrs">ShiroFeature</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html" title="class in org.apache.shiro.web.jaxrs"><span class="typeNameLink">ShiroSecurityContext</span></a> - Class in <a href="org/apache/shiro/web/jaxrs/package-summary.html">org.apache.shiro.web.jaxrs</a></dt>
<dd>
<div class="block">A Shiro based <code>SecurityContext</code> that exposes the current Shiro <code>Subject</code> as a <a href="https://docs.oracle.com/javase/8/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security" class="externalLink"><code>Principal</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html#%3Cinit%3E(javax.ws.rs.container.ContainerRequestContext)">ShiroSecurityContext(ContainerRequestContext)</a></span> - Constructor for class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html" title="class in org.apache.shiro.web.jaxrs">ShiroSecurityContext</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/shiro/web/jaxrs/SubjectPrincipalRequestFilter.html" title="class in org.apache.shiro.web.jaxrs"><span class="typeNameLink">SubjectPrincipalRequestFilter</span></a> - Class in <a href="org/apache/shiro/web/jaxrs/package-summary.html">org.apache.shiro.web.jaxrs</a></dt>
<dd>
<div class="block">A <code>ContainerRequestFilter</code> that replaces the <code>SecurityContext</code>
with a <a href="org/apache/shiro/web/jaxrs/ShiroSecurityContext.html" title="class in org.apache.shiro.web.jaxrs"><code>ShiroSecurityContext</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/SubjectPrincipalRequestFilter.html#%3Cinit%3E()">SubjectPrincipalRequestFilter()</a></span> - Constructor for class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/SubjectPrincipalRequestFilter.html" title="class in org.apache.shiro.web.jaxrs">SubjectPrincipalRequestFilter</a></dt>
<dd>&nbsp;</dd>
</dl>
<a id="I:T">
<!-- -->
</a>
<h2 class="title">T</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/shiro/web/jaxrs/ExceptionMapper.html#toResponse(org.apache.shiro.authz.AuthorizationException)">toResponse(AuthorizationException)</a></span> - Method in class org.apache.shiro.web.jaxrs.<a href="org/apache/shiro/web/jaxrs/ExceptionMapper.html" title="class in org.apache.shiro.web.jaxrs">ExceptionMapper</a></dt>
<dd>&nbsp;</dd>
</dl>
<a href="#I:A">A</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:E">E</a>&nbsp;<a href="#I:F">F</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="allpackages-index.html">All&nbsp;Packages</a></div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="org/apache/shiro/web/jaxrs/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/apache/shiro/web/jaxrs/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>