com.captainalm.lib.calmnet.packet.core

Class Base64Packet

java.lang.Object

com.captainalm.lib.calmnet.packet.core.Base64Packet

All Implemented Interfaces:

IPacket, IStreamedPacket

public class Base64Packet
extends java.lang.Object
implements IStreamedPacket

This class provides a base64 encrypted packet that can hold an IPacket.

Major ID: 255 Minor ID: 251

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
Base64Packet(IPacketFactory factory, PacketLoader loader) Constructs a new Base64Packet with the specified IPacketFactory and PacketLoader.
Base64Packet(IPacketFactory factory, PacketLoader loader, boolean useCache) Constructs a new Base64Packet with the specified IPacketFactory, PacketLoader and if the encrypted data should be cached.
Base64Packet(IPacketFactory factory, PacketLoader loader, IPacket packet) Constructs a new Base64Packet with the specified IPacketFactory, PacketLoader and IPacket.
Base64Packet(IPacketFactory factory, PacketLoader loader, IPacket packet, boolean useCache) Constructs a new Base64Packet with the specified IPacketFactory, PacketLoader, IPacket and if the encrypted data should be cached.

Method Summary

Modifier and Type	Method and Description
IPacketFactory	getFactory() Gets the IPacketFactory in use.
IPacket	getHeldPacket() Gets the held packet or null.
PacketLoader	getPacketLoader() Gets the PacketLoader in use.
PacketProtocolInformation	getProtocol() Gets the protocol information.
int	getSize() Gets the size of the output data.
static PacketProtocolInformation	getTheProtocol() Gets the protocol information statically.
boolean	isCacheUsed() Gets if the encrypted data 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 encrypted data is cached.
void	setFactory(IPacketFactory factory) Sets the IPacketFactory to use.
void	setHeldPacket(IPacket packet) Sets the held packet.
void	setPacketLoader(PacketLoader loader) Sets the PacketLoader to use.
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

Base64Packet

public Base64Packet(IPacketFactory factory,
                    PacketLoader loader)

Constructs a new Base64Packet with the specified IPacketFactory and PacketLoader. The encrypted data will not be cached.

Parameters:

factory - The packet factory to use.

loader - The Packet Loader to use.

Throws:

java.lang.NullPointerException - factory or loader is null.

Base64Packet

public Base64Packet(IPacketFactory factory,
                    PacketLoader loader,
                    boolean useCache)

Constructs a new Base64Packet with the specified IPacketFactory, PacketLoader and if the encrypted data should be cached.

Parameters:

factory - The packet factory to use.

loader - The Packet Loader to use.

useCache - If the encrypted data should be cached.

Throws:

java.lang.NullPointerException - factory or loader is null.

Base64Packet

public Base64Packet(IPacketFactory factory,
                    PacketLoader loader,
                    IPacket packet)

Constructs a new Base64Packet with the specified IPacketFactory, PacketLoader and IPacket. The encrypted data will not be cached.

Parameters:

factory - The packet factory to use.

loader - The Packet Loader to use.

packet - The packet to store or null.

Throws:

java.lang.NullPointerException - factory or loader is null.

Base64Packet

public Base64Packet(IPacketFactory factory,
                    PacketLoader loader,
                    IPacket packet,
                    boolean useCache)

Constructs a new Base64Packet with the specified IPacketFactory, PacketLoader, IPacket and if the encrypted data should be cached.

Parameters:

factory - The packet factory to use.

loader - The Packet Loader to use.

packet - The packet to store or null.

useCache - If the encrypted data should be cached.

Throws:

java.lang.NullPointerException - factory or loader is 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.

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.

getPacketLoader

public PacketLoader getPacketLoader()

Gets the PacketLoader in use.

Returns:

The Packet Loader in use.

setPacketLoader

public void setPacketLoader(PacketLoader loader)

Sets the PacketLoader to use.

Parameters:

loader - The Packet Loader to use.

Throws:

java.lang.NullPointerException - loader is null.

getFactory

public IPacketFactory getFactory()

Gets the IPacketFactory in use.

Returns:

The Packet Factory in use.

setFactory

public void setFactory(IPacketFactory factory)

Sets the IPacketFactory to use.

Parameters:

factory - The Packet Factory to use.

Throws:

java.lang.NullPointerException - factory is null.

getHeldPacket

public IPacket getHeldPacket()

Gets the held packet or null.

Returns:

The packet or null.

setHeldPacket

public void setHeldPacket(IPacket packet)

Sets the held packet.

Parameters:

packet - The new packet or null.

isCacheUsed

public boolean isCacheUsed()

Gets if the encrypted data is cached.

Returns:

If the encrypted data is cached.

setCacheUsed

public void setCacheUsed(boolean used)

Sets if the encrypted data is cached.

Parameters:

used - If the encrypted data should be cached.