blob: a3b39063a49457b14ae096f1615780ea4ca2efe1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.jena.permissions (Apache Jena - Security Permissions 5.0.0)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.jena.permissions">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" 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">
<div class="header">
<h1 title="Package org.apache.jena.permissions" class="title">Package org.apache.jena.permissions</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.jena.permissions</span></div>
<section class="package-description" id="package-description">
<div class="block">JenaSecurity is a SecurityEvaluator interface and a set of dynamic proxies that
apply that interface to Jena Graphs, Models, and associated methods and classes.
<p>
The SecurityEvaluator class must be implemented. This class provides the interface
to the authentication results (e.g. <code>getPrincipal()</code>) and the
authorization system.
</p>
<ul>
<li>Create a SecuredGraph by calling
<code>Factory.getInstance( SecurityEvaluator, String, Graph );</code></li>
<li>Create a SecuredModel by calling
<code>Factory.getInstance( SecurityEvaluator, String, Model )</code></li>
<li>It is not recommended that you create a model by calling the Jena
<code>ModelFactory.createModelForGraph( SecuredGraph )</code> See Overview for
discussion.</li>
</ul>
<p>
<em>NOTES:</em>
<ul>
<li>See SecurityEvaluator documentation for description of cascading security
checks</li>
<li>Secured methods are annotated with: \@sec.graph for permissions required on
the graph to execute the method. \@sec.triple for permissions required on the
associated triples (if any) to execute the method.</li>
<li>It is possible to implement a SecurityEvaluator that does not enforce security
at the triple level. See SecurityEvaluator documentation for details</li>
</ul></div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="example/package-summary.html">org.apache.jena.permissions.example</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="graph/package-summary.html">org.apache.jena.permissions.graph</a></div>
<div class="col-last odd-row-color">
<div class="block">Secured implementation of the Graph interface and associated classes.</div>
</div>
<div class="col-first even-row-color"><a href="impl/package-summary.html">org.apache.jena.permissions.impl</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="model/package-summary.html">org.apache.jena.permissions.model</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="query/package-summary.html">org.apache.jena.permissions.query</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="utils/package-summary.html">org.apache.jena.permissions.utils</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="AssemblerConstants.html" title="interface in org.apache.jena.permissions">AssemblerConstants</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Factory.html" title="class in org.apache.jena.permissions">Factory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The factory that can be used to create an instance of a SecuredGraph or a
SecuredModel.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SecuredAssembler.html" title="class in org.apache.jena.permissions">SecuredAssembler</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Assembler for a secured model.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SecuredItem.html" title="interface in org.apache.jena.permissions">SecuredItem</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The secured item interface is mixed into instances of secured objects by the
proxy.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SecuredItem.Util.html" title="class in org.apache.jena.permissions">SecuredItem.Util</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utilities for SecuredItem implementations.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SecurityEvaluator.html" title="interface in org.apache.jena.permissions">SecurityEvaluator</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">SecurityEvaluator.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="SecurityEvaluator.Action.html" title="enum in org.apache.jena.permissions">SecurityEvaluator.Action</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Identifies a specific CRUD actions.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SecurityEvaluator.Util.html" title="class in org.apache.jena.permissions">SecurityEvaluator.Util</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A collection of utility functions for the SecurityEvaluator implementations.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SecurityEvaluatorAssembler.html" title="class in org.apache.jena.permissions">SecurityEvaluatorAssembler</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A simple assembler for a SecurityEvaluator</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Licensed under the Apache License, Version 2.0</small></p>
</footer>
</div>
</div>
</body>
</html>