forked from bikol/DPRI_doc_20-21
352 lines
16 KiB
HTML
352 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (15) on Sun Jan 24 17:03:02 CET 2021 -->
|
|
<title>AuthorityRoles (restservice 1.0-SNAPSHOT API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2021-01-24">
|
|
<meta name="description" content="declaration: package: com.plannaplan.security, enum: AuthorityRoles">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":9,"i2":9,"i3":9};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "alt-color";
|
|
var rowColor = "row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar.top">
|
|
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/AuthorityRoles.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="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip.navbar.top">
|
|
<!-- -->
|
|
</span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.plannaplan.security</a></div>
|
|
<h1 title="Enum AuthorityRoles" class="title">Enum AuthorityRoles</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance">java.lang.Enum<<a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a>>
|
|
<div class="inheritance">com.plannaplan.security.AuthorityRoles</div>
|
|
</div>
|
|
</div>
|
|
<section class="description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable<<a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a>></code>, <code>java.lang.constant.Constable</code>, <code>org.springframework.security.core.GrantedAuthority</code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public enum <span class="type-name-label">AuthorityRoles</span>
|
|
extends java.lang.Enum<<a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a>>
|
|
implements org.springframework.security.core.GrantedAuthority</pre>
|
|
<div class="block">Users Roles for spring app</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested.class.summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="inherited-list">
|
|
<h2 id="nested.classes.inherited.from.class.java.lang.Enum">Nested classes/interfaces inherited from class java.lang.Enum</h2>
|
|
<code>java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
<li>
|
|
<section class="constants-summary" id="enum.constant.summary">
|
|
<h2>Enum Constant Summary</h2>
|
|
<div class="member-summary">
|
|
<table class="summary-table">
|
|
<caption><span>Enum Constants</span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="col-first" scope="col">Enum Constant</th>
|
|
<th class="col-last" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="alt-color">
|
|
<th class="col-first" scope="row"><code><span class="member-name-link"><a href="#ADMIN">ADMIN</a></span></code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="row-color">
|
|
<th class="col-first" scope="row"><code><span class="member-name-link"><a href="#DEANERY">DEANERY</a></span></code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="alt-color">
|
|
<th class="col-first" scope="row"><code><span class="member-name-link"><a href="#DEVELOPER">DEVELOPER</a></span></code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="row-color">
|
|
<th class="col-first" scope="row"><code><span class="member-name-link"><a href="#STUDENT">STUDENT</a></span></code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="alt-color">
|
|
<th class="col-first" scope="row"><code><span class="member-name-link"><a href="#TEST_USER">TEST_USER</a></span></code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method.summary">
|
|
<h2>Method Summary</h2>
|
|
<div class="member-summary" id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="table-tab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<table class="summary-table" aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="col-first" scope="col">Modifier and Type</th>
|
|
<th class="col-second" scope="col">Method</th>
|
|
<th class="col-last" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="alt-color" id="i0">
|
|
<td class="col-first"><code>java.lang.String</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getAuthority()">getAuthority</a></span>()</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="row-color" id="i1">
|
|
<td class="col-first"><code>static java.util.Optional<<a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a>></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getAuthorityRole(com.plannaplan.types.UserRoles)">getAuthorityRole</a></span>​(com.plannaplan.types.UserRoles role)</code></th>
|
|
<td class="col-last">
|
|
<div class="block">map buisness logic UserRoles enum to spring enum</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="alt-color" id="i2">
|
|
<td class="col-first"><code>static <a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(java.lang.String name)</code></th>
|
|
<td class="col-last">
|
|
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-color" id="i3">
|
|
<td class="col-first"><code>static <a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a>[]</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#values()">values</a></span>()</code></th>
|
|
<td class="col-last">
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.java.lang.Enum">Methods inherited from class java.lang.Enum</h3>
|
|
<code>clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.Object</h3>
|
|
<code>getClass, notify, notifyAll, wait, wait, wait</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
|
<li>
|
|
<section class="constant-details" id="enum.constant.detail">
|
|
<h2>Enum Constant Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="STUDENT">
|
|
<h3>STUDENT</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a></span> <span class="member-name">STUDENT</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DEANERY">
|
|
<h3>DEANERY</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a></span> <span class="member-name">DEANERY</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="ADMIN">
|
|
<h3>ADMIN</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a></span> <span class="member-name">ADMIN</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="TEST_USER">
|
|
<h3>TEST_USER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a></span> <span class="member-name">TEST_USER</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DEVELOPER">
|
|
<h3>DEVELOPER</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a></span> <span class="member-name">DEVELOPER</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method.detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="values()">
|
|
<h3>values</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a>[]</span> <span class="member-name">values</span>()</div>
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="valueOf(java.lang.String)">
|
|
<h3>valueOf</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a></span> <span class="member-name">valueOf</span>​(<span class="parameters">java.lang.String name)</span></div>
|
|
<div class="block">Returns the enum constant of this type with the specified name.
|
|
The string must match <i>exactly</i> an identifier used to declare an
|
|
enum constant in this type. (Extraneous whitespace characters are
|
|
not permitted.)</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the enum constant with the specified name</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
|
|
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getAuthority()">
|
|
<h3>getAuthority</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">java.lang.String</span> <span class="member-name">getAuthority</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>getAuthority</code> in interface <code>org.springframework.security.core.GrantedAuthority</code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getAuthorityRole(com.plannaplan.types.UserRoles)">
|
|
<h3>getAuthorityRole</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">java.util.Optional<<a href="AuthorityRoles.html" title="enum in com.plannaplan.security">AuthorityRoles</a>></span> <span class="member-name">getAuthorityRole</span>​(<span class="parameters">com.plannaplan.types.UserRoles role)</span></div>
|
|
<div class="block">map buisness logic UserRoles enum to spring enum</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>role</code> - buisness logic enum</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>restservice AuthorityRoles enum</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottom-nav" id="navbar.bottom">
|
|
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/AuthorityRoles.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="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<span class="skip-nav" id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</span></nav>
|
|
<p class="legal-copy"><small>Copyright © 2021. All rights reserved.</small></p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|