http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-summary.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-summary.html new file mode 100644 index 0000000..e1c9954 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-summary.html @@ -0,0 +1,183 @@ +<!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_65) on Wed Apr 20 18:03:37 PDT 2016 --> +<title>org.apache.hawq.pxf.service.io</title> +<meta name="date" content="2016-04-20"> +<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="org.apache.hawq.pxf.service.io"; + } + } + catch(err) { + } +//--> +</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 class="navBarCell1Rev">Package</li> +<li>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="../../../../../../org/apache/hawq/pxf/service/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.hawq.pxf.service.io</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></td> +<td class="colLast"> +<div class="block">A serializable object which implements a simple, efficient, serialization + protocol, based on <code>DataInput</code> and <code>DataOutput</code>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/service/io/BufferWritable.html" title="class in org.apache.hawq.pxf.service.io">BufferWritable</a></td> +<td class="colLast"> +<div class="block">A serializable object for transporting a byte array through the Bridge + framework</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable</a></td> +<td class="colLast"> +<div class="block">This class represents a GPDB record in the form of + a Java object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io">Text</a></td> +<td class="colLast"> +<div class="block">This class stores text using standard UTF8 encoding.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> +<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Exception</th> +<th class="colLast" scope="col">Description</th> +</tr> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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="../../../../../../org/apache/hawq/pxf/service/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-tree.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-tree.html new file mode 100644 index 0000000..ac83b9c --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/io/package-tree.html @@ -0,0 +1,154 @@ +<!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_65) on Wed Apr 20 18:03:37 PDT 2016 --> +<title>org.apache.hawq.pxf.service.io Class Hierarchy</title> +<meta name="date" content="2016-04-20"> +<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="org.apache.hawq.pxf.service.io Class Hierarchy"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Tree</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="../../../../../../org/apache/hawq/pxf/service/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.hawq.pxf.service.io</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/BufferWritable.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">BufferWritable</span></a> (implements org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a>)</li> +<li type="circle">org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">GPDBWritable</span></a> (implements org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a>)</li> +<li type="circle">org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/Text.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Text</span></a> (implements org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a>)</li> +<li type="circle">java.lang.Throwable (implements java.io.Serializable) +<ul> +<li type="circle">java.lang.Exception +<ul> +<li type="circle">java.io.IOException +<ul> +<li type="circle">org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io"><span class="typeNameLink">GPDBWritable.TypeMismatchException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.hawq.pxf.service.io.<a href="../../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io"><span class="typeNameLink">Writable</span></a></li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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="../../../../../../org/apache/hawq/pxf/service/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/io/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-frame.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-frame.html new file mode 100644 index 0000000..fa34530 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-frame.html @@ -0,0 +1,35 @@ +<!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_65) on Wed Apr 20 18:03:37 PDT 2016 --> +<title>org.apache.hawq.pxf.service</title> +<meta name="date" content="2016-04-20"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../org/apache/hawq/pxf/service/package-summary.html" target="classFrame">org.apache.hawq.pxf.service</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Bridge.html" title="interface in org.apache.hawq.pxf.service" target="classFrame"><span class="interfaceName">Bridge</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="BridgeInputBuilder.html" title="class in org.apache.hawq.pxf.service" target="classFrame">BridgeInputBuilder</a></li> +<li><a href="BridgeOutputBuilder.html" title="class in org.apache.hawq.pxf.service" target="classFrame">BridgeOutputBuilder</a></li> +<li><a href="FragmenterFactory.html" title="class in org.apache.hawq.pxf.service" target="classFrame">FragmenterFactory</a></li> +<li><a href="FragmentsResponse.html" title="class in org.apache.hawq.pxf.service" target="classFrame">FragmentsResponse</a></li> +<li><a href="FragmentsResponseFormatter.html" title="class in org.apache.hawq.pxf.service" target="classFrame">FragmentsResponseFormatter</a></li> +<li><a href="GPDBWritableMapper.html" title="class in org.apache.hawq.pxf.service" target="classFrame">GPDBWritableMapper</a></li> +<li><a href="MetadataFetcherFactory.html" title="class in org.apache.hawq.pxf.service" target="classFrame">MetadataFetcherFactory</a></li> +<li><a href="MetadataResponse.html" title="class in org.apache.hawq.pxf.service" target="classFrame">MetadataResponse</a></li> +<li><a href="MetadataResponseFormatter.html" title="class in org.apache.hawq.pxf.service" target="classFrame">MetadataResponseFormatter</a></li> +<li><a href="ReadBridge.html" title="class in org.apache.hawq.pxf.service" target="classFrame">ReadBridge</a></li> +<li><a href="ReadSamplingBridge.html" title="class in org.apache.hawq.pxf.service" target="classFrame">ReadSamplingBridge</a></li> +<li><a href="WriteBridge.html" title="class in org.apache.hawq.pxf.service" target="classFrame">WriteBridge</a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-summary.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-summary.html new file mode 100644 index 0000000..9daed44 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-summary.html @@ -0,0 +1,231 @@ +<!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_65) on Wed Apr 20 18:03:37 PDT 2016 --> +<title>org.apache.hawq.pxf.service</title> +<meta name="date" content="2016-04-20"> +<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="org.apache.hawq.pxf.service"; + } + } + catch(err) { + } +//--> +</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 class="navBarCell1Rev">Package</li> +<li>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="../../../../../org/apache/hawq/pxf/plugins/hive/utilities/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/io/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.hawq.pxf.service</h1> +<div class="docSummary"> +<div class="block">Provides PXF Rest API resources.</div> +</div> +<p>See: <a href="#package.description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/Bridge.html" title="interface in org.apache.hawq.pxf.service">Bridge</a></td> +<td class="colLast"> +<div class="block">Bridge interface - defines the interface of the Bridge classes.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/BridgeInputBuilder.html" title="class in org.apache.hawq.pxf.service">BridgeInputBuilder</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/BridgeOutputBuilder.html" title="class in org.apache.hawq.pxf.service">BridgeOutputBuilder</a></td> +<td class="colLast"> +<div class="block">Class creates the output record that is piped by the java process to the HAWQ + backend.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/FragmenterFactory.html" title="class in org.apache.hawq.pxf.service">FragmenterFactory</a></td> +<td class="colLast"> +<div class="block">Factory class for creation of <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><code>Fragmenter</code></a> objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service">FragmentsResponse</a></td> +<td class="colLast"> +<div class="block">Class for serializing fragments metadata in JSON format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" title="class in org.apache.hawq.pxf.service">FragmentsResponseFormatter</a></td> +<td class="colLast"> +<div class="block">Utility class for converting Fragments into a <a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service"><code>FragmentsResponse</code></a> that + will serialize them into JSON format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/GPDBWritableMapper.html" title="class in org.apache.hawq.pxf.service">GPDBWritableMapper</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/MetadataFetcherFactory.html" title="class in org.apache.hawq.pxf.service">MetadataFetcherFactory</a></td> +<td class="colLast"> +<div class="block">Factory class for creation of <a href="../../../../../org/apache/hawq/pxf/api/MetadataFetcher.html" title="class in org.apache.hawq.pxf.api"><code>MetadataFetcher</code></a> objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service">MetadataResponse</a></td> +<td class="colLast"> +<div class="block">Class for serializing metadata in JSON format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/MetadataResponseFormatter.html" title="class in org.apache.hawq.pxf.service">MetadataResponseFormatter</a></td> +<td class="colLast"> +<div class="block">Utility class for converting <a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api"><code>Metadata</code></a> into a JSON format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/ReadBridge.html" title="class in org.apache.hawq.pxf.service">ReadBridge</a></td> +<td class="colLast"> +<div class="block">ReadBridge class creates appropriate accessor and resolver.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/ReadSamplingBridge.html" title="class in org.apache.hawq.pxf.service">ReadSamplingBridge</a></td> +<td class="colLast"> +<div class="block">ReadSamplingBridge wraps a ReadBridge, and returns only some of the output + records, based on a ratio sample.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/service/WriteBridge.html" title="class in org.apache.hawq.pxf.service">WriteBridge</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package.description"> +<!-- --> +</a> +<h2 title="Package org.apache.hawq.pxf.service Description">Package org.apache.hawq.pxf.service Description</h2> +<div class="block">Provides PXF Rest API resources.</div> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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="../../../../../org/apache/hawq/pxf/plugins/hive/utilities/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/io/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-tree.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-tree.html new file mode 100644 index 0000000..5ec11cd --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/package-tree.html @@ -0,0 +1,150 @@ +<!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_65) on Wed Apr 20 18:03:37 PDT 2016 --> +<title>org.apache.hawq.pxf.service Class Hierarchy</title> +<meta name="date" content="2016-04-20"> +<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="org.apache.hawq.pxf.service Class Hierarchy"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Tree</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="../../../../../org/apache/hawq/pxf/plugins/hive/utilities/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/io/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.hawq.pxf.service</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/BridgeInputBuilder.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">BridgeInputBuilder</span></a></li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/BridgeOutputBuilder.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">BridgeOutputBuilder</span></a></li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/FragmenterFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">FragmenterFactory</span></a></li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">FragmentsResponse</span></a> (implements javax.ws.rs.core.StreamingOutput)</li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">FragmentsResponseFormatter</span></a></li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/GPDBWritableMapper.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">GPDBWritableMapper</span></a></li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/MetadataFetcherFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">MetadataFetcherFactory</span></a></li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">MetadataResponse</span></a> (implements javax.ws.rs.core.StreamingOutput)</li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/MetadataResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">MetadataResponseFormatter</span></a></li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/ReadBridge.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">ReadBridge</span></a> (implements org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/Bridge.html" title="interface in org.apache.hawq.pxf.service">Bridge</a>)</li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/ReadSamplingBridge.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">ReadSamplingBridge</span></a> (implements org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/Bridge.html" title="interface in org.apache.hawq.pxf.service">Bridge</a>)</li> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/WriteBridge.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">WriteBridge</span></a> (implements org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/Bridge.html" title="interface in org.apache.hawq.pxf.service">Bridge</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.hawq.pxf.service.<a href="../../../../../org/apache/hawq/pxf/service/Bridge.html" title="interface in org.apache.hawq.pxf.service"><span class="typeNameLink">Bridge</span></a></li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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="../../../../../org/apache/hawq/pxf/plugins/hive/utilities/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/io/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/BridgeResource.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/BridgeResource.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/BridgeResource.html new file mode 100644 index 0000000..81afa98 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/BridgeResource.html @@ -0,0 +1,304 @@ +<!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_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>BridgeResource</title> +<meta name="date" content="2016-04-20"> +<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="BridgeResource"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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>Prev Class</li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/ClusterNodesResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/BridgeResource.html" target="_top">Frames</a></li> +<li><a href="BridgeResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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">org.apache.hawq.pxf.service.rest</div> +<h2 title="Class BridgeResource" class="title">Class BridgeResource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html" title="class in org.apache.hawq.pxf.service.rest">org.apache.hawq.pxf.service.rest.RestResource</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.rest.BridgeResource</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BridgeResource</span> +extends <a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html" title="class in org.apache.hawq.pxf.service.rest">RestResource</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/BridgeResource.html#BridgeResource--">BridgeResource</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/BridgeResource.html#read-javax.servlet.ServletContext-javax.ws.rs.core.HttpHeaders-">read</a></span>(javax.servlet.ServletContext servletContext, + javax.ws.rs.core.HttpHeaders headers)</code> +<div class="block">Used to be HDFSReader.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.service.rest.RestResource"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hawq.pxf.service.rest.<a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html" title="class in org.apache.hawq.pxf.service.rest">RestResource</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html#convertToCaseInsensitiveMap-javax.ws.rs.core.MultivaluedMap-">convertToCaseInsensitiveMap</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BridgeResource--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BridgeResource</h4> +<pre>public BridgeResource()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="read-javax.servlet.ServletContext-javax.ws.rs.core.HttpHeaders-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>read</h4> +<pre>public javax.ws.rs.core.Response read(@Context + javax.servlet.ServletContext servletContext, + @Context + javax.ws.rs.core.HttpHeaders headers) + throws java.lang.Exception</pre> +<div class="block">Used to be HDFSReader. Creates a bridge instance and iterates over its + records, printing it out to outgoing stream. Outputs GPDBWritable or + Text. + + Parameters come through HTTP header.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>servletContext</code> - Servlet context contains attributes required by + SecuredHDFS</dd> +<dd><code>headers</code> - Holds HTTP headers from request</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>response object containing stream that will output records</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - in case of wrong request parameters, or failure to + initialize bridge</dd> +</dl> +</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>Prev Class</li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/ClusterNodesResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/BridgeResource.html" target="_top">Frames</a></li> +<li><a href="BridgeResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/ClusterNodesResource.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/ClusterNodesResource.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/ClusterNodesResource.html new file mode 100644 index 0000000..c08c624 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/ClusterNodesResource.html @@ -0,0 +1,294 @@ +<!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_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>ClusterNodesResource</title> +<meta name="date" content="2016-04-20"> +<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="ClusterNodesResource"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../../org/apache/hawq/pxf/service/rest/BridgeResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/FragmenterResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/ClusterNodesResource.html" target="_top">Frames</a></li> +<li><a href="ClusterNodesResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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">org.apache.hawq.pxf.service.rest</div> +<h2 title="Class ClusterNodesResource" class="title">Class ClusterNodesResource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.rest.ClusterNodesResource</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ClusterNodesResource</span> +extends java.lang.Object</pre> +<div class="block">Class enhances the API of the HBASE rest server. + Example for querying API getClusterNodesInfo from a web client + <code>curl "http://localhost:51200/pxf/{version}/HadoopCluster/getNodesInfo";</code> + /pxf/ is made part of the path when there is a webapp by that name in tcServer.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/ClusterNodesResource.html#ClusterNodesResource--">ClusterNodesResource</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/ClusterNodesResource.html#read--">read</a></span>()</code> +<div class="block">Function queries the Hadoop namenode with the getDataNodeStats API It + gets the host's IP and REST port of every HDFS data node in the cluster.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ClusterNodesResource--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClusterNodesResource</h4> +<pre>public ClusterNodesResource()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="read--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>read</h4> +<pre>public javax.ws.rs.core.Response read() + throws java.lang.Exception</pre> +<div class="block">Function queries the Hadoop namenode with the getDataNodeStats API It + gets the host's IP and REST port of every HDFS data node in the cluster. + Then, it packs the results in JSON format and writes to the HTTP response + stream. Response Examples:<br> + <ol> + <li>When there are no datanodes - getDataNodeStats returns an empty array + <code>{"regions":[]}</code></li> + <li>When there are datanodes + <code>{"regions":[{"host":"1.2.3.1","port":50075},{"host":"1.2.3.2","port" + :50075}]}</code></li> + </ol></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>JSON response with nodes info</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if failed to retrieve info</dd> +</dl> +</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="../../../../../../org/apache/hawq/pxf/service/rest/BridgeResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/FragmenterResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/ClusterNodesResource.html" target="_top">Frames</a></li> +<li><a href="ClusterNodesResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/FragmenterResource.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/FragmenterResource.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/FragmenterResource.html new file mode 100644 index 0000000..4613d28 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/FragmenterResource.html @@ -0,0 +1,348 @@ +<!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_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>FragmenterResource</title> +<meta name="date" content="2016-04-20"> +<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="FragmenterResource"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../../org/apache/hawq/pxf/service/rest/ClusterNodesResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/InvalidPathResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/FragmenterResource.html" target="_top">Frames</a></li> +<li><a href="FragmenterResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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">org.apache.hawq.pxf.service.rest</div> +<h2 title="Class FragmenterResource" class="title">Class FragmenterResource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html" title="class in org.apache.hawq.pxf.service.rest">org.apache.hawq.pxf.service.rest.RestResource</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.rest.FragmenterResource</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FragmenterResource</span> +extends <a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html" title="class in org.apache.hawq.pxf.service.rest">RestResource</a></pre> +<div class="block">Class enhances the API of the WEBHDFS REST server. Returns the data fragments + that a data resource is made of, enabling parallel processing of the data + resource. Example for querying API FRAGMENTER from a web client + <code>curl -i "http://localhost:51200/pxf/{version}/Fragmenter/getFragments?path=/dir1/dir2/*txt";</code> + <code>/pxf/</code> is made part of the path when there is a webapp by that + name in tomcat.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/FragmenterResource.html#FragmenterResource--">FragmenterResource</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/FragmenterResource.html#getFragments-javax.servlet.ServletContext-javax.ws.rs.core.HttpHeaders-java.lang.String-">getFragments</a></span>(javax.servlet.ServletContext servletContext, + javax.ws.rs.core.HttpHeaders headers, + java.lang.String path)</code> +<div class="block">The function is called when + <code>http://nn:port/pxf/{version}/Fragmenter/getFragments?path=...</code> is used.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/FragmenterResource.html#getFragmentsStats-javax.servlet.ServletContext-javax.ws.rs.core.HttpHeaders-java.lang.String-">getFragmentsStats</a></span>(javax.servlet.ServletContext servletContext, + javax.ws.rs.core.HttpHeaders headers, + java.lang.String path)</code> +<div class="block">The function is called when + <code>http://nn:port/pxf/{version}/Fragmenter/getFragmentsStats?path=...</code> is + used.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.service.rest.RestResource"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hawq.pxf.service.rest.<a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html" title="class in org.apache.hawq.pxf.service.rest">RestResource</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/service/rest/RestResource.html#convertToCaseInsensitiveMap-javax.ws.rs.core.MultivaluedMap-">convertToCaseInsensitiveMap</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FragmenterResource--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FragmenterResource</h4> +<pre>public FragmenterResource()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getFragments-javax.servlet.ServletContext-javax.ws.rs.core.HttpHeaders-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFragments</h4> +<pre>public javax.ws.rs.core.Response getFragments(@Context + javax.servlet.ServletContext servletContext, + @Context + javax.ws.rs.core.HttpHeaders headers, + java.lang.String path) + throws java.lang.Exception</pre> +<div class="block">The function is called when + <code>http://nn:port/pxf/{version}/Fragmenter/getFragments?path=...</code> is used.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>servletContext</code> - Servlet context contains attributes required by + SecuredHDFS</dd> +<dd><code>headers</code> - Holds HTTP headers from request</dd> +<dd><code>path</code> - Holds URI path option used in this request</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>response object with JSON serialized fragments metadata</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if getting fragments info failed</dd> +</dl> +</li> +</ul> +<a name="getFragmentsStats-javax.servlet.ServletContext-javax.ws.rs.core.HttpHeaders-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFragmentsStats</h4> +<pre>public javax.ws.rs.core.Response getFragmentsStats(@Context + javax.servlet.ServletContext servletContext, + @Context + javax.ws.rs.core.HttpHeaders headers, + java.lang.String path) + throws java.lang.Exception</pre> +<div class="block">The function is called when + <code>http://nn:port/pxf/{version}/Fragmenter/getFragmentsStats?path=...</code> is + used.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>servletContext</code> - Servlet context contains attributes required by + SecuredHDFS</dd> +<dd><code>headers</code> - Holds HTTP headers from request</dd> +<dd><code>path</code> - Holds URI path option used in this request</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>response object with JSON serialized fragments statistics</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if getting fragments info failed</dd> +</dl> +</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="../../../../../../org/apache/hawq/pxf/service/rest/ClusterNodesResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/InvalidPathResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/FragmenterResource.html" target="_top">Frames</a></li> +<li><a href="FragmenterResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/InvalidPathResource.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/InvalidPathResource.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/InvalidPathResource.html new file mode 100644 index 0000000..ed24da1 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/rest/InvalidPathResource.html @@ -0,0 +1,350 @@ +<!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_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>InvalidPathResource</title> +<meta name="date" content="2016-04-20"> +<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="InvalidPathResource"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../../org/apache/hawq/pxf/service/rest/FragmenterResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/MetadataResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/InvalidPathResource.html" target="_top">Frames</a></li> +<li><a href="InvalidPathResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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">org.apache.hawq.pxf.service.rest</div> +<h2 title="Class InvalidPathResource" class="title">Class InvalidPathResource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.rest.InvalidPathResource</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">InvalidPathResource</span> +extends java.lang.Object</pre> +<div class="block">Class for catching paths that are not defined by other resources. + NOTE: This resource must be accessible without any security checks + as it is used to verify proper load of the PXF webapp. + + For each path, the version is compared to the current version PXF_VERSION. + The expected format of a path is "<code>http://<host>:<port>/pxf/<version>/<rest of path></code>" + + The returned value is always a Server Error code (500). + If the version is different than the current version, an appropriate error is returned with version details. + Otherwise, an error about unknown path is returned.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/InvalidPathResource.html#InvalidPathResource--">InvalidPathResource</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/InvalidPathResource.html#noPathGet--">noPathGet</a></span>()</code> +<div class="block">Catches path /pxf/</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/InvalidPathResource.html#noPathPost--">noPathPost</a></span>()</code> +<div class="block">Catches path /pxf/</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/InvalidPathResource.html#wrongPathGet-java.lang.String-">wrongPathGet</a></span>(java.lang.String path)</code> +<div class="block">Catches paths of pattern /pxf/*</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>javax.ws.rs.core.Response</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/rest/InvalidPathResource.html#wrongPathPost-java.lang.String-">wrongPathPost</a></span>(java.lang.String path)</code> +<div class="block">Catches paths of pattern /pxf/*</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="InvalidPathResource--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InvalidPathResource</h4> +<pre>public InvalidPathResource()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="noPathGet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>noPathGet</h4> +<pre>public javax.ws.rs.core.Response noPathGet()</pre> +<div class="block">Catches path /pxf/</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>error message response</dd> +</dl> +</li> +</ul> +<a name="noPathPost--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>noPathPost</h4> +<pre>public javax.ws.rs.core.Response noPathPost()</pre> +<div class="block">Catches path /pxf/</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>error message response</dd> +</dl> +</li> +</ul> +<a name="wrongPathGet-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wrongPathGet</h4> +<pre>public javax.ws.rs.core.Response wrongPathGet(java.lang.String path)</pre> +<div class="block">Catches paths of pattern /pxf/*</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - request path</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>error message response</dd> +</dl> +</li> +</ul> +<a name="wrongPathPost-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wrongPathPost</h4> +<pre>public javax.ws.rs.core.Response wrongPathPost(java.lang.String path)</pre> +<div class="block">Catches paths of pattern /pxf/*</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - request path</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>error message response</dd> +</dl> +</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="../../../../../../org/apache/hawq/pxf/service/rest/FragmenterResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/rest/MetadataResource.html" title="class in org.apache.hawq.pxf.service.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/rest/InvalidPathResource.html" target="_top">Frames</a></li> +<li><a href="InvalidPathResource.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
