blob: 20532af8ea7c3d05656c7346e39b6cb8d32a3cbd [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 -->
<title>Uses of Class org.eclipse.jetty.security.ConstraintMapping (Eclipse Jetty API Doc - v10.0.12)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-09-15">
<meta name="description" content="use: package: org.eclipse.jetty.security, class: ConstraintMapping">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/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="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Class org.eclipse.jetty.security.ConstraintMapping" class="title">Uses of Class<br>org.eclipse.jetty.security.ConstraintMapping</h1>
</div>
<div class="caption"><span>Packages that use <a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.eclipse.jetty.security">org.eclipse.jetty.security</a></div>
<div class="col-last even-row-color">
<div class="block">Jetty Security : Modular Support for Security in Jetty</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.eclipse.jetty.security">
<h2>Uses of <a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a> in <a href="../package-summary.html">org.eclipse.jetty.security</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.eclipse.jetty.security</a> that return types with arguments of type <a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#createConstraintsWithMappingsForPath(java.lang.String,java.lang.String,javax.servlet.ServletSecurityElement)" class="member-name-link">createConstraintsWithMappingsForPath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pathSpec,
javax.servlet.ServletSecurityElement&nbsp;securityElement)</code></div>
<div class="col-last even-row-color">
<div class="block">Generate Constraints and ContraintMappings for the given url pattern and ServletSecurityElement</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ConstraintAware.</span><code><a href="../ConstraintAware.html#getConstraintMappings()" class="member-name-link">getConstraintMappings</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#getConstraintMappings()" class="member-name-link">getConstraintMappings</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#getConstraintMappingsForPath(java.lang.String,java.util.List)" class="member-name-link">getConstraintMappingsForPath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pathSpec,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;&nbsp;constraintMappings)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#removeConstraintMappingsForPath(java.lang.String,java.util.List)" class="member-name-link">removeConstraintMappingsForPath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pathSpec,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;&nbsp;constraintMappings)</code></div>
<div class="col-last even-row-color">
<div class="block">Take out of the constraint mappings those that match the
given path.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.eclipse.jetty.security</a> with parameters of type <a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintAware.</span><code><a href="../ConstraintAware.html#addConstraintMapping(org.eclipse.jetty.security.ConstraintMapping)" class="member-name-link">addConstraintMapping</a><wbr>(<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&nbsp;mapping)</code></div>
<div class="col-last even-row-color">
<div class="block">Add a Constraint Mapping.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#addConstraintMapping(org.eclipse.jetty.security.ConstraintMapping)" class="member-name-link">addConstraintMapping</a><wbr>(<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&nbsp;mapping)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected <a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#asPathSpec(org.eclipse.jetty.security.ConstraintMapping)" class="member-name-link">asPathSpec</a><wbr>(<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&nbsp;mapping)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#configureRoleInfo(org.eclipse.jetty.security.RoleInfo,org.eclipse.jetty.security.ConstraintMapping)" class="member-name-link">configureRoleInfo</a><wbr>(<a href="../RoleInfo.html" title="class in org.eclipse.jetty.security">RoleInfo</a>&nbsp;ri,
<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&nbsp;mapping)</code></div>
<div class="col-last odd-row-color">
<div class="block">Initialize or update the RoleInfo from the constraint</div>
</div>
<div class="col-first even-row-color"><code>protected void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#processConstraintMapping(org.eclipse.jetty.security.ConstraintMapping)" class="member-name-link">processConstraintMapping</a><wbr>(<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&nbsp;mapping)</code></div>
<div class="col-last even-row-color">
<div class="block">Create and combine the constraint with the existing processed
constraints.</div>
</div>
<div class="col-first odd-row-color"><code>protected void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#processConstraintMappingWithMethodOmissions(org.eclipse.jetty.security.ConstraintMapping,java.util.Map)" class="member-name-link">processConstraintMappingWithMethodOmissions</a><wbr>(<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&nbsp;mapping,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../RoleInfo.html" title="class in org.eclipse.jetty.security">RoleInfo</a>&gt;&nbsp;mappings)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constraints that name method omissions are dealt with differently.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#setConstraintMappings(org.eclipse.jetty.security.ConstraintMapping%5B%5D)" class="member-name-link">setConstraintMappings</a><wbr>(<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>[]&nbsp;constraintMappings)</code></div>
<div class="col-last even-row-color">
<div class="block">Process the constraints following the combining rules in Servlet 3.0 EA
spec section 13.7.1 Note that much of the logic is in the RoleInfo class.</div>
</div>
</div>
<div class="caption"><span>Method parameters in <a href="../package-summary.html">org.eclipse.jetty.security</a> with type arguments of type <a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#getConstraintMappingsForPath(java.lang.String,java.util.List)" class="member-name-link">getConstraintMappingsForPath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pathSpec,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;&nbsp;constraintMappings)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#removeConstraintMappingsForPath(java.lang.String,java.util.List)" class="member-name-link">removeConstraintMappingsForPath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pathSpec,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;&nbsp;constraintMappings)</code></div>
<div class="col-last odd-row-color">
<div class="block">Take out of the constraint mappings those that match the
given path.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintAware.</span><code><a href="../ConstraintAware.html#setConstraintMappings(java.util.List,java.util.Set)" class="member-name-link">setConstraintMappings</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;&nbsp;constraintMappings,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;roles)</code></div>
<div class="col-last even-row-color">
<div class="block">Set Constraint Mappings and roles.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#setConstraintMappings(java.util.List)" class="member-name-link">setConstraintMappings</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;&nbsp;constraintMappings)</code></div>
<div class="col-last odd-row-color">
<div class="block">Process the constraints following the combining rules in Servlet 3.0 EA
spec section 13.7.1 Note that much of the logic is in the RoleInfo class.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ConstraintSecurityHandler.</span><code><a href="../ConstraintSecurityHandler.html#setConstraintMappings(java.util.List,java.util.Set)" class="member-name-link">setConstraintMappings</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../ConstraintMapping.html" title="class in org.eclipse.jetty.security">ConstraintMapping</a>&gt;&nbsp;constraintMappings,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;roles)</code></div>
<div class="col-last even-row-color">
<div class="block">Process the constraints following the combining rules in Servlet 3.0 EA
spec section 13.7.1 Note that much of the logic is in the RoleInfo class.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>