com.captainalm.lib.calmnet.packet.core

Class NetworkEncryptionCipherPacket

java.lang.Object

com.captainalm.lib.calmnet.packet.core.NetworkEncryptionCipherPacket

All Implemented Interfaces:

IAcknowledgement, IInternalCache, IPacket, IStreamedPacket

public class NetworkEncryptionCipherPacket
extends java.lang.Object
implements IStreamedPacket, IAcknowledgement, IInternalCache

This class provides the ability for supporting streams to negotiate a cipher.

Major ID: 255 Minor ID: 250

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
NetworkEncryptionCipherPacket(java.lang.Boolean acknowledgement, java.lang.String[] cipherNames) Constructs a new instance of NetworkEncryptionCipherPacket with the specified acknowledgement value and the specified ciphers.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCiphers() Gets the cipher names this packet contains.
PacketProtocolInformation	getProtocol() Gets the protocol information.
int	getSize() Gets the size of the output data.
static PacketProtocolInformation	getTheProtocol() Gets the protocol information statically.
boolean	isAcknowledgement() Gets if the class instance is an Acknowledgement.
boolean	isCacheUsed() Gets if the cipher information is cached.
boolean	isValid() Gets if the packet is valid.
void	loadPayload(byte[] packetData) Loads the packet payload from save data.
void	readData(java.io.OutputStream outputStream) Reads payload data to an OutputStream.
byte[]	savePayload() Saves the packet payload to a byte array.
void	setCacheUsed(boolean used) Sets if the cipher information is cached.
void	setCiphers(java.lang.String[] cipherNames) Sets the cipher names this packet contains.
void	writeData(java.io.InputStream inputStream, int size) Writes payload data from an InputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkEncryptionCipherPacket

public NetworkEncryptionCipherPacket(java.lang.Boolean acknowledgement,
                                     java.lang.String[] cipherNames)

Constructs a new instance of NetworkEncryptionCipherPacket with the specified acknowledgement value and the specified ciphers.

Parameters:

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

cipherNames - The cipher names.

Throws:

java.lang.NullPointerException - cipherNames is null.

Method Detail

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.

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.

readData

public void readData(java.io.OutputStream outputStream)
              throws java.io.IOException,
                     PacketException

Reads payload data to an OutputStream.

Specified by:

readData in interface IStreamedPacket

Parameters:

outputStream - The output stream to read data to.

Throws:

java.lang.NullPointerException - outputStream is null.

java.io.IOException - An IO Exception has occurred.

PacketException - An Exception has occurred.

writeData

public void writeData(java.io.InputStream inputStream,
                      int size)
               throws java.io.IOException,
                      PacketException

Writes payload data from an InputStream.

Specified by:

writeData in interface IStreamedPacket

Parameters:

inputStream - The input stream to write data from.

size - The size of the input payload in bytes.

Throws:

java.lang.NullPointerException - inputStream is null.

java.lang.IllegalArgumentException - size is less than 0.

java.io.IOException - An IO Exception has occurred.

PacketException - An Exception has occurred.

getSize

public int getSize()
            throws PacketException

Gets the size of the output data.

Specified by:

getSize in interface IStreamedPacket

Returns:

The size of the output data in bytes.

Throws:

PacketException - An Exception has occurred.

getCiphers

public java.lang.String[] getCiphers()

Gets the cipher names this packet contains.

Returns:

An array of cipher names.

setCiphers

public void setCiphers(java.lang.String[] cipherNames)

Sets the cipher names this packet contains.

Parameters:

cipherNames - The array of cipher names.

Throws:

java.lang.NullPointerException - cipherNames is null.

isCacheUsed

public boolean isCacheUsed()

Gets if the cipher information is cached.

Specified by:

isCacheUsed in interface IInternalCache

Returns:

If the cipher information is cached.

setCacheUsed

public void setCacheUsed(boolean used)

Sets if the cipher information is cached.

Specified by:

setCacheUsed in interface IInternalCache

Parameters:

used - If the cipher information is cached.