com.captainalm.lib.calmnet.packet.core

Class NetworkEncryptionUpgradePacket

java.lang.Object

com.captainalm.lib.calmnet.packet.core.NetworkEncryptionUpgradePacket

All Implemented Interfaces:

IAcknowledgement, IPacket

public class NetworkEncryptionUpgradePacket
extends java.lang.Object
implements IPacket, IAcknowledgement

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 Base64Packets or EncryptedPackets.

Major ID: 255 Minor ID: 253

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
NetworkEncryptionUpgradePacket(java.lang.Boolean acknowledgement, boolean upgrade, boolean base64ed, com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory) Constructs a new NetworkEncryptionUpgradePacket with the specified acknowledgement value, upgrade value, base 64 value and ICipherFactory.

Method Summary

Modifier and Type	Method and Description
boolean	areSecretsSent() Gets if secrets are sent as part of cipher settings.
com.captainalm.lib.stdcrypt.encryption.ICipherFactory	getCipherFactory() Gets the ICipherFactory being used or null.
PacketProtocolInformation	getProtocol() Gets the protocol information.
static PacketProtocolInformation	getTheProtocol() Gets the protocol information statically.
boolean	isAcknowledgement() Gets if the class instance is an Acknowledgement.
boolean	isBase64ed() Gets if base 64 is used.
boolean	isUpgrade() Gets if the packet is treated as a stream upgrade or a change in packet use for EncryptedPacket and Base64Packet.
boolean	isValid() Gets if the packet is valid.
void	loadPayload(byte[] packetData) Loads the packet payload from save data.
byte[]	savePayload() Saves the packet payload to a byte array.
void	setBase64ed(boolean base64ed) Sets if base64 is used.
void	setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory) Sets the ICipherFactory being used.
void	setIfSecretsSent(boolean sendSecrets) Sets if secrets should be sent as part of cipher settings.
void	setUpgrade(boolean upgrade) Sets if the packet is treated as a stream upgrade or a change in packet use for EncryptedPacket and Base64Packet.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetworkEncryptionUpgradePacket

public NetworkEncryptionUpgradePacket(java.lang.Boolean acknowledgement,
                                      boolean upgrade,
                                      boolean base64ed,
                                      com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory)

Constructs a new NetworkEncryptionUpgradePacket with the specified acknowledgement value, upgrade value, base 64 value and ICipherFactory.

Parameters:

acknowledgement - The acknowledgement value to use (Can be null).

upgrade - Is the packet treated as a stream upgrade, See: isUpgrade().

base64ed - Is the packet signalling base 64 to be used.

cipherFactory - The cipherFactory to signal for use.

Method Detail

isValid

public boolean isValid()

Gets if the packet is valid.

Specified by:

isValid in interface IPacket

Returns:

Is the packet valid?

getProtocol

public PacketProtocolInformation getProtocol()

Gets the protocol information.

Specified by:

getProtocol in interface IPacket

Returns:

The protocol information.

getTheProtocol

public static PacketProtocolInformation getTheProtocol()

Gets the protocol information statically.

Returns:

The protocol information.

savePayload

public byte[] savePayload()
                   throws PacketException

Saves the packet payload to a byte array.

Specified by:

savePayload in interface IPacket

Returns:

The packet payload data.

Throws:

PacketException - An Exception has occurred.

loadPayload

public void loadPayload(byte[] packetData)
                 throws PacketException

Loads the packet payload from save data.

Specified by:

loadPayload in interface IPacket

Parameters:

packetData - The packet payload data.

Throws:

java.lang.NullPointerException - The new store data is null.

PacketException - An Exception has occurred.

isUpgrade

public boolean isUpgrade()

Gets if the packet is treated as a stream upgrade or a change in packet use for EncryptedPacket and Base64Packet.

Returns:

If the packet is a stream upgrade.

setUpgrade

public void setUpgrade(boolean upgrade)

Sets if the packet is treated as a stream upgrade or a change in packet use for EncryptedPacket and Base64Packet.

Parameters:

upgrade - If the packet is a stream upgrade.

isBase64ed

public boolean isBase64ed()

Gets if base 64 is used. (This is not for this packet, it is part of the upgrade attributes.)

Returns:

If base 64 is used.

setBase64ed

public void setBase64ed(boolean base64ed)

Sets if base64 is used. (This is not for this packet, it is part of the upgrade attributes.)

Parameters:

base64ed - If base 64 is to be used.

getCipherFactory

public com.captainalm.lib.stdcrypt.encryption.ICipherFactory getCipherFactory()

Gets the ICipherFactory being used or null.

Returns:

The Cipher Factory or null.

setCipherFactory

public void setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory)

Sets the ICipherFactory being used.

Parameters:

cipherFactory - The Cipher Factory or null.

isAcknowledgement

public boolean isAcknowledgement()

Gets if the class instance is an Acknowledgement.

Specified by:

isAcknowledgement in interface IAcknowledgement

Returns:

If the class instance is an Acknowledgement.

areSecretsSent

public boolean areSecretsSent()

Gets if secrets are sent as part of cipher settings.

Returns:

If the secrets are part of the cipher settings.

setIfSecretsSent

public void setIfSecretsSent(boolean sendSecrets)

Sets if secrets should be sent as part of cipher settings.

Parameters:

sendSecrets - If secrets are part of the cipher settings.