<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_05) on Wed Jun 04 15:03:14 PDT 2014 -->
<title>FilesystemStore (p4oauth 0.1.0 API)</title>
<meta name="date" content="2014-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FilesystemStore (p4oauth 0.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":6,"i2":18,"i3":18,"i4":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/AuthorizationCodeStore.html" title="class in com.perforce.workshop.tjuricek.p4oauth.storage"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/IOptionsServerSupplier.html" title="class in com.perforce.workshop.tjuricek.p4oauth.storage"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/perforce/workshop/tjuricek/p4oauth/storage/FilesystemStore.html" target="_top">Frames</a></li>
<li><a href="FilesystemStore.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.perforce.workshop.tjuricek.p4oauth.storage</div>
<h2 title="Interface FilesystemStore" class="title">Interface FilesystemStore</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/AuthorizationCodeStore.html" title="class in com.perforce.workshop.tjuricek.p4oauth.storage">AuthorizationCodeStore</a>, <a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/WhitelistStore.html" title="class in com.perforce.workshop.tjuricek.p4oauth.storage">WhitelistStore</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FilesystemStore</span></pre>
<div class="block">Most of our "stores" really just sit on top of a file system structure.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/FilesystemStore.html#ensureParentExists-java.io.File-">ensureParentExists</a></span>(java.io.File file)</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/config/P4OAuthConfig.html" title="class in com.perforce.workshop.tjuricek.p4oauth.config">P4OAuthConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/FilesystemStore.html#getConfig--">getConfig</a></span>()</code>
<div class="block">The stores must have access to the application configuration.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default java.io.File</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/FilesystemStore.html#getFile-java.lang.String...-">getFile</a></span>(java.lang.String... paths)</code>
<div class="block">Returns the path to the file based on our configured rootDirectory.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default <T> T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/FilesystemStore.html#readYamlFile-java.lang.Class-java.io.File-">readYamlFile</a></span>(java.lang.Class<T> classType,
java.io.File file)</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>default void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/FilesystemStore.html#writeYamlFile-java.lang.Object-java.io.File-">writeYamlFile</a></span>(java.lang.Object object,
java.io.File file)</code> </td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/config/P4OAuthConfig.html" title="class in com.perforce.workshop.tjuricek.p4oauth.config">P4OAuthConfig</a> getConfig()</pre>
<div class="block">The stores must have access to the application configuration.</div>
</li>
</ul>
<a name="getFile-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFile</h4>
<pre>default java.io.File getFile(java.lang.String... paths)</pre>
<div class="block">Returns the path to the file based on our configured rootDirectory.
<p>
If there is no root directory configured in the system, we just generate
a file from the indicated paths, which should become a relative path
from the current working folder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paths</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="writeYamlFile-java.lang.Object-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeYamlFile</h4>
<pre>default void writeYamlFile(java.lang.Object object,
java.io.File file)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="readYamlFile-java.lang.Class-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readYamlFile</h4>
<pre>default <T> T readYamlFile(java.lang.Class<T> classType,
java.io.File file)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="ensureParentExists-java.io.File-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ensureParentExists</h4>
<pre>default void ensureParentExists(java.io.File file)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/AuthorizationCodeStore.html" title="class in com.perforce.workshop.tjuricek.p4oauth.storage"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../../com/perforce/workshop/tjuricek/p4oauth/storage/IOptionsServerSupplier.html" title="class in com.perforce.workshop.tjuricek.p4oauth.storage"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/perforce/workshop/tjuricek/p4oauth/storage/FilesystemStore.html" target="_top">Frames</a></li>
<li><a href="FilesystemStore.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
# |
Change |
User |
Description |
Committed |
|
#1
|
9161 |
tjuricek |
0.1.0 Minimal p4oauth server that provides a basic authorization code grant. |
|
|