plantuml-server/apidocs/net/sourceforge/plantuml/servlet/package-summary.html

264 lines
10 KiB
HTML

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.15) on Wed Jun 22 07:51:59 UTC 2022 -->
<title>net.sourceforge.plantuml.servlet (PlantUML Servlet 1-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-06-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="net.sourceforge.plantuml.servlet (PlantUML Servlet 1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">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="../../../../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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;net.sourceforge.plantuml.servlet</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block"><p>This package is in charge of the JEE PlantUml Server.</p>
<p>There are 2 kind of servlets in this package:<br>
- Interactive servlets: Welcome, PlantUmlServlet that are in charge of the web pages dedicated to human users.<br>
- Service servlets: ImgServlet, SvgServlet, EpsServlet, EpsTextServlet, AsciiServlet, ProxyServlet that only produce a diagram as output.<br>
<br>
Structure of the service part of the PlantUmlServer: <br>
<img alt="Class diagram of the service part of the PlantUmlServer" src="https://www.plantuml.com/plantuml/svg/XP31Ri8m44Jl_eez1Wd-e0SgLRGNrAfHFy3OIx1ansQzHaKj_zv4mKfCYZXwvcbclEl8aZWvAmv68w0BV0Q7ReSKIuaFNXVItg3j5BcBJ58nl3676kbaaKTHMHaZV3dxOcH3qlM0KGW_0Y2adJKAJjveqFuLkPf4VE8nOMIWun8AEGRVHWIAOI40Sb4EgvbCsq23NFj42gki9385lp4MDvwSv1v-JnmI3-zg8IvYs7qTdKlxrRTQzV-wvRHWtpKFtupOwcl0kCpPmj_AK7eNCQc0fz_L2hOol-VU1_dlStRdbn-Ojdb0rAT7n7DKnjnd_EhsL69StRbpEm-_2wonrSdPFm00">
</p>
<p>
<img alt="Generation of a PNG image illustrated" src="https://www.plantuml.com/plantuml/svg/XP1DZi8m38NtdCA23RFe0OfGLr24n4y5uW2cU2fBQL8vBeBRup8ZHEc2LPJtNhuNMraTmOey2Ie73-4N48hT2hZ6Ye2TQwEQHvTHuQiZoTMHGfB1ssq65Uanj5BIzESZTghTycQ0KeFy1KrvPNjkqgD-gTktshIQ1wbH1wKBnagmFb1iWezaB-RpKiYcoBAlqKZ-ygyQk45HBhb1hp0kd1sdxGOSdmNbFWQCiE4pJD8qpzDqz4cpWixkVlpSCAsxhHgsKvDX_H3G6_q1">
</p></div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AsciiServlet.html" title="class in net.sourceforge.plantuml.servlet">AsciiServlet</a></th>
<td class="colLast">
<div class="block">ASCII servlet of the webapp.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Base64Servlet.html" title="class in net.sourceforge.plantuml.servlet">Base64Servlet</a></th>
<td class="colLast">
<div class="block">Base64 servlet of the webapp.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CheckSyntaxServlet.html" title="class in net.sourceforge.plantuml.servlet">CheckSyntaxServlet</a></th>
<td class="colLast">
<div class="block">Check servlet of the webapp.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DiagramResponse.html" title="class in net.sourceforge.plantuml.servlet">DiagramResponse</a></th>
<td class="colLast">
<div class="block">Delegates the diagram generation from the UML source and the filling of the HTTP response with the diagram in the
right format.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EpsServlet.html" title="class in net.sourceforge.plantuml.servlet">EpsServlet</a></th>
<td class="colLast">
<div class="block">EPS servlet of the webapp.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EpsTextServlet.html" title="class in net.sourceforge.plantuml.servlet">EpsTextServlet</a></th>
<td class="colLast">
<div class="block">EPS Text servlet of the webapp.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ImgServlet.html" title="class in net.sourceforge.plantuml.servlet">ImgServlet</a></th>
<td class="colLast">
<div class="block">Image servlet of the webapp.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LanguageServlet.html" title="class in net.sourceforge.plantuml.servlet">LanguageServlet</a></th>
<td class="colLast">
<div class="block">Servlet used to inspect the language keywords of the running PlantUML server.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MapServlet.html" title="class in net.sourceforge.plantuml.servlet">MapServlet</a></th>
<td class="colLast">
<div class="block">MAP servlet of the webapp.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="OldProxyServlet.html" title="class in net.sourceforge.plantuml.servlet">OldProxyServlet</a></th>
<td class="colLast">
<div class="block">Proxy servlet of the webapp.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PlantUmlServlet.html" title="class in net.sourceforge.plantuml.servlet">PlantUmlServlet</a></th>
<td class="colLast">
<div class="block">Original idea from Achim Abeling for Confluence macro.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ProxyServlet.html" title="class in net.sourceforge.plantuml.servlet">ProxyServlet</a></th>
<td class="colLast">
<div class="block">Proxy servlet of the webapp.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SvgServlet.html" title="class in net.sourceforge.plantuml.servlet">SvgServlet</a></th>
<td class="colLast">
<div class="block">SVG servlet of the webapp.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="UmlDiagramService.html" title="class in net.sourceforge.plantuml.servlet">UmlDiagramService</a></th>
<td class="colLast">
<div class="block">Common service servlet to produce diagram from compressed UML source contained in the end part of the requested URI.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">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="../../../../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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022. All rights reserved.</small></p>
</footer>
</body>
</html>