y0rune/dokumentacja-plannaplan
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
69a4abede1
dokumentacja-plannaplan/dokumentacja-backendu/restservice/java/com/plannaplan/controllers/ConfigController.html
Filip Izydorczyk 69a4abede1 Added restservice java docs
2021-01-24 17:06:34 +01:00

364 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (15) on Sun Jan 24 17:03:02 CET 2021 -->
<title>ConfigController (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.controllers, class: ConfigController">
<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":10,"i2":10,"i3":10,"i4":42,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/ConfigController.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">com.plannaplan.controllers</a></div>
<h1 title="Class ConfigController" class="title">Class ConfigController</h1>
</div>
<div class="inheritance" title="Inheritance Tree">java.lang.Object
<div class="inheritance">com.plannaplan.controllers.ConfigController</div>
</div>
<section class="description">
<hr>
<pre>@RestController
@CrossOrigin
@RequestMapping("/api/v1/configurator")
@EnableGlobalMethodSecurity(prePostEnabled=true)
public class <span class="type-name-label">ConfigController</span>
extends java.lang.Object</pre>
<div class="block">Rest controller to Config related endpoints. More detailed api docs is
available via swagger</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="member-summary">
<table class="summary-table">
<caption><span>Constructors</span></caption>
<thead>
<tr>
<th class="col-first" scope="col">Constructor</th>
<th class="col-last" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="alt-color">
<th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E()">ConfigController</a></span>()</code></th>
<td class="col-last">&nbsp;</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="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><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="table-tab" onclick="show(32);">Deprecated 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>org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#configApp(org.springframework.web.multipart.MultipartFile,java.util.Date,java.util.Date,java.util.Date,java.util.Date)">configApp</a></span>&#8203;(org.springframework.web.multipart.MultipartFile&nbsp;file,
java.util.Date&nbsp;firstTourBegin,
java.util.Date&nbsp;firstTourEnd,
java.util.Date&nbsp;secondTourBegin,
java.util.Date&nbsp;secondTourEnd)</code></th>
<td class="col-last">&nbsp;</td>
</tr>
<tr class="row-color" id="i1">
<td class="col-first"><code>org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#configAppChangeCources(org.springframework.web.multipart.MultipartFile)">configAppChangeCources</a></span>&#8203;(org.springframework.web.multipart.MultipartFile&nbsp;file)</code></th>
<td class="col-last">&nbsp;</td>
</tr>
<tr class="alt-color" id="i2">
<td class="col-first"><code>org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#configToursApp(java.util.Date,java.util.Date,java.util.Date,java.util.Date)">configToursApp</a></span>&#8203;(java.util.Date&nbsp;firstTourBegin,
java.util.Date&nbsp;firstTourEnd,
java.util.Date&nbsp;secondTourBegin,
java.util.Date&nbsp;secondTourEnd)</code></th>
<td class="col-last">&nbsp;</td>
</tr>
<tr class="row-color" id="i3">
<td class="col-first"><code>org.springframework.http.ResponseEntity&lt;<a href="../responses/models/ConfigTourResponse.html" title="class in com.plannaplan.responses.models">ConfigTourResponse</a>&gt;</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getCurrentTourDate()">getCurrentTourDate</a></span>()</code></th>
<td class="col-last">&nbsp;</td>
</tr>
<tr class="alt-color" id="i4">
<td class="col-first"><code>org.springframework.http.ResponseEntity&lt;<a href="../responses/models/ConfigTourResponse.html" title="class in com.plannaplan.responses.models">ConfigTourResponse</a>&gt;</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getTourDate()">getTourDate</a></span>()</code></th>
<td class="col-last">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</td>
</tr>
<tr class="row-color" id="i5">
<td class="col-first"><code>org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</code></td>
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#initAdmin(java.lang.String)">initAdmin</a></span>&#8203;(java.lang.String&nbsp;ticket)</code></th>
<td class="col-last">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>ConfigController</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="member-name">ConfigController</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="configApp(org.springframework.web.multipart.MultipartFile,java.util.Date,java.util.Date,java.util.Date,java.util.Date)">
<h3>configApp</h3>
<div class="member-signature"><span class="annotations">@PostMapping(path="/config",
consumes="multipart/form-data")
@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</span>&nbsp;<span class="member-name">configApp</span>&#8203;(<span class="parameters">@RequestParam("file")
org.springframework.web.multipart.MultipartFile&nbsp;file,
@RequestParam("firstTourBegin") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;firstTourBegin,
@RequestParam("firstTourEnd") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;firstTourEnd,
@RequestParam("secondTourBegin") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;secondTourBegin,
@RequestParam("secondTourEnd") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;secondTourEnd)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>file</code> - file .xlsx that contains courses and groups with
apoinnted rules</dd>
<dd><code>firstTourBegin</code> - formated string dd.MM.yyyy</dd>
<dd><code>firstTourEnd</code> - formated string dd.MM.yyyy</dd>
<dd><code>secondTourBegin</code> - formated string dd.MM.yyyy</dd>
<dd><code>secondTourEnd</code> - formated string dd.MM.yyyy</dd>
<dt>Returns:</dt>
<dd>was config success</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="configToursApp(java.util.Date,java.util.Date,java.util.Date,java.util.Date)">
<h3>configToursApp</h3>
<div class="member-signature"><span class="annotations">@PostMapping(path="/config/tours")
@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</span>&nbsp;<span class="member-name">configToursApp</span>&#8203;(<span class="parameters">@RequestParam("firstTourBegin") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;firstTourBegin,
@RequestParam("firstTourEnd") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;firstTourEnd,
@RequestParam("secondTourBegin") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;secondTourBegin,
@RequestParam("secondTourEnd") @DateTimeFormat(pattern="dd.MM.yyyy")
java.util.Date&nbsp;secondTourEnd)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>firstTourBegin</code> - formated string dd.MM.yyyy</dd>
<dd><code>firstTourEnd</code> - formated string dd.MM.yyyy</dd>
<dd><code>secondTourBegin</code> - formated string dd.MM.yyyy</dd>
<dd><code>secondTourEnd</code> - formated string dd.MM.yyyy</dd>
<dt>Returns:</dt>
<dd>was operation successful</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="configAppChangeCources(org.springframework.web.multipart.MultipartFile)">
<h3>configAppChangeCources</h3>
<div class="member-signature"><span class="annotations">@PostMapping(path="/config/courses",
consumes="multipart/form-data")
@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</span>&nbsp;<span class="member-name">configAppChangeCources</span>&#8203;(<span class="parameters">@RequestParam("file")
org.springframework.web.multipart.MultipartFile&nbsp;file)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>file</code> - file .xlsx that contains courses and groups with</dd>
<dt>Returns:</dt>
<dd>was operation successfull</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="initAdmin(java.lang.String)">
<h3>initAdmin</h3>
<div class="member-signature"><span class="annotations">@PostMapping(path="/admin/init")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">org.springframework.http.ResponseEntity&lt;java.lang.String&gt;</span>&nbsp;<span class="member-name">initAdmin</span>&#8203;(<span class="parameters">@RequestParam("ticket")
java.lang.String&nbsp;ticket)</span></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>ticket</code> - CAS ticket to get user wuthority</dd>
<dt>Returns:</dt>
<dd>was admin created</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCurrentTourDate()">
<h3>getCurrentTourDate</h3>
<div class="member-signature"><span class="annotations">@GetMapping(path="/config/tour")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">org.springframework.http.ResponseEntity&lt;<a href="../responses/models/ConfigTourResponse.html" title="class in com.plannaplan.responses.models">ConfigTourResponse</a>&gt;</span>&nbsp;<span class="member-name">getCurrentTourDate</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>api response entity</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTourDate()">
<h3>getTourDate</h3>
<div class="member-signature"><span class="annotations">@Deprecated
@GetMapping(path="/admin/tour")
@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">org.springframework.http.ResponseEntity&lt;<a href="../responses/models/ConfigTourResponse.html" title="class in com.plannaplan.responses.models">ConfigTourResponse</a>&gt;</span>&nbsp;<span class="member-name">getTourDate</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>api response entity</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/ConfigController.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2021. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink