ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaha_5.4.0.1/sslconfiguration.htm

443 lines
28 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="SSLConfiguration Javadoc information" />
<meta name="DC.Relation" scheme="URI" content="rzahajssenative.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="sslconfiguration" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>SSLConfiguration Javadoc information</title>
</head>
<body id="sslconfiguration"><a name="sslconfiguration"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">SSLConfiguration Javadoc information</h1>
<div><div class="section"><p>com.ibm.as400</p>
<p>Class SSLConfiguration</p>
<pre>java.lang.Object
|
+--<strong>com.ibm.as400.SSLConfiguration</strong></pre>
<p><strong>All Implemented Interfaces:</strong></p>
<p>java.lang.Cloneable,
javax.net.ssl.ManagerFactoryParameters</p>
<div class="p"><p>public final class <strong>SSLConfiguration</strong><br />
extends java.lang.Object<br />
implements javax.net.ssl.ManagerFactoryParameters, java.lang.Cloneable</p>
</div>
<p>This
class provides for the specification of the configuration needed by the native iSeries™
JSSE implementation.</p>
<p>The native iSeries JSSE implementation works the
most efficiently using a <samp class="codeph">KeyStore</samp> object of type "IbmISeriesKeyStore".
This type of <samp class="codeph">KeyStore</samp> object contains key entries and trusted
certificate entries based either on an application identifier registered with
the Digital Certificate Manager (DCM) or on a keyring file (digital certificate
container). A <samp class="codeph">KeyStore</samp> object of this type can then be used
to initialize an <samp class="codeph">X509KeyManger</samp> and an <samp class="codeph">X509TrustManager</samp> object
from the "IbmISeriesSslProvider" <samp class="codeph">Provider</samp>. The <samp class="codeph">X509KeyManager</samp> and <samp class="codeph">X509TrustManager</samp> objects
can then be used to initialize an <samp class="codeph">SSLContext</samp> object from
the "IbmISeriesSslProvider". The <samp class="codeph">SSLContext</samp> object then
provides access to the native iSeries JSSE implementation based on
the configuration information specified for the <samp class="codeph">KeyStore</samp> object.
Each time a load is performed for an "IbmISeriesKeyStore" <samp class="codeph">KeyStore</samp>,
the <samp class="codeph">KeyStore</samp> is initialized based on the current configuration
specified by the application identifier or keyring file.</p>
<p>This class
can also be used to generate a <samp class="codeph">KeyStore</samp> object of any valid
type. The <samp class="codeph">KeyStore</samp> is initialized based on the current
configuration specified by the application identifier or keyring file. Any
change made to the configuration specified by an application identifier or
keyring file would require the <samp class="codeph">KeyStore</samp> object to be regenerated
to pick up the change. Note that a keyring password must be specified (for
the *SYSTEM certificate store when using an application ID) to be able to
successfully create a <samp class="codeph">KeyStore</samp> of a type other than "IbmISeriesKeyStore".
The keyring password must be specified to successfully gain access to any
private key for any <samp class="codeph">KeyStore</samp> of type "IbmISeriesKeyStore"
which is created. </p>
<dl><dt class="dlterm"><strong>Since:</strong></dt>
<dd>SDK 1.4</dd>
<dt class="dlterm">See Also:</dt>
<dd>KeyStore, X509KeyManager, X509TrustManager, SSLContext</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section"><h4 class="sectiontitle">Constructor Summary</h4><p><samp class="codeph"><strong>SSLConfiguration</strong>()</samp> Creates
a new SSLConfiguration. See <a href="#sslconfiguration__constructdetail">Constructor detail</a> for
more information.</p>
</div>
<div class="section">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption>Table 1. <strong>Method Summary</strong></caption><tbody><tr valign="bottom"><td valign="bottom" width="31.313131313131315%"><samp class="codeph">void</samp></td>
<td valign="bottom" width="68.68686868686868%"><a href="#sslconfiguration__clear">clear</a>() Clears
all information in the object so that all of the get methods return null.</td>
</tr>
<tr valign="bottom"><td valign="bottom" width="31.313131313131315%"><samp class="codeph">java.lang.Object</samp></td>
<td valign="bottom" width="68.68686868686868%"><a href="#sslconfiguration__clone">clone</a>() Generates
a new copy of this SSL configuration.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">boolean</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__equals">equals</a>(java.lang.Objectobj)
Indicates whether some other object is "equal to" this one.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">protected void</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__finalize">finalize</a>() Called by the garbage
collector on an object when garbage collection determines that there are
no more references to the object.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">java.lang.String</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__getapplicationid">getApplicationId</a>() Returns
the application ID.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">java.lang.String</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__getkeyringlabel">getKeyringLabel</a>() Returns
the keyring label.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">java.lang.String</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__getkeyringname">getKeyringName</a>() Returns the
keyring name.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">char[]</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__getkeyringpassword">getKeyringPassword</a>() Returns
the keyring password.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">java.security.KeyStore</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__getkeystore">getKeyStore</a>(char[]password)
Returns a keystore of type "IbmISeriesKeyStore" using the given password.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">java.security.KeyStore</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__getkeystore2">getKeyStore</a>(java.lang.Stringtype,
char[]password) Returns a keystore of the requested type using the given
password.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">int</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__hashcode">hashCode</a>() Returns a hash
code value for the object.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">staticvoid</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__main">(java.lang.String[]args)</a>
Executes SSLConfiguration functions.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">void</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__run">(java.lang.String[]args, java.io.PrintStreamout)</a>
Executes SSLConfiguration functions.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">void</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__setapplicationid1">setApplicationId</a>(java.lang.StringapplicationId)
Sets the application ID.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">void</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__setapplicationid2">setApplicationId</a>(java.lang.StringapplicationId,
char[]password) Sets the application ID and the keyring password.</td>
</tr>
<tr><td valign="top" width="31.313131313131315%"> <samp class="codeph">void</samp></td>
<td valign="top" width="68.68686868686868%"><a href="#sslconfiguration__setkeyring">setKeyring</a>(java.lang.Stringname,java.lang.Stringlabel,
char[]password) Sets the keyring information.</td>
</tr>
</tbody>
</table>
</div>
<p>-------------------------------------------------</p>
</div>
<div class="section">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="border" border="1" rules="all"><tbody><tr><td valign="top"><strong>Methods inherited from class java.lang.Object</strong></td>
</tr>
<tr><td valign="top"><samp class="codeph">getClass, notify, notifyAll, toString, wait, wait, wait</samp></td>
</tr>
</tbody>
</table>
</div>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__constructdetail"><a name="sslconfiguration__constructdetail"><!-- --></a><h4 class="sectiontitle">Constructor detail </h4><p><strong>SSLConfiguration</strong></p>
<pre>public <strong>SSLConfiguration</strong>()</pre>
<p>Creates a new SSLConfiguration.
The application identifier and keyring information is initialized to default
values.</p>
<p>The default value for the application identifier is the value
specified for the "os400.secureApplication" property.</p>
<p>The default values
for the keyring information is null if the "os400.secureApplication" property
is specified. If the "os400.secureApplication" property is not specified,
then the default value for the keyring name is the value specified for the"os400.certificateContainer"
property. If the "os400.secureApplication" property is not specified, then
the keyring label is initialized to the value of the "os400.certificateLabel"
property. If neither of the "os400.secureApplication" or "os400.certificateContainer"
properties are set, then the keyring name will be initialized to "*SYSTEM". </p>
<p>-------------------------------------------------</p>
</div>
<div class="section"><h4 class="sectiontitle">Method detail</h4><p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__main"><a name="sslconfiguration__main"><!-- --></a><h4 class="sectiontitle">main</h4><pre>public static void <strong>main</strong>(java.lang.String[]args)</pre>
<p>Executes
SSLConfiguration functions. There are four commands that can be performed:
-help, -create, -display, and -update. The command must be the first parameter
specified.</p>
<p>The following are the options which may be specified (in
any order):</p>
<div class="p"> <dl><dt class="dlterm"><var class="varname">-keystore</var> keystore-file-name</dt>
<dd>Specifies the name of the keystore file to be created, updated or displayed.
This option is required for all commands.</dd>
<dt class="dlterm"><var class="varname">-storepass</var> keystore-file-password</dt>
<dd>Specifies the password associated with the keystore file to be created,
updated, or displayed. This option is required for all commands.</dd>
<dt class="dlterm"><var class="varname">-storetype</var> keystore-type</dt>
<dd>Specifies the type of keystore file to be created, updated, or displayed.
This option may be specified for any command. If this option is not specified,
then a value of "IbmISeriesKeyStore" is used.</dd>
<dt class="dlterm"><var class="varname">-appid</var> application-identifier</dt>
<dd>Specifies the application identifier to be used to initialize a keystore
file being created or updated. This option is optional for the <var class="varname">-create</var>
and <var class="varname">-update</var> commands. Only one of the <var class="varname">-appid</var>, <var class="varname">keyring</var>,
and <var class="varname">-systemdefault</var> options may be specified.</dd>
<dt class="dlterm"><var class="varname">-keyring</var> keyring-file-name</dt>
<dd>Specifies the keyring file name to be used to initialize a keystore file
being created or updated. This option is optional for the <var class="varname">-create</var>
and <var class="varname">-update</var> commands. Only one of the <var class="varname">-appid</var>, <var class="varname">keyring</var>,
and <var class="varname">-systemdefault</var> options may be specified.</dd>
<dt class="dlterm"><var class="varname">-keyringpass</var> keyring-file-password</dt>
<dd>Specifies the keyring file password to be used to initialize a keystore
file being created or updated. This option may be specified for the <var class="varname">-create</var>
and <var class="varname">-update</var> commands and is required when a keystore type
other than "IbmISeriesKeyStore" is specified. If this option is not specified,
then the stashed keyring password is used.</dd>
<dt class="dlterm"><var class="varname">-keyringlabel</var> keyring-file-label</dt>
<dd>Specifies the keyring file label to be used to initialize a keystore file
being created or updated. This option may only be specified when the <var class="varname">-keyring</var> option
is also specified. If this option is not specified when the <var class="varname">keyring</var> option
is specified, then the default label in the keyring is used.</dd>
<dt class="dlterm"><var class="varname">-systemdefault</var></dt>
<dd>Specifies the system default value is to be used to initialize a keystore
file being created or updated. This option is optional for the <var class="varname">-create</var>
and <var class="varname">-update</var> commands. Only one of the <var class="varname">-appid</var>, <var class="varname">keyring</var>,
and <var class="varname">-systemdefault</var> options may be specified.</dd>
<dt class="dlterm"><var class="varname">-v</var></dt>
<dd>Specifies that verbose output is to be produced. This option may be
specified for any command.</dd>
</dl>
</div>
<p>The help command displays usage information for specifying
the paramters to this method. The parameters to invoke the help function
is specified as follows:</p>
<pre> -help</pre>
<p>The create command creates a new keystore file. There
are three variations of the create command. One variation to create a keystore
based on a particular application identifier, another variation to create
a keystore based on a keyring name, label, and password, and a third variation
to create a keystore based on the system default configuration.</p>
<p>To
create a keystore based on a particular application identifier, the <var class="varname">-appid</var> option
must be specified. The following parameters would create a keystore file
of type "IbmISeriesKeyStore" named "keystore.file" with a password of "keypass"
which is initialized based on the application identifier "APPID":</p>
<pre> -create -keystore keystore.file -storepass keypass -storetype IbmISeriesKeyStore
-appid APPID</pre>
<p>To create a keystore based on a particular
keyring file, the <em>-keyring</em> option must be specified. The <em>-keyringpass</em> and <em>keyringlabel</em> options
may also be specified. The following parameters would create a keystore file
of type "IbmISeriesKeyStore" named "keystore.file" with a password of "keypass"
which is initialized based on the keyring file named "keyring.file", keyring
password "ringpass", and keyring label "keylabel":</p>
<pre> -create -keystore keystore.file -storepass keypass -storetype IbmISeriesKeyStore
-keyring keyring.file -keyringpass ringpass -keyringlabel keylabel</pre>
<p>
To create a keystore based on the system default configuration, the <em>-systemdefault</em> option
must be specified. The following parameters would create a keystore file
of type "IbmISeriesKeyStore" named "keystore.file" with a password of "keypass"
which is initialized based on the system default configuration: </p>
<pre> -create -keystore keystore.file -storepass keypass -systemdefault</pre>
<p>The
update command updates an existing keystore file of type "IbmISeriesKeyStore".
There are three variations of the update command which are identical to the
variations of the create command. The options for the update command are
identical to the options used for the create command. The display command
displays the configuration specified for an existing keystore file. The following
parameters would display the configuration specified by a keystore file
of type "IbmISeriesKeyStore" named "keystore.file" with a password of "keypass":
</p>
<pre> -display -keystore keystore.file -storepass keypass -storetype IbmISeriesKeyStore</pre>
<dl><dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">args</samp> - the command line arguments</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__run"><a name="sslconfiguration__run"><!-- --></a><h4 class="sectiontitle">run</h4><pre>public void <strong>run</strong>(java.lang.String[]args,
java.io.PrintStreamout)</pre>
<p>Executes SSLConfiguration
functions. The parameters and functionality of this method are identical to
the main() method.</p>
<dl><dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">args</samp> - the command arguments</dd>
<dd class="ddexpand"><samp class="codeph">out</samp> - output stream to which results are to be written</dd>
</dl>
<p><strong>See Also:</strong><samp class="codeph">com.ibm.as400.SSLConfiguration.main()</samp></p>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__getapplicationid"><a name="sslconfiguration__getapplicationid"><!-- --></a><h4 class="sectiontitle">getApplicationId</h4><pre>public java.lang.String <strong>getApplicationId</strong>()</pre>
<p>Returns the
application ID.</p>
<dl><dt class="dlterm"><strong>Returns:</strong></dt>
<dd>the application ID.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__getkeyringname"><a name="sslconfiguration__getkeyringname"><!-- --></a><h4 class="sectiontitle">getKeyringName</h4><pre>public java.lang.String <strong>getKeyringName</strong>()</pre>
<p>Returns the
keyring name.</p>
<dl><dt class="dlterm"><strong>Returns:</strong></dt>
<dd>the keyring name.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__getkeyringlabel"><a name="sslconfiguration__getkeyringlabel"><!-- --></a><h4 class="sectiontitle">getKeyringLabel</h4><pre>public java.lang.String <strong>getKeyringLabel</strong>()</pre>
<p>Returns the
keyring label.</p>
<dl><dt class="dlterm"><strong>Returns:</strong></dt>
<dd>the keyring label.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__getkeyringpassword"><a name="sslconfiguration__getkeyringpassword"><!-- --></a><h4 class="sectiontitle">getKeyringPassword</h4><pre>public final char[] <strong>getKeyringPassword</strong>()</pre>
<p>Returns the
keyring password.</p>
<dl><dt class="dlterm"><strong>Returns:</strong></dt>
<dd>the keyring password.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__finalize"><a name="sslconfiguration__finalize"><!-- --></a><h4 class="sectiontitle">finalize</h4><pre>protected void <strong>finalize</strong>()
throws java.lang.Throwable</pre>
<p>Called by the garbage
collector on an object when garbage collection determines that there are no
more references to the object.</p>
<dl><dt class="dlterm"><strong>Overrides:</strong></dt>
<dd><samp class="codeph">finalize</samp> in class <samp class="codeph">java.lang.Object</samp></dd>
<dt class="dlterm"><strong>Throws:</strong></dt>
<dd><samp class="codeph">java.lang.Throwable</samp> - the exception raised by this method.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__clear"><a name="sslconfiguration__clear"><!-- --></a><h4 class="sectiontitle">clear</h4><pre>public void <strong>clear</strong>()</pre>
<p>Clears all information in the object
so that all of the get methods return null.</p>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__setkeyring"><a name="sslconfiguration__setkeyring"><!-- --></a><h4 class="sectiontitle">setKeyring</h4><pre>public void <strong>setKeyring</strong>(java.lang.Stringname,
java.lang.Stringlabel,
char[]password)</pre>
<p>Sets the keyring information.</p>
<dl><dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">name</samp> - the keyring name</dd>
<dd class="ddexpand"><samp class="codeph">label</samp> - the keyring label, or null if the default keyring
entry is to be used.</dd>
<dd class="ddexpand"><samp class="codeph">password</samp> - the keyring password, or null if the stashed
password is to be used.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__setapplicationid1"><a name="sslconfiguration__setapplicationid1"><!-- --></a><h4 class="sectiontitle">setApplicationId</h4><pre>public void <strong>setApplicationId</strong>(java.lang.StringapplicationId)</pre>
<p>Sets
the application ID.</p>
<dl><dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">applicationId</samp> - the application ID.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__setapplicationid2"><a name="sslconfiguration__setapplicationid2"><!-- --></a><h4 class="sectiontitle">setApplicationId</h4><pre>public void <strong>setApplicationId</strong>(java.lang.StringapplicationId,
char[]password)</pre>
<p>Sets the application
ID and the keyring password. Specifying the keyring password allows any keystore
which is created to allow access to the private key.</p>
<dl><dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">applicationId</samp> - the application ID.</dd>
<dd class="ddexpand"><samp class="codeph">password</samp> - the keyring password.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__equals"><a name="sslconfiguration__equals"><!-- --></a><h4 class="sectiontitle">equals</h4><pre>public boolean <strong>equals</strong>(java.lang.Objectobj)</pre>
Indicates whether
some other object is "equal to" this one. <dl><dt class="dlterm"><strong>Overrides:</strong></dt>
<dd><samp class="codeph">equals</samp> in class <samp class="codeph">java.lang.Object</samp></dd>
<dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">obj</samp> - object to be compared</dd>
<dt class="dlterm"><strong>Returns:</strong></dt>
<dd>indicator of whether the objects specify the same configuration information</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__hashcode"><a name="sslconfiguration__hashcode"><!-- --></a><h4 class="sectiontitle">hashCode</h4><pre>public int <strong>hashCode</strong>()</pre>
<p>Returns a hash code value for the
object.</p>
<dl><dt class="dlterm"><strong>Overrides:</strong></dt>
<dd><samp class="codeph">hashCode</samp> in class <samp class="codeph">java.lang.Object</samp></dd>
<dt class="dlterm"><strong>Returns:</strong></dt>
<dd>a hash code value for this object.</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__clone"><a name="sslconfiguration__clone"><!-- --></a><h4 class="sectiontitle">clone</h4><pre>public java.lang.Object <strong>clone</strong>()</pre>
<p>Generate a new copy of
this SSL configuration. Subsequent changes to the components of this SSL configuration
will not affect the new copy, and vice versa.</p>
<dl><dt class="dlterm"><strong>Overrides:</strong></dt>
<dd><samp class="codeph">clone</samp> in class <samp class="codeph">java.lang.Object</samp></dd>
<dt class="dlterm"><strong>Returns:</strong></dt>
<dd>a copy of this SSL configuration</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__getkeystore"><a name="sslconfiguration__getkeystore"><!-- --></a><h4 class="sectiontitle">getKeyStore</h4><pre>public java.security.KeyStore <strong>getKeyStore</strong>(char[]password)
throws java.security.KeyStoreException</pre>
<p>Returns
a keystore of type "IbmISeriesKeyStore" using the given password. The keystore
is intialized based on the configuration information currently stored in the
object.</p>
<dl><dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">password</samp> - used to initialize the keystore</dd>
<dt class="dlterm"><strong>Returns:</strong></dt>
<dd>KeyStore keystore initialized based on the configuration information currently
stored in the object</dd>
<dt class="dlterm"><strong>Throws:</strong></dt>
<dd><samp class="codeph">java.security.KeyStoreException</samp> - if the keystore could
not be created</dd>
</dl>
<p>-------------------------------------------------</p>
</div>
<div class="section" id="sslconfiguration__getkeystore2"><a name="sslconfiguration__getkeystore2"><!-- --></a><h4 class="sectiontitle"> getKeyStore</h4><pre>public java.security.KeyStore <strong>getKeyStore</strong>(java.lang.Stringtype,
char[]password)
throws java.security.KeyStoreException</pre>
<p>Returns
a keystore of the requested type using the given password. The keystore is
initialized based on the configuration information currently stored in the
object.</p>
<dl><dt class="dlterm"><strong>Parameters:</strong></dt>
<dd><samp class="codeph">type</samp> - type of keystore to be returned</dd>
<dd class="ddexpand"><samp class="codeph">password</samp> - used to initialize the keystore</dd>
<dt class="dlterm"><strong>Returns:</strong></dt>
<dd>KeyStore keystore initialized based on the configuration information currently
stored in the object</dd>
<dt class="dlterm"><strong>Throws:</strong></dt>
<dd><samp class="codeph">java.security.KeyStoreException</samp> - if the keystore could
not be created </dd>
</dl>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzahajssenative.htm" title="The native iSeries JSSE provider offers the full suite of JSSE classes and interfaces including implementations of the JSSE KeyStore class and the SSLConfiguration class.">Using the native iSeries JSSE provider</a></div>
</div>
</div>
</body>
</html>