| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>DefaultRoleService (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="DefaultRoleService (Apache Archiva Redback 3.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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/DefaultRoleService.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.apache.archiva.redback.rest.services.v2</a></div> |
| <h2 title="Class DefaultRoleService" class="title">Class DefaultRoleService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="BaseRedbackService.html" title="class in org.apache.archiva.redback.rest.services.v2">org.apache.archiva.redback.rest.services.v2.BaseRedbackService</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.archiva.redback.rest.services.v2.DefaultRoleService</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="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| </dl> |
| <hr> |
| <pre>@Service("v2.roleService#rest") |
| public class <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.71">DefaultRoleService</a> |
| extends <a href="BaseRedbackService.html" title="class in org.apache.archiva.redback.rest.services.v2">BaseRedbackService</a> |
| implements <a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.3</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Olivier Lamy</dd> |
| </dl> |
| </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.apache.archiva.redback.rest.services.v2.BaseRedbackService"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.archiva.redback.rest.services.v2.<a href="BaseRedbackService.html" title="class in org.apache.archiva.redback.rest.services.v2">BaseRedbackService</a></h3> |
| <code><a href="BaseRedbackService.html#rbacManager">rbacManager</a>, <a href="BaseRedbackService.html#USER_FILTER_MAP">USER_FILTER_MAP</a>, <a href="BaseRedbackService.html#USER_ORDER_MAP">USER_ORDER_MAP</a>, <a href="BaseRedbackService.html#USER_QUERY_HELPER">USER_QUERY_HELPER</a>, <a href="BaseRedbackService.html#userManager">userManager</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.apache.archiva.redback.role.RoleManager,org.apache.archiva.redback.rbac.RBACManager,org.apache.archiva.redback.users.UserManager)">DefaultRoleService</a></span>​(<a href="../../../role/RoleManager.html" title="interface in org.apache.archiva.redback.role">RoleManager</a> roleManager, |
| <a href="../../../rbac/RBACManager.html" title="interface in org.apache.archiva.redback.rbac">RBACManager</a> rbacManager, |
| <a href="../../../users/UserManager.html" title="interface in org.apache.archiva.redback.users">UserManager</a> userManager)</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><a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assignRole(java.lang.String,java.lang.String)">assignRole</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> roleId, |
| <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> userId)</code></th> |
| <td class="colLast"> |
| <div class="block">Assigns the role indicated by the roleId to the given principal</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assignTemplatedRole(java.lang.String,java.lang.String,java.lang.String)">assignTemplatedRole</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> templateId, |
| <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, |
| <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> userId)</code></th> |
| <td class="colLast"> |
| <div class="block">Assigns the templated role indicated by the templateId |
| |
| fails if the templated role has not been created</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkRole(java.lang.String)">checkRole</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> roleId)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkTemplateRole(java.lang.String,java.lang.String)">checkTemplateRole</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> templateId, |
| <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"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createTemplatedRole(java.lang.String,java.lang.String)">createTemplatedRole</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> templateId, |
| <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"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteRoleAssignment(java.lang.String,java.lang.String)">deleteRoleAssignment</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> roleId, |
| <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> userId)</code></th> |
| <td class="colLast"> |
| <div class="block">Deletes the assignment of a role to a user.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>org.apache.archiva.components.rest.model.PagedResult<<a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllRoles(java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">getAllRoles</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> searchTerm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> limit, |
| <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>> orderBy, |
| <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> order)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRole(java.lang.String)">getRole</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> roleId)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>org.apache.archiva.components.rest.model.PagedResult<<a href="../../api/model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoleUsers(java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">getRoleUsers</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> roleId, |
| <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> recurse, |
| <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> searchTerm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> limit, |
| <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>> orderBy, |
| <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> order)</code></th> |
| <td class="colLast"> |
| <div class="block">This returns the list of assigned users to a given role.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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="../../api/model/v2/RoleTemplate.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleTemplate</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTemplates()">getTemplates</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>org.apache.archiva.components.rest.model.PagedResult<<a href="../../api/model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnassignedUsers(java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">getUnassignedUsers</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> roleId, |
| <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> recurse, |
| <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> searchTerm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> limit, |
| <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>> orderBy, |
| <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> order)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#moveTemplatedRole(java.lang.String,java.lang.String,java.lang.String)">moveTemplatedRole</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> templateId, |
| <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> oldResource, |
| <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> newResource)</code></th> |
| <td class="colLast"> |
| <div class="block">Moves a templated role from one resource to another resource</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>javax.ws.rs.core.Response</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeTemplatedRole(java.lang.String,java.lang.String)">removeTemplatedRole</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> templateId, |
| <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">Removes a role corresponding to the role Id that was manufactured with the given resource |
| it also removes any user assignments for that role</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateRole(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.Role)">updateRole</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> roleId, |
| <a href="../../api/model/v2/Role.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Role</a> role)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates a role.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.archiva.redback.rest.services.v2.BaseRedbackService"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.archiva.redback.rest.services.v2.<a href="BaseRedbackService.html" title="class in org.apache.archiva.redback.rest.services.v2">BaseRedbackService</a></h3> |
| <code><a href="BaseRedbackService.html#getAssignedRedbackUsers(org.apache.archiva.redback.rbac.Role)">getAssignedRedbackUsers</a>, <a href="BaseRedbackService.html#getAssignedRedbackUsersRecursive(org.apache.archiva.redback.rbac.Role,boolean)">getAssignedRedbackUsersRecursive</a>, <a href="BaseRedbackService.html#getAssignedUsersRecursive(org.apache.archiva.redback.rbac.Role)">getAssignedUsersRecursive</a>, <a href="BaseRedbackService.html#getChildRoles(org.apache.archiva.redback.rbac.Role)">getChildRoles</a>, <a href="BaseRedbackService.html#getParentRoles(org.apache.archiva.redback.rbac.Role)">getParentRoles</a>, <a href="BaseRedbackService.html#getRedbackUser(java.lang.String)">getRedbackUser</a>, <a href="BaseRedbackService.html#getRestUser(org.apache.archiva.redback.users.User)">getRestUser</a>, <a href="BaseRedbackService.html#getRoleInfo(org.apache.archiva.redback.rbac.Role)">getRoleInfo</a>, <a href="BaseRedbackService.html#getRoleInfoOptional(org.apache.archiva.redback.rbac.Role)">getRoleInfoOptional</a>, <a href="BaseRedbackService.html#getUserInfoPagedResult(java.util.List,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,boolean)">getUserInfoPagedResult</a>, <a href="BaseRedbackService.html#isAscending(java.lang.String)">isAscending</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></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.apache.archiva.redback.role.RoleManager,org.apache.archiva.redback.rbac.RBACManager,org.apache.archiva.redback.users.UserManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultRoleService</h4> |
| <pre>@Inject |
| public <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.114">DefaultRoleService</a>​(<a href="../../../role/RoleManager.html" title="interface in org.apache.archiva.redback.role">RoleManager</a> roleManager, |
| @Named("rbacManager#default") |
| <a href="../../../rbac/RBACManager.html" title="interface in org.apache.archiva.redback.rbac">RBACManager</a> rbacManager, |
| @Named("userManager#default") |
| <a href="../../../users/UserManager.html" title="interface in org.apache.archiva.redback.users">UserManager</a> userManager)</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="getAllRoles(java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllRoles</h4> |
| <pre class="methodSignature">public org.apache.archiva.components.rest.model.PagedResult<<a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a>> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.126">getAllRoles</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> searchTerm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> limit, |
| <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>> orderBy, |
| <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> order) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#getAllRoles(java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">getAllRoles</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRole(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRole</h4> |
| <pre class="methodSignature">public <a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.161">getRole</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> roleId) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#getRole(java.lang.String)">getRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkRole(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkRole</h4> |
| <pre class="methodSignature">public javax.ws.rs.core.Response <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.180">checkRole</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> roleId) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#checkRole(java.lang.String)">checkRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="moveTemplatedRole(java.lang.String,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveTemplatedRole</h4> |
| <pre class="methodSignature">public <a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.205">moveTemplatedRole</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> templateId, |
| <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> oldResource, |
| <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> newResource) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/services/v2/RoleService.html#moveTemplatedRole(java.lang.String,java.lang.String,java.lang.String)">RoleService</a></code></span></div> |
| <div class="block">Moves a templated role from one resource to another resource</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#moveTemplatedRole(java.lang.String,java.lang.String,java.lang.String)">moveTemplatedRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>templateId</code> - the template identifier</dd> |
| <dd><code>oldResource</code> - the resource of the current role</dd> |
| <dd><code>newResource</code> - the resource of the new role</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="checkTemplateRole(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkTemplateRole</h4> |
| <pre class="methodSignature">public javax.ws.rs.core.Response <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.243">checkTemplateRole</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> templateId, |
| <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) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#checkTemplateRole(java.lang.String,java.lang.String)">checkTemplateRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createTemplatedRole(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTemplatedRole</h4> |
| <pre class="methodSignature">public <a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.262">createTemplatedRole</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> templateId, |
| <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) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#createTemplatedRole(java.lang.String,java.lang.String)">createTemplatedRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeTemplatedRole(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeTemplatedRole</h4> |
| <pre class="methodSignature">public javax.ws.rs.core.Response <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.299">removeTemplatedRole</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> templateId, |
| <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) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/services/v2/RoleService.html#removeTemplatedRole(java.lang.String,java.lang.String)">RoleService</a></code></span></div> |
| <div class="block">Removes a role corresponding to the role Id that was manufactured with the given resource |
| it also removes any user assignments for that role</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#removeTemplatedRole(java.lang.String,java.lang.String)">removeTemplatedRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="assignRole(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignRole</h4> |
| <pre class="methodSignature">public <a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.323">assignRole</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> roleId, |
| <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> userId) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/services/v2/RoleService.html#assignRole(java.lang.String,java.lang.String)">RoleService</a></code></span></div> |
| <div class="block">Assigns the role indicated by the roleId to the given principal</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#assignRole(java.lang.String,java.lang.String)">assignRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="assignTemplatedRole(java.lang.String,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignTemplatedRole</h4> |
| <pre class="methodSignature">public <a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.359">assignTemplatedRole</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> templateId, |
| <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, |
| <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> userId) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/services/v2/RoleService.html#assignTemplatedRole(java.lang.String,java.lang.String,java.lang.String)">RoleService</a></code></span></div> |
| <div class="block">Assigns the templated role indicated by the templateId |
| |
| fails if the templated role has not been created</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#assignTemplatedRole(java.lang.String,java.lang.String,java.lang.String)">assignTemplatedRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteRoleAssignment(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteRoleAssignment</h4> |
| <pre class="methodSignature">public <a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.396">deleteRoleAssignment</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> roleId, |
| <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> userId) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/services/v2/RoleService.html#deleteRoleAssignment(java.lang.String,java.lang.String)">RoleService</a></code></span></div> |
| <div class="block">Deletes the assignment of a role to a user.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#deleteRoleAssignment(java.lang.String,java.lang.String)">deleteRoleAssignment</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roleId</code> - the role id</dd> |
| <dd><code>userId</code> - the user id</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRoleUsers(java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoleUsers</h4> |
| <pre class="methodSignature">public org.apache.archiva.components.rest.model.PagedResult<<a href="../../api/model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.431">getRoleUsers</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> roleId, |
| <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> recurse, |
| <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> searchTerm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> limit, |
| <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>> orderBy, |
| <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> order) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/services/v2/RoleService.html#getRoleUsers(java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">RoleService</a></code></span></div> |
| <div class="block">This returns the list of assigned users to a given role. The flag "recurse" is a query parameter. |
| If the query parameter exists and is not set to 'false', or '0', it will recurse all parent roles and return a list of users |
| assigned to the current role and the parent roles up to the root. |
| If the query parameter does not exist or is set to 'false' or '0', it will return only the users assigned directly |
| to the given role.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#getRoleUsers(java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">getRoleUsers</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roleId</code> - the role identifier, for which the assigned users are returned</dd> |
| <dd><code>recurse</code> - if the parameter does not exist or is set to 'false' or '0', only directly assigned users are returned. |
| If the parameter value is set to 'parentsOnly', the users assigned to all parent roles up to the root excluding the |
| given role are returned. |
| Otherwise all users assigned to the given role and all parent roles up to the root are returned.</dd> |
| <dd><code>searchTerm</code> - the substring query term to search for in the user ids and names</dd> |
| <dd><code>offset</code> - the offset index in the user list for paging</dd> |
| <dd><code>limit</code> - the maximum number of users returned</dd> |
| <dd><code>orderBy</code> - the order attributes for ordering</dd> |
| <dd><code>order</code> - the order direction 'asc' (ascending), or 'desc' (descending)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of user objects</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUnassignedUsers(java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnassignedUsers</h4> |
| <pre class="methodSignature">public org.apache.archiva.components.rest.model.PagedResult<<a href="../../api/model/v2/UserInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">UserInfo</a>> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.454">getUnassignedUsers</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> roleId, |
| <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> recurse, |
| <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> searchTerm, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a> limit, |
| <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>> orderBy, |
| <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> order) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#getUnassignedUsers(java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.util.List,java.lang.String)">getUnassignedUsers</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="updateRole(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.Role)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateRole</h4> |
| <pre class="methodSignature">public <a href="../../api/model/v2/RoleInfo.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleInfo</a> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.482">updateRole</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> roleId, |
| <a href="../../api/model/v2/Role.html" title="class in org.apache.archiva.redback.rest.api.model.v2">Role</a> role) |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/services/v2/RoleService.html#updateRole(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.Role)">RoleService</a></code></span></div> |
| <div class="block">Updates a role. Attributes that are empty or null will be ignored.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#updateRole(java.lang.String,org.apache.archiva.redback.rest.api.model.v2.Role)">updateRole</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTemplates()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTemplates</h4> |
| <pre class="methodSignature">public <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="../../api/model/v2/RoleTemplate.html" title="class in org.apache.archiva.redback.rest.api.model.v2">RoleTemplate</a>> <a href="../../../../../../../src-html/org/apache/archiva/redback/rest/services/v2/DefaultRoleService.html#line.534">getTemplates</a>() |
| throws <a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/services/v2/RoleService.html#getTemplates()">getTemplates</a></code> in interface <code><a href="../../api/services/v2/RoleService.html" title="interface in org.apache.archiva.redback.rest.api.services.v2">RoleService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../api/services/RedbackServiceException.html" title="class in org.apache.archiva.redback.rest.api.services">RedbackServiceException</a></code></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/DefaultRoleService.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 © 2006–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
