Google Git
Sign in
apache / turbine-fulcrum-security / refs/heads/asf-site / . / apidocs / org / apache / fulcrum / security / RoleManager.html
blob: bd9ea1b4245119f2e6877c0388f9620f667d13fe [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc -->
<title>RoleManager (Fulcrum Security Master Build 2.1.0 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="RoleManager (Fulcrum Security Master Build 2.1.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RoleManager.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&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.fulcrum.security</a></div>
<h2 title="Interface RoleManager" class="title">Interface RoleManager</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="spi/AbstractRoleManager.html" title="class in org.apache.fulcrum.security.spi">AbstractRoleManager</a></code>, <code><a href="memory/MemoryRoleManagerImpl.html" title="class in org.apache.fulcrum.security.memory">MemoryRoleManagerImpl</a></code>, <code><a href="torque/peer/managers/PeerRoleManager.html" title="class in org.apache.fulcrum.security.torque.peer.managers">PeerRoleManager</a></code>, <code><a href="torque/TorqueAbstractRoleManager.html" title="class in org.apache.fulcrum.security.torque">TorqueAbstractRoleManager</a></code>, <code><a href="torque/dynamic/TorqueDynamicRoleManagerImpl.html" title="class in org.apache.fulcrum.security.torque.dynamic">TorqueDynamicRoleManagerImpl</a></code>, <code><a href="torque/turbine/TorqueTurbineRoleManagerImpl.html" title="class in org.apache.fulcrum.security.torque.turbine">TorqueTurbineRoleManagerImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.43">RoleManager</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">A RoleManager performs <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity"><code>Role</code></a>
objects related tasks on behalf of the
<a href="BaseSecurityService.html" title="class in org.apache.fulcrum.security"><code>BaseSecurityService</code></a>.
The responsibilities of this class include loading data of a role from the
storage and putting them into the
<a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity"><code>Role</code></a> objects, saving those data
to the permanent storage.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Id$</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:epugh@upstate.com">Eric Pugh</a></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>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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="#ROLE">ROLE</a></span></code></th>
<td class="colLast">
<div class="block">Avalon role - used to id the component within the manager</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addRole(T)">addRole</a></span>&#8203;(T&nbsp;role)</code></th>
<td class="colLast">
<div class="block">Creates a new role with specified attributes.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkExists(java.lang.String)">checkExists</a></span>&#8203;(<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>&nbsp;roleName)</code></th>
<td class="colLast">
<div class="block">Determines if a <code>Role</code> exists in the security system with the
specified role name.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkExists(org.apache.fulcrum.security.entity.Role)">checkExists</a></span>&#8203;(<a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&nbsp;role)</code></th>
<td class="colLast">
<div class="block">Determines if the <code>Role</code> exists in the security system.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="util/RoleSet.html" title="class in org.apache.fulcrum.security.util">RoleSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllRoles()">getAllRoles</a></span>()</code></th>
<td class="colLast">
<div class="block">Retrieves all roles defined in the system.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoleById(java.lang.Object)">getRoleById</a></span>&#8203;(<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>&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Retrieve a Role object with specified Id.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoleByName(java.lang.String)">getRoleByName</a></span>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Retrieve a Role object with specified name.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoleInstance()">getRoleInstance</a></span>()</code></th>
<td class="colLast">
<div class="block">Construct a blank Role object
This method calls getRoleClass, and then creates a new object using the
default constructor.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRoleInstance(java.lang.String)">getRoleInstance</a></span>&#8203;(<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>&nbsp;roleName)</code></th>
<td class="colLast">
<div class="block">Construct a blank Role object.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeRole(org.apache.fulcrum.security.entity.Role)">removeRole</a></span>&#8203;(<a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&nbsp;role)</code></th>
<td class="colLast">
<div class="block">Removes a Role from the system.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameRole(org.apache.fulcrum.security.entity.Role,java.lang.String)">renameRole</a></span>&#8203;(<a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&nbsp;role,
<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Renames an existing Role.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="ROLE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ROLE</h4>
<pre>static final&nbsp;<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/fulcrum/security/RoleManager.html#line.46">ROLE</a></pre>
<div class="block">Avalon role - used to id the component within the manager</div>
</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="getRoleInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoleInstance</h4>
<pre class="methodSignature">&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;&nbsp;T&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.58">getRoleInstance</a>()
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></pre>
<div class="block">Construct a blank Role object
This method calls getRoleClass, and then creates a new object using the
default constructor.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - role type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an object implementing Role interface.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if the object could not be instantiated</dd>
</dl>
</li>
</ul>
<a id="getRoleInstance(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoleInstance</h4>
<pre class="methodSignature">&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;&nbsp;T&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.74">getRoleInstance</a>&#8203;(<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>&nbsp;roleName)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></pre>
<div class="block">Construct a blank Role object.
This method calls getRoleClass, and then creates a new object using the
default constructor.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Role</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roleName</code> - The name of the Role</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an object implementing Role interface.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if the object could not be instantiated.</dd>
</dl>
</li>
</ul>
<a id="getRoleByName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoleByName</h4>
<pre class="methodSignature">&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;&nbsp;T&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.88">getRoleByName</a>&#8203;(<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>&nbsp;name)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a>,
<a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></pre>
<div class="block">Retrieve a Role object with specified name.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Role</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the Role.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an object representing the Role with specified name.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if there was an error accessing the data backend.</dd>
<dd><code><a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></code> - if the role does not exist.</dd>
</dl>
</li>
</ul>
<a id="getRoleById(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoleById</h4>
<pre class="methodSignature">&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;&nbsp;T&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.104">getRoleById</a>&#8203;(<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>&nbsp;id)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a>,
<a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></pre>
<div class="block">Retrieve a Role object with specified Id.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Role</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - the Id of the Role.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an object representing the Role with specified name.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></code> - if the permission does not exist in the database.</dd>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if there is a problem accessing the storage.</dd>
</dl>
</li>
</ul>
<a id="getAllRoles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllRoles</h4>
<pre class="methodSignature"><a href="util/RoleSet.html" title="class in org.apache.fulcrum.security.util">RoleSet</a>&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.113">getAllRoles</a>()
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></pre>
<div class="block">Retrieves all roles defined in the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the names of all roles defined in the system.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if there was an error accessing the data backend.</dd>
</dl>
</li>
</ul>
<a id="addRole(org.apache.fulcrum.security.entity.Role)">
<!-- -->
</a><a id="addRole(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRole</h4>
<pre class="methodSignature">&lt;T extends <a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&gt;&nbsp;T&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.128">addRole</a>&#8203;(T&nbsp;role)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a>,
<a href="util/EntityExistsException.html" title="class in org.apache.fulcrum.security.util">EntityExistsException</a></pre>
<div class="block">Creates a new role with specified attributes.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Role</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - The object describing the role to be created.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new Role object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if there was an error accessing the data backend.</dd>
<dd><code><a href="util/EntityExistsException.html" title="class in org.apache.fulcrum.security.util">EntityExistsException</a></code> - if the role already exists.</dd>
</dl>
</li>
</ul>
<a id="removeRole(org.apache.fulcrum.security.entity.Role)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeRole</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.140">removeRole</a>&#8203;(<a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&nbsp;role)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a>,
<a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></pre>
<div class="block">Removes a Role from the system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - The object describing the role to be removed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if there was an error accessing the data backend.</dd>
<dd><code><a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></code> - if the role does not exist.</dd>
</dl>
</li>
</ul>
<a id="renameRole(org.apache.fulcrum.security.entity.Role,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>renameRole</h4>
<pre class="methodSignature">void&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.154">renameRole</a>&#8203;(<a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&nbsp;role,
<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>&nbsp;name)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a>,
<a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></pre>
<div class="block">Renames an existing Role.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - The object describing the role to be renamed.</dd>
<dd><code>name</code> - the new name for the role.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - if there was an error accessing the data backend.</dd>
<dd><code><a href="util/UnknownEntityException.html" title="class in org.apache.fulcrum.security.util">UnknownEntityException</a></code> - if the role does not exist.</dd>
</dl>
</li>
</ul>
<a id="checkExists(org.apache.fulcrum.security.entity.Role)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkExists</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.165">checkExists</a>&#8203;(<a href="entity/Role.html" title="interface in org.apache.fulcrum.security.entity">Role</a>&nbsp;role)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></pre>
<div class="block">Determines if the <code>Role</code> exists in the security system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - a <code>Role</code> value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the role exists in the system, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - when more than one Role with the same name exists.</dd>
</dl>
</li>
</ul>
<a id="checkExists(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>checkExists</h4>
<pre class="methodSignature">boolean&nbsp;<a href="../../../../src-html/org/apache/fulcrum/security/RoleManager.html#line.177">checkExists</a>&#8203;(<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>&nbsp;roleName)
throws <a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></pre>
<div class="block">Determines if a <code>Role</code> exists in the security system with the
specified role name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roleName</code> - the name of a <code>Role</code> to check.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the role exists in the system, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="util/DataBackendException.html" title="class in org.apache.fulcrum.security.util">DataBackendException</a></code> - when more than one Role with the same name exists.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RoleManager.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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2011&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>