<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><spanclass="typeNameLink">Prev Class</span></a></li>
<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><spanclass="typeNameLink">Next Class</span></a></li>
<dd><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html"title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a>, <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></dd>
</dl>
<hr>
<br>
<pre>public class <spanclass="typeNameLabel">NetworkEncryptionUpgradePacket</span>
extends java.lang.Object
implements <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a>, <ahref="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html"title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></pre>
<divclass="block">This class provides the ability for supporting streams to upgrade to using password encrypted and / or base64 connections.
This class can also signal the use changes for <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>s or <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a>s.
<divclass="block">Constructs a new NetworkEncryptionUpgradePacket with the specified acknowledgement value, upgrade value, base 64 value and <code>ICipherFactory</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ulclass="blockList">
<liclass="blockList"><aname="method.summary">
<!---->
</a>
<h3>Method Summary</h3>
<tableclass="memberSummary"border="0"cellpadding="3"cellspacing="0"summary="Method Summary table, listing methods, and an explanation">
<divclass="block">Gets the <code>ICipherFactory</code> being used or null.</div>
</td>
</tr>
<trid="i2"class="altColor">
<tdclass="colFirst"><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html"title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></code></td>
<divclass="block">Gets the protocol information.</div>
</td>
</tr>
<trid="i3"class="rowColor">
<tdclass="colFirst"><code>static <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html"title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a></code></td>
<divclass="block">Gets if the packet is treated as a stream upgrade or
a change in packet use for <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
<divclass="block">Sets if the packet is treated as a stream upgrade or
a change in packet use for <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
<divclass="block">Constructs a new NetworkEncryptionUpgradePacket with the specified acknowledgement value, upgrade value, base 64 value and <code>ICipherFactory</code>.</div>
<dd><code>acknowledgement</code> - The acknowledgement value to use (Can be null).</dd>
<dd><code>upgrade</code> - Is the packet treated as a stream upgrade, See: <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionUpgradePacket.html#isUpgrade--"><code>isUpgrade()</code></a>.</dd>
<dd><code>base64ed</code> - Is the packet signalling base 64 to be used.</dd>
<dd><code>cipherFactory</code> - The cipherFactory to signal for use.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ulclass="blockList">
<liclass="blockList"><aname="method.detail">
<!---->
</a>
<h3>Method Detail</h3>
<aname="isValid--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>isValid</h4>
<pre>public boolean isValid()</pre>
<divclass="block">Gets if the packet is valid.</div>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#isValid--">isValid</a></code> in interface <code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>Is the packet valid?</dd>
</dl>
</li>
</ul>
<aname="getProtocol--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getProtocol</h4>
<pre>public <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html"title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a> getProtocol()</pre>
<divclass="block">Gets the protocol information.</div>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</a></code> in interface <code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>The protocol information.</dd>
</dl>
</li>
</ul>
<aname="getTheProtocol--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getTheProtocol</h4>
<pre>public static <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html"title="class in com.captainalm.lib.calmnet.packet">PacketProtocolInformation</a> getTheProtocol()</pre>
<divclass="block">Gets the protocol information statically.</div>
<dl>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>The protocol information.</dd>
</dl>
</li>
</ul>
<aname="savePayload--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>savePayload</h4>
<pre>public byte[] savePayload()
throws <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<divclass="block">Saves the packet payload to a byte array.</div>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#savePayload--">savePayload</a></code> in interface <code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>The packet payload data.</dd>
<dt><spanclass="throwsLabel">Throws:</span></dt>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - An Exception has occurred.</dd>
throws <ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<divclass="block">Loads the packet payload from save data.</div>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#loadPayload-byte:A-">loadPayload</a></code> in interface <code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html"title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><spanclass="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</dd>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html"title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<aname="isUpgrade--">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>isUpgrade</h4>
<pre>public boolean isUpgrade()</pre>
<divclass="block">Gets if the packet is treated as a stream upgrade or
a change in packet use for <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
<divclass="block">Sets if the packet is treated as a stream upgrade or
a change in packet use for <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/EncryptedPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>EncryptedPacket</code></a> and <ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/Base64Packet.html"title="class in com.captainalm.lib.calmnet.packet.core"><code>Base64Packet</code></a>.</div>
<dd><code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html#isAcknowledgement--">isAcknowledgement</a></code> in interface <code><ahref="../../../../../../com/captainalm/lib/calmnet/packet/IAcknowledgement.html"title="interface in com.captainalm.lib.calmnet.packet">IAcknowledgement</a></code></dd>
<dt><spanclass="returnLabel">Returns:</span></dt>
<dd>If the class instance is an Acknowledgement.</dd>
<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkEncryptionCipherPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><spanclass="typeNameLink">Prev Class</span></a></li>
<li><ahref="../../../../../../com/captainalm/lib/calmnet/packet/core/NetworkIdentifierPacket.html"title="class in com.captainalm.lib.calmnet.packet.core"><spanclass="typeNameLink">Next Class</span></a></li>