alfred/calmnetlib
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity
master
calmnetlib/JavaDoc/com/captainalm/lib/calmnet/ssl/SSLUtilities.html

572 lines
30 KiB
HTML
Raw Permalink Normal View History

Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
Allow integer to bytes writing in PacketLoader to support negatives. Fix up JavaDoc.
2023-06-11 02:54:23 +01:00
<!-- Generated by javadoc (1.8.0_262) on Sun Jun 11 02:31:49 BST 2023 -->
Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<title>SSLUtilities</title>
Allow integer to bytes writing in PacketLoader to support negatives. Fix up JavaDoc.
2023-06-11 02:54:23 +01:00
<meta name="date" content="2023-06-11">
Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<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="SSLUtilities";
}
}
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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/SSLUtilities.html" target="_top">Frames</a></li>
<li><a href="SSLUtilities.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>Field&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>Field&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">com.captainalm.lib.calmnet.ssl</div>
<h2 title="Class SSLUtilities" class="title">Class SSLUtilities</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.ssl.SSLUtilities</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SSLUtilities</span>
extends java.lang.Object</pre>
<div class="block">This class provides SSL utilities to create <code>SSLContext</code> and <code>SSLSocket</code>
objects using JKS files (Or other supported formats).</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Captain ALM</dd>
</dl>
</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">&nbsp;</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="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#SSLUtilities--">SSLUtilities</a></span>()</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="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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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 javax.net.ssl.SSLSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLClientSocket-javax.net.ssl.SSLContext-java.lang.String-int-">getSSLClientSocket</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
java.lang.String&nbsp;host,
int&nbsp;port)</code>
<div class="block">Creates a new <code>SSLSocket</code> using the specified <code>SSLContext</code>, host and port.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContext-java.lang.String-java.security.KeyStore-char:A-">getSSLContext</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)</code>
<div class="block">Gets the SSL context merged with the JRE Trust Store using a unified <code>KeyStore</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContext-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">getSSLContext</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)</code>
<div class="block">Gets the SSL context merged with the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-">getSSLContextNoJRETrust</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)</code>
<div class="block">Gets the SSL context without the JRE Trust Store using a unified <code>KeyStore</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static javax.net.ssl.SSLContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">getSSLContextNoJRETrust</a></span>(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)</code>
<div class="block">Gets the SSL context without the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLServerSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#getSSLServerSocket-javax.net.ssl.SSLContext-int-int-java.net.InetAddress-">getSSLServerSocket</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
int&nbsp;port,
int&nbsp;backlog,
java.net.InetAddress&nbsp;ifAddress)</code>
<div class="block">Gets the SSL Server socket for the specified <code>SSLContext</code>, port, backlog and <code>InetAddress</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static java.security.KeyStore</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#loadKeyStore-java.lang.String-java.io.File-java.lang.String-">loadKeyStore</a></span>(java.lang.String&nbsp;type,
java.io.File&nbsp;file,
java.lang.String&nbsp;password)</code>
<div class="block">Loads a Keystore of a certain type from a file given the password.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static javax.net.ssl.SSLSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-">upgradeClientSocketToSSL</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose)</code>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static javax.net.ssl.SSLSocket</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilities.html#upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-boolean-">upgradeClientSocketToSSL</a></span>(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose,
boolean&nbsp;onClient)</code>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</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&nbsp;java.lang.Object</h3>
<code>equals, 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="SSLUtilities--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SSLUtilities</h4>
<pre>public&nbsp;SSLUtilities()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="loadKeyStore-java.lang.String-java.io.File-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadKeyStore</h4>
<pre>public static&nbsp;java.security.KeyStore&nbsp;loadKeyStore(java.lang.String&nbsp;type,
java.io.File&nbsp;file,
java.lang.String&nbsp;password)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Loads a Keystore of a certain type from a file given the password.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The type of keystore (pass null for the default type).</dd>
<dd><code>file</code> - The file to load the keystore from.</dd>
<dd><code>password</code> - The password of the keystore (Can be null).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The keystore.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - file is null.</dd>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContextNoJRETrust</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContextNoJRETrust(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context without the JRE Trust Store using a unified <code>KeyStore</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>unifiedKeyStore</code> - The keystore for use with the private and trust stores.</dd>
<dd><code>keyStorePassword</code> - The password of the key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContextNoJRETrust-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContextNoJRETrust</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContextNoJRETrust(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context without the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>privateKeyStore</code> - The keystore for use with the private store.</dd>
<dd><code>privateKeyStorePassword</code> - The password of the private key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dd><code>trustKeyStore</code> - The keystore for use with the trust store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContext-java.lang.String-java.security.KeyStore-char:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContext</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContext(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;unifiedKeyStore,
char[]&nbsp;keyStorePassword)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context merged with the JRE Trust Store using a unified <code>KeyStore</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>unifiedKeyStore</code> - The keystore for use with the private and trust stores.</dd>
<dd><code>keyStorePassword</code> - The password of the key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLContext-java.lang.String-java.security.KeyStore-char:A-java.security.KeyStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLContext</h4>
<pre>public static&nbsp;javax.net.ssl.SSLContext&nbsp;getSSLContext(java.lang.String&nbsp;algorithmName,
java.security.KeyStore&nbsp;privateKeyStore,
char[]&nbsp;privateKeyStorePassword,
java.security.KeyStore&nbsp;trustKeyStore)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL context merged with the JRE Trust Store using separate private and trust <code>KeyStore</code>s.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithmName</code> - The name of the context protocol or null for the JRE Default (TLSv1).</dd>
<dd><code>privateKeyStore</code> - The keystore for use with the private store.</dd>
<dd><code>privateKeyStorePassword</code> - The password of the private key store or null (Use "changeit" for JKS keystore defaults).</dd>
<dd><code>trustKeyStore</code> - The keystore for use with the trust store.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLContext.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLClientSocket-javax.net.ssl.SSLContext-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSLClientSocket</h4>
<pre>public static&nbsp;javax.net.ssl.SSLSocket&nbsp;getSSLClientSocket(javax.net.ssl.SSLContext&nbsp;sslContext,
java.lang.String&nbsp;host,
int&nbsp;port)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Creates a new <code>SSLSocket</code> using the specified <code>SSLContext</code>, host and port.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>host</code> - The host to connect to.</dd>
<dd><code>port</code> - The port to connect to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upgradeClientSocketToSSL</h4>
<pre>public static&nbsp;javax.net.ssl.SSLSocket&nbsp;upgradeClientSocketToSSL(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.
This socket is in client mode (Upgrade for client side).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>socket</code> - The socket to wrap.</dd>
<dd><code>host</code> - The host to "connect" to.</dd>
<dd><code>port</code> - The port to "connect" to.</dd>
<dd><code>autoClose</code> - If the underlying socket should be closed when the returned socket is closed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="upgradeClientSocketToSSL-javax.net.ssl.SSLContext-java.net.Socket-java.lang.String-int-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upgradeClientSocketToSSL</h4>
<pre>public static&nbsp;javax.net.ssl.SSLSocket&nbsp;upgradeClientSocketToSSL(javax.net.ssl.SSLContext&nbsp;sslContext,
java.net.Socket&nbsp;socket,
java.lang.String&nbsp;host,
int&nbsp;port,
boolean&nbsp;autoClose,
boolean&nbsp;onClient)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Upgrades an existing <code>Socket</code> to an <code>SSLSocket</code> using the specified <code>SSLContext</code>,
<code>Socket</code>, host, port and if the specified socket should be closed when the returned socket is closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>socket</code> - The socket to wrap.</dd>
<dd><code>host</code> - The host to "connect" to.</dd>
<dd><code>port</code> - The port to "connect" to.</dd>
<dd><code>autoClose</code> - If the underlying socket should be closed when the returned socket is closed.</dd>
<dd><code>onClient</code> - Is this being called on the client side.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getSSLServerSocket-javax.net.ssl.SSLContext-int-int-java.net.InetAddress-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSSLServerSocket</h4>
<pre>public static&nbsp;javax.net.ssl.SSLServerSocket&nbsp;getSSLServerSocket(javax.net.ssl.SSLContext&nbsp;sslContext,
int&nbsp;port,
int&nbsp;backlog,
java.net.InetAddress&nbsp;ifAddress)
throws <a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></pre>
<div class="block">Gets the SSL Server socket for the specified <code>SSLContext</code>, port, backlog and <code>InetAddress</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - The SSL Context to create the socket from.</dd>
<dd><code>port</code> - The port to listen on.</dd>
<dd><code>backlog</code> - The number of connections that can be queued.</dd>
<dd><code>ifAddress</code> - The network interface to listen on (null means listen on all network interfaces).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The SSLServerSocket.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl">SSLUtilityException</a></code> - An Exception has occurred.</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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/calmnet/ssl/SSLUtilityException.html" title="class in com.captainalm.lib.calmnet.ssl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/calmnet/ssl/SSLUtilities.html" target="_top">Frames</a></li>
<li><a href="SSLUtilities.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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 ======= -->
</body>
</html>
Reference in New Issue Copy Permalink