| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Oct 11 11:08:51 CDT 2021 --> |
| <title>ServletSecurityAnnotationHandler (Eclipse Jetty API Doc - v10.0.7)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-10-11"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ServletSecurityAnnotationHandler (Eclipse Jetty API Doc - v10.0.7)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":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"; |
| 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"> |
| <!-- ========= 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="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServletSecurityAnnotationHandler.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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All 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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.annotations</a></div> |
| <h2 title="Class ServletSecurityAnnotationHandler" class="title">Class ServletSecurityAnnotationHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html" title="class in org.eclipse.jetty.annotations">org.eclipse.jetty.annotations.AnnotationIntrospector.AbstractIntrospectableAnnotationHandler</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.annotations.ServletSecurityAnnotationHandler</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="AnnotationIntrospector.IntrospectableAnnotationHandler.html" title="interface in org.eclipse.jetty.annotations">AnnotationIntrospector.IntrospectableAnnotationHandler</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ServletSecurityAnnotationHandler</span> |
| extends <a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html" title="class in org.eclipse.jetty.annotations">AnnotationIntrospector.AbstractIntrospectableAnnotationHandler</a></pre> |
| <div class="block">ServletSecurityAnnotationHandler |
| |
| Inspect a class to see if it has an <code>@ServletSecurity</code> annotation on it, |
| setting up the <code><security-constraint>s</code>. |
| |
| A servlet can be defined in: |
| <ul> |
| <li>web.xml</li> |
| <li>web-fragment.xml</li> |
| <li>@WebServlet annotation discovered</li> |
| <li>ServletContext.createServlet</li> |
| </ul> |
| |
| The ServletSecurity annotation for a servlet should only be processed |
| iff metadata-complete == false.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.annotations.AnnotationIntrospector.AbstractIntrospectableAnnotationHandler"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.annotations.<a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html" title="class in org.eclipse.jetty.annotations">AnnotationIntrospector.AbstractIntrospectableAnnotationHandler</a></h3> |
| <code><a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html#_context">_context</a>, <a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html#_introspectAncestors">_introspectAncestors</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.webapp.WebAppContext)">ServletSecurityAnnotationHandler</a></span>​(<a href="../webapp/WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> wac)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constraintsExist(java.util.List,java.util.List)">constraintsExist</a></span>​(java.util.List<<a href="../servlet/ServletMapping.html" title="class in org.eclipse.jetty.servlet">ServletMapping</a>> servletMappings, |
| java.util.List<<a href="../security/ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>> constraintMappings)</code></th> |
| <td class="colLast"> |
| <div class="block">Check if there are already <code><security-constraint></code> elements defined that match the url-patterns for |
| the servlet.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doHandle(java.lang.Class)">doHandle</a></span>​(java.lang.Class clazz)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<<a href="../servlet/ServletMapping.html" title="class in org.eclipse.jetty.servlet">ServletMapping</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletMappings(java.lang.String)">getServletMappings</a></span>​(java.lang.String className)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the ServletMappings for the servlet's class.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../util/security/Constraint.html" title="class in org.eclipse.jetty.util.security">Constraint</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeConstraint(java.lang.Class,java.lang.String%5B%5D,javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic,javax.servlet.annotation.ServletSecurity.TransportGuarantee)">makeConstraint</a></span>​(java.lang.Class servlet, |
| java.lang.String[] rolesAllowed, |
| javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic permitOrDeny, |
| javax.servlet.annotation.ServletSecurity.TransportGuarantee transport)</code></th> |
| <td class="colLast"> |
| <div class="block">Make a jetty Constraint object, which represents the <code><auth-constraint></code> and |
| <code><user-data-constraint></code> elements, based on the security annotation.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.annotations.AnnotationIntrospector.AbstractIntrospectableAnnotationHandler"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.annotations.<a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html" title="class in org.eclipse.jetty.annotations">AnnotationIntrospector.AbstractIntrospectableAnnotationHandler</a></h3> |
| <code><a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html#getContext()">getContext</a>, <a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html#handle(java.lang.Class)">handle</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.jetty.webapp.WebAppContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ServletSecurityAnnotationHandler</h4> |
| <pre>public ServletSecurityAnnotationHandler​(<a href="../webapp/WebAppContext.html" title="class in org.eclipse.jetty.webapp">WebAppContext</a> wac)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="doHandle(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doHandle</h4> |
| <pre class="methodSignature">public void doHandle​(java.lang.Class clazz)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html#doHandle(java.lang.Class)">doHandle</a></code> in class <code><a href="AnnotationIntrospector.AbstractIntrospectableAnnotationHandler.html" title="class in org.eclipse.jetty.annotations">AnnotationIntrospector.AbstractIntrospectableAnnotationHandler</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="makeConstraint(java.lang.Class,java.lang.String[],javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic,javax.servlet.annotation.ServletSecurity.TransportGuarantee)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makeConstraint</h4> |
| <pre class="methodSignature">protected <a href="../util/security/Constraint.html" title="class in org.eclipse.jetty.util.security">Constraint</a> makeConstraint​(java.lang.Class servlet, |
| java.lang.String[] rolesAllowed, |
| javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic permitOrDeny, |
| javax.servlet.annotation.ServletSecurity.TransportGuarantee transport)</pre> |
| <div class="block">Make a jetty Constraint object, which represents the <code><auth-constraint></code> and |
| <code><user-data-constraint></code> elements, based on the security annotation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servlet</code> - the servlet</dd> |
| <dd><code>rolesAllowed</code> - the roles allowed</dd> |
| <dd><code>permitOrDeny</code> - the role / permission semantic</dd> |
| <dd><code>transport</code> - the transport guarantee</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constraint</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServletMappings(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletMappings</h4> |
| <pre class="methodSignature">protected java.util.List<<a href="../servlet/ServletMapping.html" title="class in org.eclipse.jetty.servlet">ServletMapping</a>> getServletMappings​(java.lang.String className)</pre> |
| <div class="block">Get the ServletMappings for the servlet's class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>className</code> - the class name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the servlet mappings for the class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="constraintsExist(java.util.List,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>constraintsExist</h4> |
| <pre class="methodSignature">protected boolean constraintsExist​(java.util.List<<a href="../servlet/ServletMapping.html" title="class in org.eclipse.jetty.servlet">ServletMapping</a>> servletMappings, |
| java.util.List<<a href="../security/ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>> constraintMappings)</pre> |
| <div class="block">Check if there are already <code><security-constraint></code> elements defined that match the url-patterns for |
| the servlet.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servletMappings</code> - the servlet mappings</dd> |
| <dd><code>constraintMappings</code> - the constraint mappings</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if constraint exists</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServletSecurityAnnotationHandler.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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
