| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Role (Apache Archiva Redback 3.0.0-SNAPSHOT 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.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="Role (Apache Archiva Redback 3.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":18,"i9":6,"i10":6,"i11":18,"i12":6,"i13":6,"i14":6,"i15":18,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/Role.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.apache.archiva.redback.rbac</a></div> |
| <h2 title="Interface Role" class="title">Interface Role</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractRole.html" title="class in org.apache.archiva.redback.rbac">AbstractRole</a></code>, <code><a href="jpa/model/JpaRole.html" title="class in org.apache.archiva.redback.rbac.jpa.model">JpaRole</a></code>, <code><a href="memory/MemoryRole.html" title="class in org.apache.archiva.redback.rbac.memory">MemoryRole</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.40">Role</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre> |
| <div class="block">Role |
| |
| A role is assignable to a user and effectively grants that user all of the |
| permissions that are present in that role. A role can also contain other roles |
| which add the permissions in those roles to the available permissions for authorization. |
| |
| A role can contain any number of permissions |
| A role can contain any number of other roles |
| A role can be assigned to any number of users</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Jesse McConnell, <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>, Martin Stockhammer <martin_s@apache.org></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addChildRole(org.apache.archiva.redback.rbac.Role)">addChildRole</a></span>​(<a href="Role.html" title="interface in org.apache.archiva.redback.rbac">Role</a> child)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a child role and sets the list of child names and child ids.</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="#addChildRoleId(java.lang.String)">addChildRoleId</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> id)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a child role id</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addChildRoleName(java.lang.String)">addChildRoleName</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a role to the list of child roles</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addPermission(org.apache.archiva.redback.rbac.Permission)">addPermission</a></span>​(<a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a> permission)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a permission to the list</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChildRoleIds()">getChildRoleIds</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the child role ids</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChildRoleNames()">getChildRoleNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the list of child roles</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescription()">getDescription</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Long description of the role.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getId()">getId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The role identifier.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getModelId()">getModelId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the model the role is derived from.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPermissions()">getPermissions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the list of permissions assigned to this role.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResource()">getResource</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the resource that is used to build this role from a template.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasChildRoles()">hasChildRoles</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method to see if Role has Child Roles.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAssignable()">isAssignable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><code>True</code>, if this role is available to be assigned to a user, otherwise <code>false</code>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPermanent()">isPermanent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Test to see if the object is a permanent object or not.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTemplateInstance()">isTemplateInstance</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code>, if this role is a instance of a template role, otherwise <code>false</code>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removePermission(org.apache.archiva.redback.rbac.Permission)">removePermission</a></span>​(<a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a> permission)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the given permission from the list.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAssignable(boolean)">setAssignable</a></span>​(boolean assignable)</code></th> |
| <td class="colLast"> |
| <div class="block">Set to <code>true</code>, if this role should available to be assigned to a user</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setChildRoleIds(java.util.List)">setChildRoleIds</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> ids)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the list of child role ids</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setChildRoleNames(java.util.List)">setChildRoleNames</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> names)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the names of children roles.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDescription(java.lang.String)">setDescription</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the Description</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setId(java.lang.String)">setId</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> id)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the role id</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setModelId(java.lang.String)">setModelId</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> modelId)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the model id.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setName(java.lang.String)">setName</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the role name |
| |
| NOTE: This field is considered the Primary Key for this object.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPermanent(boolean)">setPermanent</a></span>​(boolean permanent)</code></th> |
| <td class="colLast"> |
| <div class="block">Set flag indicating if the object is a permanent object or not.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPermissions(java.util.List)">setPermissions</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a>> permissions)</code></th> |
| <td class="colLast"> |
| <div class="block">Set role permissions.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResource(java.lang.String)">setResource</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the resource, this template instance is attached to.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTemplateInstance(boolean)">setTemplateInstance</a></span>​(boolean templateInstanceFlag)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the template instance flag.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="addPermission(org.apache.archiva.redback.rbac.Permission)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPermission</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.48">addPermission</a>​(<a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a> permission)</pre> |
| <div class="block">Adds a permission to the list</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permission</code> - the permission to add to the list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addChildRoleName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildRoleName</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.55">addChildRoleName</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Adds a role to the list of child roles</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the child role.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getChildRoleNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildRoleNames</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.60">getChildRoleNames</a>()</pre> |
| <div class="block">Returns the list of child roles</div> |
| </li> |
| </ul> |
| <a id="addChildRole(org.apache.archiva.redback.rbac.Role)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildRole</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.66">addChildRole</a>​(<a href="Role.html" title="interface in org.apache.archiva.redback.rbac">Role</a> child)</pre> |
| <div class="block">Adds a child role and sets the list of child names and child ids.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>child</code> - the child role</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addChildRoleId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addChildRoleId</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.72">addChildRoleId</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> id)</pre> |
| <div class="block">Adds a child role id</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - the id</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getChildRoleIds()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildRoleIds</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.78">getChildRoleIds</a>()</pre> |
| <div class="block">Returns the child role ids</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of child role ids</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasChildRoles()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasChildRoles</h4> |
| <pre class="methodSignature">boolean <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.85">hasChildRoles</a>()</pre> |
| <div class="block">Convenience method to see if Role has Child Roles.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if child roles exists and has any roles being tracked.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDescription()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.91">getDescription</a>()</pre> |
| <div class="block">Long description of the role.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the role description</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.99">getName</a>()</pre> |
| <div class="block">Get the name. Must be unique. |
| |
| NOTE: This field is considered the Primary Key for this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the role</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPermissions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPermissions</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a>> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.105">getPermissions</a>()</pre> |
| <div class="block">Returns the list of permissions assigned to this role.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of permissions assigned to this role</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAssignable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAssignable</h4> |
| <pre class="methodSignature">boolean <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.112">isAssignable</a>()</pre> |
| <div class="block"><code>True</code>, if this role is available to be assigned to a user, otherwise <code>false</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code>, if this role can be assigned to users, otherwise <code>false</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removePermission(org.apache.archiva.redback.rbac.Permission)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePermission</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.120">removePermission</a>​(<a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a> permission)</pre> |
| <div class="block">Removes the given permission from the list. If the permission does not exist in the list of assigned |
| permissions, nothing happens.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permission</code> - the permission to remove.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAssignable(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAssignable</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.127">setAssignable</a>​(boolean assignable)</pre> |
| <div class="block">Set to <code>true</code>, if this role should available to be assigned to a user</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>assignable</code> - the assignable flag</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setChildRoleNames(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setChildRoleNames</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.134">setChildRoleNames</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> names)</pre> |
| <div class="block">Sets the names of children roles. Children roles inherit the permissions of the parent role.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - the list of names of child roles.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setChildRoleIds(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setChildRoleIds</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.140">setChildRoleIds</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> ids)</pre> |
| <div class="block">Sets the list of child role ids</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ids</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDescription(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescription</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.147">setDescription</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</pre> |
| <div class="block">Set the Description</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>description</code> - the role description</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.156">setName</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Set the role name |
| |
| NOTE: This field is considered the Primary Key for this object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the role name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPermissions(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPermissions</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.163">setPermissions</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="Permission.html" title="interface in org.apache.archiva.redback.rbac">Permission</a>> permissions)</pre> |
| <div class="block">Set role permissions. The list of assigned permissions is replaced by this list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissions</code> - the permissions to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isPermanent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPermanent</h4> |
| <pre class="methodSignature">boolean <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.170">isPermanent</a>()</pre> |
| <div class="block">Test to see if the object is a permanent object or not.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code>, if the object is permanent.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setPermanent(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPermanent</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.177">setPermanent</a>​(boolean permanent)</pre> |
| <div class="block">Set flag indicating if the object is a permanent object or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permanent</code> - true if the object is permanent.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.185">getId</a>()</pre> |
| <div class="block">The role identifier. Should be built from the modelId and the resource. And must be unique.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the role identifier</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setId</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.193">setId</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> id)</pre> |
| <div class="block">Sets the role id</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - the identifier of the role, should not be null or empty.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getModelId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getModelId</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.201">getModelId</a>()</pre> |
| <div class="block">Returns the model the role is derived from.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The model id or empty string, if this role was not created from a model</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setModelId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setModelId</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.210">setModelId</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> modelId)</pre> |
| <div class="block">Sets the model id.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>modelId</code> - the identifier of the model, or empty string. Should not be null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isTemplateInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTemplateInstance</h4> |
| <pre class="methodSignature">default boolean <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.219">isTemplateInstance</a>()</pre> |
| <div class="block">Returns <code>true</code>, if this role is a instance of a template role, otherwise <code>false</code>. |
| Templated roles are built from a template together with a resource identifier.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code>, if this role is a templated role, otherwise <code>false</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTemplateInstance(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTemplateInstance</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.229">setTemplateInstance</a>​(boolean templateInstanceFlag)</pre> |
| <div class="block">Sets the template instance flag.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateInstanceFlag</code> - Set to <code>true</code>, if this is a template instance, otherwise <code>false</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getResource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResource</h4> |
| <pre class="methodSignature">default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.238">getResource</a>()</pre> |
| <div class="block">Returns the resource that is used to build this role from a template. If this is not a templated |
| role, a empty string should be returned.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the resource identifier, used to build this role or a empty string, if this role is not templated</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setResource</h4> |
| <pre class="methodSignature">void <a href="../../../../../src-html/org/apache/archiva/redback/rbac/Role.html#line.247">setResource</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> resource)</pre> |
| <div class="block">Sets the resource, this template instance is attached to.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - the resource identifier. Must not be null.</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/Role.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2006–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
