blob: 638bcba2be23bc1995ae4047a9e65d53d8d8e158 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ActionBase (Apache Jena - Fuseki Core Engine 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: module: org.apache.jena.fuseki.core, package: org.apache.jena.fuseki.servlets, class: ActionBase">
<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.6.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 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="../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/ActionBase.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#class">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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</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">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">org.apache.jena.fuseki.core</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jena.fuseki.servlets</a></div>
<h1 title="Class ActionBase" class="title">Class ActionBase</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.jena.fuseki.servlets.ActionBase</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ActionLifecycle.html" title="interface in org.apache.jena.fuseki.servlets">ActionLifecycle</a></code>, <code><a href="ActionProcessor.html" title="interface in org.apache.jena.fuseki.servlets">ActionProcessor</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ActionService.html" title="class in org.apache.jena.fuseki.servlets">ActionService</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ActionBase</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="ActionProcessor.html" title="interface in org.apache.jena.fuseki.servlets">ActionProcessor</a>, <a href="ActionLifecycle.html" title="interface in org.apache.jena.fuseki.servlets">ActionLifecycle</a></span></div>
<div class="block">Base of all implementations of service <a href="HttpAction.html" title="class in org.apache.jena.fuseki.servlets"><code>HttpAction</code></a>. This class provides the
two steps execution of "validate" and "perform".
Subclasses choose which HTTP
methods they handle by implementing "execGet(HttpAction)" etc. These often call
<a href="#executeLifecycle(org.apache.jena.fuseki.servlets.HttpAction)"><code>executeLifecycle(org.apache.jena.fuseki.servlets.HttpAction)</code></a> for their normal <code>HttpAction</code> lifecycle, for example,
when GET and POST do the same steps so common "validate" and "execute".
See <a href="ActionExecLib.html#execAction(org.apache.jena.fuseki.servlets.HttpAction,org.apache.jena.fuseki.servlets.ActionProcessor)"><code>ActionExecLib.execAction(org.apache.jena.fuseki.servlets.HttpAction, org.apache.jena.fuseki.servlets.ActionProcessor)</code></a> for the common ActionProcessor execution with logging and error handling.
This is used by <code>Dispatcher.dispatchAction(HttpAction)</code>.
See <a href="ActionService.html" title="class in org.apache.jena.fuseki.servlets"><code>ActionService</code></a> which overrides <a href="#executeLifecycle(org.apache.jena.fuseki.servlets.HttpAction)"><code>executeLifecycle(org.apache.jena.fuseki.servlets.HttpAction)</code></a> to add statistics counters.
Some operations like OPTIONS will implement differently.
<pre>
public void execGet(HttpAction action) { super.executeLifecycle(action); }
</pre></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#process(org.apache.jena.fuseki.servlets.HttpAction)" class="member-name-link">process</a><wbr>(<a href="HttpAction.html" title="class in org.apache.jena.fuseki.servlets">HttpAction</a>&nbsp;action)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Subclasses must override <code>execGet</code>, <code>execPost</code> etc to say which
methods they support.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.fuseki.servlets.ActionLifecycle">Methods inherited from interface&nbsp;org.apache.jena.fuseki.servlets.<a href="ActionLifecycle.html" title="interface in org.apache.jena.fuseki.servlets">ActionLifecycle</a></h3>
<code><a href="ActionLifecycle.html#execute(org.apache.jena.fuseki.servlets.HttpAction)">execute</a>, <a href="ActionLifecycle.html#validate(org.apache.jena.fuseki.servlets.HttpAction)">validate</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.jena.fuseki.servlets.ActionProcessor">Methods inherited from interface&nbsp;org.apache.jena.fuseki.servlets.<a href="ActionProcessor.html" title="interface in org.apache.jena.fuseki.servlets">ActionProcessor</a></h3>
<code><a href="ActionProcessor.html#execAny(java.lang.String,org.apache.jena.fuseki.servlets.HttpAction)">execAny</a>, <a href="ActionProcessor.html#execDelete(org.apache.jena.fuseki.servlets.HttpAction)">execDelete</a>, <a href="ActionProcessor.html#execGet(org.apache.jena.fuseki.servlets.HttpAction)">execGet</a>, <a href="ActionProcessor.html#execHead(org.apache.jena.fuseki.servlets.HttpAction)">execHead</a>, <a href="ActionProcessor.html#execOptions(org.apache.jena.fuseki.servlets.HttpAction)">execOptions</a>, <a href="ActionProcessor.html#execPatch(org.apache.jena.fuseki.servlets.HttpAction)">execPatch</a>, <a href="ActionProcessor.html#execPost(org.apache.jena.fuseki.servlets.HttpAction)">execPost</a>, <a href="ActionProcessor.html#execPut(org.apache.jena.fuseki.servlets.HttpAction)">execPut</a>, <a href="ActionProcessor.html#execTrace(org.apache.jena.fuseki.servlets.HttpAction)">execTrace</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="process(org.apache.jena.fuseki.servlets.HttpAction)">
<h3>process</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">process</span><wbr><span class="parameters">(<a href="HttpAction.html" title="class in org.apache.jena.fuseki.servlets">HttpAction</a>&nbsp;action)</span></div>
<div class="block">Subclasses must override <code>execGet</code>, <code>execPost</code> etc to say which
methods they support.
Typically, the implementation is a call to <code>executeLifecycle(action)</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ActionProcessor.html#process(org.apache.jena.fuseki.servlets.HttpAction)">process</a></code>&nbsp;in interface&nbsp;<code><a href="ActionProcessor.html" title="interface in org.apache.jena.fuseki.servlets">ActionProcessor</a></code></dd>
<dt>Parameters:</dt>
<dd><code>action</code> - HTTP Action</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</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>