UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

451 lines (449 loc) 18.8 kB
<!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 (version 1.7.0_67) on Sun Sep 07 15:29:35 CEST 2014 --> <title>SSLTransportFactory (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="SSLTransportFactory (apache-cassandra API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/SSLTransportFactory.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/cassandra/thrift/SliceRange._Fields.html" title="enum in org.apache.cassandra.thrift"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/thrift/SuperColumn.html" title="class in org.apache.cassandra.thrift"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/thrift/SSLTransportFactory.html" target="_top">Frames</a></li> <li><a href="SSLTransportFactory.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.cassandra.thrift</div> <h2 title="Class SSLTransportFactory" class="title">Class SSLTransportFactory</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.thrift.SSLTransportFactory</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">SSLTransportFactory</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd">&nbsp;</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 java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#CIPHER_SUITES">CIPHER_SUITES</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#KEYSTORE">KEYSTORE</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#KEYSTORE_PASSWORD">KEYSTORE_PASSWORD</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#PROTOCOL">PROTOCOL</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#SOCKET_TIMEOUT">SOCKET_TIMEOUT</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#TRUSTSTORE">TRUSTSTORE</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#TRUSTSTORE_PASSWORD">TRUSTSTORE_PASSWORD</a></strong></code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.thrift.ITransportFactory"> <!-- --> </a> <h3>Fields inherited from interface&nbsp;org.apache.cassandra.thrift.<a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a></h3> <code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html#PROPERTY_KEY">PROPERTY_KEY</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#SSLTransportFactory()">SSLTransportFactory</a></strong>()</code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>org.apache.thrift.transport.TTransport</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#openTransport(java.lang.String,%20int)">openTransport</a></strong>(java.lang.String&nbsp;host, int&nbsp;port)</code> <div class="block">Opens a client transport to a thrift server.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#setOptions(java.util.Map)">setOptions</a></strong>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;options)</code> <div class="block">Sets an implementation defined set of options.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/thrift/SSLTransportFactory.html#supportedOptions()">supportedOptions</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;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="TRUSTSTORE"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>TRUSTSTORE</h4> <pre>public static final&nbsp;java.lang.String TRUSTSTORE</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.SSLTransportFactory.TRUSTSTORE">Constant Field Values</a></dd></dl> </li> </ul> <a name="TRUSTSTORE_PASSWORD"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>TRUSTSTORE_PASSWORD</h4> <pre>public static final&nbsp;java.lang.String TRUSTSTORE_PASSWORD</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.SSLTransportFactory.TRUSTSTORE_PASSWORD">Constant Field Values</a></dd></dl> </li> </ul> <a name="KEYSTORE"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KEYSTORE</h4> <pre>public static final&nbsp;java.lang.String KEYSTORE</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.SSLTransportFactory.KEYSTORE">Constant Field Values</a></dd></dl> </li> </ul> <a name="KEYSTORE_PASSWORD"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KEYSTORE_PASSWORD</h4> <pre>public static final&nbsp;java.lang.String KEYSTORE_PASSWORD</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.SSLTransportFactory.KEYSTORE_PASSWORD">Constant Field Values</a></dd></dl> </li> </ul> <a name="PROTOCOL"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>PROTOCOL</h4> <pre>public static final&nbsp;java.lang.String PROTOCOL</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.SSLTransportFactory.PROTOCOL">Constant Field Values</a></dd></dl> </li> </ul> <a name="CIPHER_SUITES"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>CIPHER_SUITES</h4> <pre>public static final&nbsp;java.lang.String CIPHER_SUITES</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.SSLTransportFactory.CIPHER_SUITES">Constant Field Values</a></dd></dl> </li> </ul> <a name="SOCKET_TIMEOUT"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>SOCKET_TIMEOUT</h4> <pre>public static final&nbsp;int SOCKET_TIMEOUT</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.thrift.SSLTransportFactory.SOCKET_TIMEOUT">Constant Field Values</a></dd></dl> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="SSLTransportFactory()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>SSLTransportFactory</h4> <pre>public&nbsp;SSLTransportFactory()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="openTransport(java.lang.String, int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>openTransport</h4> <pre>public&nbsp;org.apache.thrift.transport.TTransport&nbsp;openTransport(java.lang.String&nbsp;host, int&nbsp;port) throws java.lang.Exception</pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html#openTransport(java.lang.String,%20int)">ITransportFactory</a></code></strong></div> <div class="block">Opens a client transport to a thrift server. Example: <pre> TTransport transport = clientTransportFactory.openTransport(address, port); Cassandra.Iface client = new Cassandra.Client(new BinaryProtocol(transport)); </pre></div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html#openTransport(java.lang.String,%20int)">openTransport</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - fully qualified hostname of the server</dd><dd><code>port</code> - RPC port of the server</dd> <dt><span class="strong">Returns:</span></dt><dd>open and ready to use transport</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.Exception</code> - implementation defined; usually throws TTransportException or IOException if the connection cannot be established</dd></dl> </li> </ul> <a name="setOptions(java.util.Map)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setOptions</h4> <pre>public&nbsp;void&nbsp;setOptions(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;options)</pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html#setOptions(java.util.Map)">ITransportFactory</a></code></strong></div> <div class="block">Sets an implementation defined set of options. Keys in this map must conform to the set set returned by ITransportFactory#supportedOptions.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html#setOptions(java.util.Map)">setOptions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - option map</dd></dl> </li> </ul> <a name="supportedOptions()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>supportedOptions</h4> <pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;supportedOptions()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html#supportedOptions()">supportedOptions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/thrift/ITransportFactory.html" title="interface in org.apache.cassandra.thrift">ITransportFactory</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>set of options supported by this transport factory implementation</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/SSLTransportFactory.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/cassandra/thrift/SliceRange._Fields.html" title="enum in org.apache.cassandra.thrift"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/thrift/SuperColumn.html" title="class in org.apache.cassandra.thrift"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/thrift/SSLTransportFactory.html" target="_top">Frames</a></li> <li><a href="SSLTransportFactory.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright &copy; 2014 The Apache Software Foundation</small></p> </body> </html>