com.captainalm.lib.calmnet.packet.core

Class NetworkSSLUpgradePacket

java.lang.Object

com.captainalm.lib.calmnet.packet.core.NetworkSSLUpgradePacket

All Implemented Interfaces:

IAcknowledgement, IPacket

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

This class provides the ability for supporting streams to upgrade to using SSL connections.

Major ID: 255 Minor ID: 254

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
NetworkSSLUpgradePacket(java.lang.Boolean acknowledgement) Constructs a new NetworkSSLUpgrade packet with the specified acknowledgement value.

Method Summary

Modifier and Type	Method and Description
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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkSSLUpgradePacket

public NetworkSSLUpgradePacket(java.lang.Boolean acknowledgement)

Constructs a new NetworkSSLUpgrade packet with the specified acknowledgement value.

Parameters:

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

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.

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.