| <!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 --> |
| <title>RESTUtil</title> |
| <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="RESTUtil"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":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/iceberg/rest/RESTSessionCatalog.html" title="class in org.apache.iceberg.rest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/rest/RESTUtil.html" target="_top">Frames</a></li> |
| <li><a href="RESTUtil.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>Constr | </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>Constr | </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.iceberg.rest</div> |
| <h2 title="Class RESTUtil" class="title">Class RESTUtil</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.rest.RESTUtil</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RESTUtil</span> |
| extends java.lang.Object</pre> |
| </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>static org.apache.iceberg.relocated.com.google.common.base.Joiner</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#NAMESPACE_JOINER">NAMESPACE_JOINER</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static org.apache.iceberg.relocated.com.google.common.base.Splitter</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#NAMESPACE_SPLITTER">NAMESPACE_SPLITTER</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.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#decodeFormData-java.lang.String-">decodeFormData</a></span>(java.lang.String formString)</code> |
| <div class="block">Decodes a map of form data from application/x-www-form-urlencoded.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#decodeNamespace-java.lang.String-">decodeNamespace</a></span>(java.lang.String encodedNs)</code> |
| <div class="block">Takes in a string representation of a namespace as used for a URL parameter and returns the |
| corresponding namespace.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#decodeString-java.lang.String-">decodeString</a></span>(java.lang.String encoded)</code> |
| <div class="block">Decodes a URL-encoded string.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#encodeFormData-java.util.Map-">encodeFormData</a></span>(java.util.Map<?,?> formData)</code> |
| <div class="block">Encodes a map of form data as application/x-www-form-urlencoded.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#encodeNamespace-org.apache.iceberg.catalog.Namespace-">encodeNamespace</a></span>(<a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</code> |
| <div class="block">Returns a String representation of a namespace that is suitable for use in a URL / URI.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#encodeString-java.lang.String-">encodeString</a></span>(java.lang.String toEncode)</code> |
| <div class="block">Encodes a string using URL encoding</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static java.util.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#extractPrefixMap-java.util.Map-java.lang.String-">extractPrefixMap</a></span>(java.util.Map<java.lang.String,java.lang.String> properties, |
| java.lang.String prefix)</code> |
| <div class="block">Takes in a map, and returns a copy filtered on the entries with keys beginning with the |
| designated prefix.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static java.util.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#merge-java.util.Map-java.util.Map-">merge</a></span>(java.util.Map<java.lang.String,java.lang.String> target, |
| java.util.Map<java.lang.String,java.lang.String> updates)</code> |
| <div class="block">Merge updates into a target string map.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#stripTrailingSlash-java.lang.String-">stripTrailingSlash</a></span>(java.lang.String path)</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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NAMESPACE_JOINER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NAMESPACE_JOINER</h4> |
| <pre>public static final org.apache.iceberg.relocated.com.google.common.base.Joiner NAMESPACE_JOINER</pre> |
| </li> |
| </ul> |
| <a name="NAMESPACE_SPLITTER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NAMESPACE_SPLITTER</h4> |
| <pre>public static final org.apache.iceberg.relocated.com.google.common.base.Splitter NAMESPACE_SPLITTER</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="stripTrailingSlash-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stripTrailingSlash</h4> |
| <pre>public static java.lang.String stripTrailingSlash(java.lang.String path)</pre> |
| </li> |
| </ul> |
| <a name="merge-java.util.Map-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>merge</h4> |
| <pre>public static java.util.Map<java.lang.String,java.lang.String> merge(java.util.Map<java.lang.String,java.lang.String> target, |
| java.util.Map<java.lang.String,java.lang.String> updates)</pre> |
| <div class="block">Merge updates into a target string map.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - a map to update</dd> |
| <dd><code>updates</code> - a map of updates</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an immutable result map built from target and updates</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="extractPrefixMap-java.util.Map-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractPrefixMap</h4> |
| <pre>public static java.util.Map<java.lang.String,java.lang.String> extractPrefixMap(java.util.Map<java.lang.String,java.lang.String> properties, |
| java.lang.String prefix)</pre> |
| <div class="block">Takes in a map, and returns a copy filtered on the entries with keys beginning with the |
| designated prefix. The keys are returned with the prefix removed. |
| |
| <p>Any entries whose keys don't begin with the prefix are not returned. |
| |
| <p>This can be used to get a subset of the configuration related to the REST catalog, such as |
| all properties from a prefix of `spark.sql.catalog.my_catalog.rest.` to get REST catalog |
| specific properties from the spark configuration.</div> |
| </li> |
| </ul> |
| <a name="encodeFormData-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeFormData</h4> |
| <pre>public static java.lang.String encodeFormData(java.util.Map<?,?> formData)</pre> |
| <div class="block">Encodes a map of form data as application/x-www-form-urlencoded. |
| |
| <p>This encodes the form with pairs separated by & and keys separated from values by =.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>formData</code> - a map of form data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String of encoded form data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decodeFormData-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decodeFormData</h4> |
| <pre>public static java.util.Map<java.lang.String,java.lang.String> decodeFormData(java.lang.String formString)</pre> |
| <div class="block">Decodes a map of form data from application/x-www-form-urlencoded. |
| |
| <p>This decodes the form with pairs separated by & and keys separated from values by =.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>formString</code> - a map of form data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map of key/value form data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodeString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeString</h4> |
| <pre>public static java.lang.String encodeString(java.lang.String toEncode)</pre> |
| <div class="block">Encodes a string using URL encoding |
| |
| <p><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#decodeString-java.lang.String-"><code>decodeString(String)</code></a> should be used to decode.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>toEncode</code> - string to encode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>UTF-8 encoded string, suitable for use as a URL parameter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decodeString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decodeString</h4> |
| <pre>public static java.lang.String decodeString(java.lang.String encoded)</pre> |
| <div class="block">Decodes a URL-encoded string. |
| |
| <p>See also <a href="../../../../org/apache/iceberg/rest/RESTUtil.html#encodeString-java.lang.String-"><code>encodeString(String)</code></a> for URL encoding.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoded</code> - a string to decode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a decoded string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodeNamespace-org.apache.iceberg.catalog.Namespace-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeNamespace</h4> |
| <pre>public static java.lang.String encodeNamespace(<a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> ns)</pre> |
| <div class="block">Returns a String representation of a namespace that is suitable for use in a URL / URI. |
| |
| <p>This function needs to be called when a namespace is used as a path variable (or query |
| parameter etc.), to format the namespace per the spec. |
| |
| <p><a href="../../../../org/apache/iceberg/rest/RESTUtil.html#decodeNamespace-java.lang.String-"><code>decodeNamespace(java.lang.String)</code></a> should be used to parse the namespace from a URL parameter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ns</code> - namespace to encode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>UTF-8 encoded string representing the namespace, suitable for use as a URL parameter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decodeNamespace-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>decodeNamespace</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/catalog/Namespace.html" title="class in org.apache.iceberg.catalog">Namespace</a> decodeNamespace(java.lang.String encodedNs)</pre> |
| <div class="block">Takes in a string representation of a namespace as used for a URL parameter and returns the |
| corresponding namespace. |
| |
| <p>See also <a href="../../../../org/apache/iceberg/rest/RESTUtil.html#encodeNamespace-org.apache.iceberg.catalog.Namespace-"><code>encodeNamespace(org.apache.iceberg.catalog.Namespace)</code></a> for generating correctly formatted URLs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodedNs</code> - a namespace to decode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a namespace</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/iceberg/rest/RESTSessionCatalog.html" title="class in org.apache.iceberg.rest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/rest/RESTUtil.html" target="_top">Frames</a></li> |
| <li><a href="RESTUtil.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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
