http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html new file mode 100644 index 0000000..30f30b6 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html @@ -0,0 +1,310 @@ +<!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>AnalyzeUtils</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="AnalyzeUtils"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/utilities/CustomWebappLoader.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html" target="_top">Frames</a></li> +<li><a href="AnalyzeUtils.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.utilities</div> +<h2 title="Class AnalyzeUtils" class="title">Class AnalyzeUtils</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.utilities.AnalyzeUtils</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AnalyzeUtils</span> +extends java.lang.Object</pre> +<div class="block">Helper class to get statistics for ANALYZE.</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/utilities/AnalyzeUtils.html#AnalyzeUtils--">AnalyzeUtils</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static java.util.BitSet</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html#generateSamplingBitSet-int-int-">generateSamplingBitSet</a></span>(int poolSize, + int sampleSize)</code> +<div class="block">Marks sampleSize bits out of the poolSize, in a uniform way.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static java.util.List<<a href="../../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html#getSampleFragments-java.util.List-org.apache.hawq.pxf.service.utilities.ProtocolData-">getSampleFragments</a></span>(java.util.List<<a href="../../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> fragments, + <a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities">ProtocolData</a> protData)</code> +<div class="block">In case pxf_max_fragments parameter is declared, make sure not to get + over the limit.</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="AnalyzeUtils--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AnalyzeUtils</h4> +<pre>public AnalyzeUtils()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSampleFragments-java.util.List-org.apache.hawq.pxf.service.utilities.ProtocolData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSampleFragments</h4> +<pre>public static java.util.List<<a href="../../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> getSampleFragments(java.util.List<<a href="../../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> fragments, + <a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities">ProtocolData</a> protData)</pre> +<div class="block">In case pxf_max_fragments parameter is declared, make sure not to get + over the limit. The returned fragments are evenly distributed, in order + to achieve good sampling.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fragments</code> - fragments list</dd> +<dd><code>protData</code> - container for parameters, including sampling data.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a list of fragments no bigger than pxf_max_fragments parameter.</dd> +</dl> +</li> +</ul> +<a name="generateSamplingBitSet-int-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>generateSamplingBitSet</h4> +<pre>public static java.util.BitSet generateSamplingBitSet(int poolSize, + int sampleSize)</pre> +<div class="block">Marks sampleSize bits out of the poolSize, in a uniform way.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>poolSize</code> - pool size</dd> +<dd><code>sampleSize</code> - sample size</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>bit set with sampleSize bits set out of poolSize.</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/utilities/CustomWebappLoader.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/AnalyzeUtils.html" target="_top">Frames</a></li> +<li><a href="AnalyzeUtils.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/utilities/CustomWebappLoader.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html new file mode 100644 index 0000000..4344905 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html @@ -0,0 +1,419 @@ +<!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>CustomWebappLoader</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="CustomWebappLoader"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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/utilities/AnalyzeUtils.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/utilities/Log4jConfigure.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html" target="_top">Frames</a></li> +<li><a href="CustomWebappLoader.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><a href="#fields.inherited.from.class.org.apache.catalina.loader.WebappLoader">Field</a> | </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.utilities</div> +<h2 title="Class CustomWebappLoader" class="title">Class CustomWebappLoader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.catalina.util.LifecycleBase</li> +<li> +<ul class="inheritance"> +<li>org.apache.catalina.util.LifecycleMBeanBase</li> +<li> +<ul class="inheritance"> +<li>org.apache.catalina.loader.WebappLoader</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.utilities.CustomWebappLoader</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.beans.PropertyChangeListener, java.util.EventListener, javax.management.MBeanRegistration, org.apache.catalina.Lifecycle, org.apache.catalina.Loader</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CustomWebappLoader</span> +extends org.apache.catalina.loader.WebappLoader</pre> +<div class="block">A WebappLoader that allows a customized classpath to be added through configuration in context xml. + Any additional classpath entry will be added to the default webapp classpath. + + <pre> + <Context> + <Loader className="org.apache.hawq.pxf.service.utilities.CustomWebappLoader" + classpathFiles="/somedir/classpathFile1;/somedir/classpathFile2"/> + </Context> + </pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.catalina.loader.WebappLoader"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.catalina.loader.WebappLoader</h3> +<code>sm, support</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.catalina.util.LifecycleMBeanBase"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase</h3> +<code>mserver</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.catalina.Lifecycle"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.catalina.Lifecycle</h3> +<code>AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT</code></li> +</ul> +</li> +</ul> +<!-- ======== 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/utilities/CustomWebappLoader.html#CustomWebappLoader--">CustomWebappLoader</a></span>()</code> +<div class="block">Constructs a WebappLoader with no defined parent class loader (actual parent will be the system class loader).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html#CustomWebappLoader-java.lang.ClassLoader-">CustomWebappLoader</a></span>(java.lang.ClassLoader parent)</code> +<div class="block">Constructs a WebappLoader with the specified class loader to be defined as the parent for this ClassLoader.</div> +</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html#setClasspathFiles-java.lang.String-">setClasspathFiles</a></span>(java.lang.String classpathFiles)</code> +<div class="block"><code>classpathFiles</code> attribute is automatically set from the context xml file.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html#setSecondaryClasspathFiles-java.lang.String-">setSecondaryClasspathFiles</a></span>(java.lang.String secondaryClasspathFiles)</code> +<div class="block"><code>secondaryClasspathFiles</code> attribute is automatically set from the context xml file.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html#startInternal--">startInternal</a></span>()</code> +<div class="block">Implements <code>LifecycleBase.startInternal()</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.catalina.loader.WebappLoader"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.catalina.loader.WebappLoader</h3> +<code>addPropertyChangeListener, addRepository, backgroundProcess, closeJARs, findRepositories, getClassLoader, getClasspath, getContainer, getDelegate, getDomainInternal, getInfo, getLoaderClass, getLoaderRepositories, getLoaderRepositoriesString, getObjectNameKeyProperties, getReloadable, getRepositories, getRepositoriesString, getSearchExternalFirst, modified, propertyChange, removePropertyChangeListener, setContainer, setDelegate, setLoaderClass, setReloadable, setSearchExternalFirst, stopInternal, toString</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.catalina.util.LifecycleMBeanBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase</h3> +<code>destroyInternal, getDomain, getObjectName, initInternal, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.catalina.util.LifecycleBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.catalina.util.LifecycleBase</h3> +<code>addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop</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, 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="CustomWebappLoader--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CustomWebappLoader</h4> +<pre>public CustomWebappLoader()</pre> +<div class="block">Constructs a WebappLoader with no defined parent class loader (actual parent will be the system class loader).</div> +</li> +</ul> +<a name="CustomWebappLoader-java.lang.ClassLoader-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CustomWebappLoader</h4> +<pre>public CustomWebappLoader(java.lang.ClassLoader parent)</pre> +<div class="block">Constructs a WebappLoader with the specified class loader to be defined as the parent for this ClassLoader.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parent</code> - The parent class loader</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setClasspathFiles-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClasspathFiles</h4> +<pre>public void setClasspathFiles(java.lang.String classpathFiles)</pre> +<div class="block"><code>classpathFiles</code> attribute is automatically set from the context xml file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>classpathFiles</code> - Files separated by <code>;</code> Which contains <code>;</code> separated list of path entries.</dd> +</dl> +</li> +</ul> +<a name="setSecondaryClasspathFiles-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSecondaryClasspathFiles</h4> +<pre>public void setSecondaryClasspathFiles(java.lang.String secondaryClasspathFiles)</pre> +<div class="block"><code>secondaryClasspathFiles</code> attribute is automatically set from the context xml file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>secondaryClasspathFiles</code> - Files separated by <code>;</code> Which contains <code>;</code> separated list of path entries.</dd> +</dl> +</li> +</ul> +<a name="startInternal--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>startInternal</h4> +<pre>protected void startInternal() + throws org.apache.catalina.LifecycleException</pre> +<div class="block">Implements <code>LifecycleBase.startInternal()</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>startInternal</code> in class <code>org.apache.catalina.loader.WebappLoader</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.catalina.LifecycleException</code> - if this component detects a fatal error that prevents this component from being used.</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/utilities/AnalyzeUtils.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/utilities/Log4jConfigure.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/CustomWebappLoader.html" target="_top">Frames</a></li> +<li><a href="CustomWebappLoader.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><a href="#fields.inherited.from.class.org.apache.catalina.loader.WebappLoader">Field</a> | </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/utilities/Log4jConfigure.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/Log4jConfigure.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/Log4jConfigure.html new file mode 100644 index 0000000..3dc3ab6 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/Log4jConfigure.html @@ -0,0 +1,281 @@ +<!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>Log4jConfigure</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="Log4jConfigure"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/utilities/CustomWebappLoader.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/Log4jConfigure.html" target="_top">Frames</a></li> +<li><a href="Log4jConfigure.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.utilities</div> +<h2 title="Class Log4jConfigure" class="title">Class Log4jConfigure</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.utilities.Log4jConfigure</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Log4jConfigure</span> +extends java.lang.Object</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/utilities/Log4jConfigure.html#Log4jConfigure--">Log4jConfigure</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/Log4jConfigure.html#configure-javax.servlet.ServletContextEvent-">configure</a></span>(javax.servlet.ServletContextEvent event)</code> +<div class="block">Initializes log4j logging for the webapp.</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="Log4jConfigure--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Log4jConfigure</h4> +<pre>public Log4jConfigure()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="configure-javax.servlet.ServletContextEvent-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>configure</h4> +<pre>public static void configure(javax.servlet.ServletContextEvent event)</pre> +<div class="block">Initializes log4j logging for the webapp. + + Reads log4j properties file location from log4jConfigLocation parameter + in web.xml. When not using aboslute path, the path starts from the webapp + root directory. If the file can't be read, reverts to default + configuration file under WEB-INF/classes/pxf-log4j.properties.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>event</code> - Servlet context, used to determine webapp root directory.</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/utilities/CustomWebappLoader.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/Log4jConfigure.html" target="_top">Frames</a></li> +<li><a href="Log4jConfigure.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/utilities/ProtocolData.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/ProtocolData.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/ProtocolData.html new file mode 100644 index 0000000..1dc9f7d --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/ProtocolData.html @@ -0,0 +1,668 @@ +<!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>ProtocolData</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="ProtocolData"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/utilities/Log4jConfigure.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/utilities/SecuredHDFS.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/ProtocolData.html" target="_top">Frames</a></li> +<li><a href="ProtocolData.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.utilities</div> +<h2 title="Class ProtocolData" class="title">Class ProtocolData</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">org.apache.hawq.pxf.api.utilities.InputData</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.utilities.ProtocolData</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ProtocolData</span> +extends <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a></pre> +<div class="block">Common configuration of all MetaData classes. Provides read-only access to + common parameters supplied using system properties.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#host">host</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#INVALID_SPLIT_IDX">INVALID_SPLIT_IDX</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html" title="enum in org.apache.hawq.pxf.api">OutputFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#outputFormat">outputFormat</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#port">port</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#profile">profile</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#statsMaxFragments">statsMaxFragments</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#statsSampleRatio">statsSampleRatio</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#token">token</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hawq.pxf.api.utilities.InputData"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#accessor">accessor</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#dataFragment">dataFragment</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#dataSource">dataSource</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#filterString">filterString</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#filterStringValid">filterStringValid</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#fragmenter">fragmenter</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#fragmentMetadata">fragmentMetadata</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#metadata">metadata</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#recordkeyColumn">recordkeyColumn</a>, <a href="../../../. ./../../org/apache/hawq/pxf/api/utilities/InputData.html#remoteLogin">remoteLogin</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#remoteSecret">remoteSecret</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#requestParametersMap">requestParametersMap</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#resolver">resolver</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#segmentId">segmentId</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#threadSafe">threadSafe</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#totalSegments">totalSegments</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#tupleDescription">tupleDescription</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#userData">userData</a></code></li> +</ul> +</li> +</ul> +<!-- ======== 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/utilities/ProtocolData.html#ProtocolData-java.util.Map-">ProtocolData</a></span>(java.util.Map<java.lang.String,java.lang.String> paramsMap)</code> +<div class="block">Constructs a ProtocolData.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#ProtocolData-java.util.Map-java.lang.String-">ProtocolData</a></span>(java.util.Map<java.lang.String,java.lang.String> paramsMap, + java.lang.String profileString)</code> +<div class="block">Constructs a ProtocolData.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#ProtocolData-org.apache.hawq.pxf.service.utilities.ProtocolData-">ProtocolData</a></span>(<a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities">ProtocolData</a> copy)</code> +<div class="block">Constructs an InputDataBuilder from a copy.</div> +</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>java.util.Map<java.lang.String,java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#getParametersMap--">getParametersMap</a></span>()</code> +<div class="block">Returns the request parameters.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#getStatsMaxFragments--">getStatsMaxFragments</a></span>()</code> +<div class="block">Statistics parameter.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#getStatsSampleRatio--">getStatsSampleRatio</a></span>()</code> +<div class="block">Statistics parameter.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#getToken--">getToken</a></span>()</code> +<div class="block">Returns Kerberos token information.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html" title="enum in org.apache.hawq.pxf.api">OutputFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#outputFormat--">outputFormat</a></span>()</code> +<div class="block">Returns the current output format, either <a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html#TEXT"><code>OutputFormat.TEXT</code></a> or + <a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html#BINARY"><code>OutputFormat.BINARY</code></a>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#parseDataFragment-java.lang.String-">parseDataFragment</a></span>(java.lang.String fragment)</code> +<div class="block">Sets the index of the allocated data fragment</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#parseFormat-java.lang.String-">parseFormat</a></span>(java.lang.String formatString)</code> +<div class="block">Sets the format type based on the input string.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#protocolViolation-java.lang.String-">protocolViolation</a></span>(java.lang.String property)</code> +<div class="block">Throws an exception when the given property value is missing in request.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#serverName--">serverName</a></span>()</code> +<div class="block">Returns the server name providing the service.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html#serverPort--">serverPort</a></span>()</code> +<div class="block">Returns the server port providing the service.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.api.utilities.InputData"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getAccessor--">getAccessor</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getColumn-int-">getColumn</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getColumns--">getColumns</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getDataFragment--">getDataFragment</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getDataSource--">getDataSource</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFilterString--">getFilterString</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFragmenter--">getFragmenter</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFragmentMetadata--">getFragmentMetadata</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFragmentUse rData--">getFragmentUserData</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getLogin--">getLogin</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getMetadata--">getMetadata</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getRecordkeyColumn--">getRecordkeyColumn</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getResolver--">getResolver</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getSecret--">getSecret</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getSegmentId--">getSegmentId</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getTotalSegments--">getTotalSegments</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getTupleDescription--">getTupleDescription</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputD ata.html#getUserProperty-java.lang.String-">getUserProperty</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#hasFilter--">hasFilter</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#isThreadSafe--">isThreadSafe</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#setDataSource-java.lang.String-">setDataSource</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#setFragmentMetadata-byte:A-">setFragmentMetadata</a>, <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#setFragmentUserData-byte:A-">setFragmentUserData</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="INVALID_SPLIT_IDX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INVALID_SPLIT_IDX</h4> +<pre>public static final int INVALID_SPLIT_IDX</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../constant-values.html#org.apache.hawq.pxf.service.utilities.ProtocolData.INVALID_SPLIT_IDX">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="outputFormat"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>outputFormat</h4> +<pre>protected <a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html" title="enum in org.apache.hawq.pxf.api">OutputFormat</a> outputFormat</pre> +</li> +</ul> +<a name="port"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>port</h4> +<pre>protected int port</pre> +</li> +</ul> +<a name="host"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>host</h4> +<pre>protected java.lang.String host</pre> +</li> +</ul> +<a name="profile"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>profile</h4> +<pre>protected java.lang.String profile</pre> +</li> +</ul> +<a name="token"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>token</h4> +<pre>protected java.lang.String token</pre> +</li> +</ul> +<a name="statsMaxFragments"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>statsMaxFragments</h4> +<pre>protected int statsMaxFragments</pre> +</li> +</ul> +<a name="statsSampleRatio"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>statsSampleRatio</h4> +<pre>protected float statsSampleRatio</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ProtocolData-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ProtocolData</h4> +<pre>public ProtocolData(java.util.Map<java.lang.String,java.lang.String> paramsMap)</pre> +<div class="block">Constructs a ProtocolData. Parses X-GP-* configuration variables.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>paramsMap</code> - contains all query-specific parameters from Hawq</dd> +</dl> +</li> +</ul> +<a name="ProtocolData-org.apache.hawq.pxf.service.utilities.ProtocolData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ProtocolData</h4> +<pre>public ProtocolData(<a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities">ProtocolData</a> copy)</pre> +<div class="block">Constructs an InputDataBuilder from a copy. Used to create from an + extending class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>copy</code> - the input data to copy</dd> +</dl> +</li> +</ul> +<a name="ProtocolData-java.util.Map-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ProtocolData</h4> +<pre>public ProtocolData(java.util.Map<java.lang.String,java.lang.String> paramsMap, + java.lang.String profileString)</pre> +<div class="block">Constructs a ProtocolData. Parses X-GP-* configuration variables.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>paramsMap</code> - contains all query-specific parameters from Hawq</dd> +<dd><code>profileString</code> - contains the profile name</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getParametersMap--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParametersMap</h4> +<pre>public java.util.Map<java.lang.String,java.lang.String> getParametersMap()</pre> +<div class="block">Returns the request parameters.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>map of request parameters</dd> +</dl> +</li> +</ul> +<a name="protocolViolation-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>protocolViolation</h4> +<pre>public void protocolViolation(java.lang.String property)</pre> +<div class="block">Throws an exception when the given property value is missing in request.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>property</code> - missing property name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - throws an exception with the property + name in the error message</dd> +</dl> +</li> +</ul> +<a name="outputFormat--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>outputFormat</h4> +<pre>public <a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html" title="enum in org.apache.hawq.pxf.api">OutputFormat</a> outputFormat()</pre> +<div class="block">Returns the current output format, either <a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html#TEXT"><code>OutputFormat.TEXT</code></a> or + <a href="../../../../../../org/apache/hawq/pxf/api/OutputFormat.html#BINARY"><code>OutputFormat.BINARY</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>output format</dd> +</dl> +</li> +</ul> +<a name="serverName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serverName</h4> +<pre>public java.lang.String serverName()</pre> +<div class="block">Returns the server name providing the service.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>server name</dd> +</dl> +</li> +</ul> +<a name="serverPort--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serverPort</h4> +<pre>public int serverPort()</pre> +<div class="block">Returns the server port providing the service.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>server port</dd> +</dl> +</li> +</ul> +<a name="getToken--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getToken</h4> +<pre>public java.lang.String getToken()</pre> +<div class="block">Returns Kerberos token information.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>token</dd> +</dl> +</li> +</ul> +<a name="getStatsMaxFragments--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStatsMaxFragments</h4> +<pre>public int getStatsMaxFragments()</pre> +<div class="block">Statistics parameter. Returns the max number of fragments to return for + ANALYZE sampling. The value is set in HAWQ side using the GUC + pxf_stats_max_fragments.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>max number of fragments to be processed by analyze</dd> +</dl> +</li> +</ul> +<a name="getStatsSampleRatio--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStatsSampleRatio</h4> +<pre>public float getStatsSampleRatio()</pre> +<div class="block">Statistics parameter. Returns a number between 0.0001 and 1.0, + representing the sampling ratio on each fragment for ANALYZE sampling. + The value is set in HAWQ side based on ANALYZE computations and the + number of sampled fragments.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>sampling ratio</dd> +</dl> +</li> +</ul> +<a name="parseFormat-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parseFormat</h4> +<pre>protected void parseFormat(java.lang.String formatString)</pre> +<div class="block">Sets the format type based on the input string. Allowed values are: + "TEXT", "GPDBWritable".</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>formatString</code> - format string</dd> +</dl> +</li> +</ul> +<a name="parseDataFragment-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>parseDataFragment</h4> +<pre>protected void parseDataFragment(java.lang.String fragment)</pre> +<div class="block">Sets the index of the allocated data fragment</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fragment</code> - the allocated data fragment</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/utilities/Log4jConfigure.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/service/utilities/SecuredHDFS.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/ProtocolData.html" target="_top">Frames</a></li> +<li><a href="ProtocolData.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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/utilities/SecureLogin.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/SecureLogin.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/SecureLogin.html new file mode 100644 index 0000000..936e693 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/utilities/SecureLogin.html @@ -0,0 +1,283 @@ +<!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>SecureLogin</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="SecureLogin"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/utilities/SecuredHDFS.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/SecureLogin.html" target="_top">Frames</a></li> +<li><a href="SecureLogin.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.utilities</div> +<h2 title="Class SecureLogin" class="title">Class SecureLogin</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.utilities.SecureLogin</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SecureLogin</span> +extends java.lang.Object</pre> +<div class="block">This class relies heavily on Hadoop API to + <ul> + <li>Check need for secure login in Hadoop</li> + <li>Parse and load .xml configuration file</li> + <li>Do a Kerberos login with a kaytab file</li> + <li>convert _HOST in Kerberos principal to current hostname</li> + </ul> + + It uses Hadoop Configuration to parse XML configuration files.<br> + It uses Hadoop Security to modify principal and perform the login. + + The major limitation in this class is its dependency on Hadoop. If Hadoop + security is off, no login will be performed regardless of connector being + used.</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/utilities/SecureLogin.html#SecureLogin--">SecureLogin</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/service/utilities/SecureLogin.html#login--">login</a></span>()</code> </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="SecureLogin--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SecureLogin</h4> +<pre>public SecureLogin()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="login--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>login</h4> +<pre>public static void login()</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hawq/pxf/service/utilities/SecuredHDFS.html" title="class in org.apache.hawq.pxf.service.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/service/utilities/SecureLogin.html" target="_top">Frames</a></li> +<li><a href="SecureLogin.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>
