public class EncryptedPacket extends java.lang.Object implements IStreamedPacket, IInternalCache
IPacket
.
Major ID: 255 Minor ID: 252
Constructor and Description |
---|
EncryptedPacket(IPacketFactory factory,
PacketLoader loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory)
Constructs a new EncryptedPacket with the specified
IPacketFactory , PacketLoader and ICipherFactory . |
EncryptedPacket(IPacketFactory factory,
PacketLoader loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
boolean useCache)
Constructs a new EncryptedPacket with the specified
IPacketFactory , PacketLoader , ICipherFactory
and if the encrypted data should be cached. |
EncryptedPacket(IPacketFactory factory,
PacketLoader loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
IPacket packet)
Constructs a new EncryptedPacket with the specified
IPacketFactory , PacketLoader , ICipherFactory and IPacket . |
EncryptedPacket(IPacketFactory factory,
PacketLoader loader,
com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory,
IPacket packet,
boolean useCache)
Constructs a new EncryptedPacket with the specified
IPacketFactory , PacketLoader , ICipherFactory ,
IPacket and if the encrypted data should be cached. |
Modifier and Type | Method and Description |
---|---|
com.captainalm.lib.stdcrypt.encryption.ICipherFactory |
getCipherFactory()
Gets the
ICipherFactory being used. |
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.
|
java.lang.String |
getTrailingPassword()
Gets the trailing password (Or null if no trailing password).
|
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 |
setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory)
Sets the
ICipherFactory being used. |
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 |
setTrailingPassword(java.lang.String trailingPassword)
Sets the trailing password (Use null for no trailing password).
|
void |
writeData(java.io.InputStream inputStream,
int size)
Writes payload data from an
InputStream . |
public EncryptedPacket(IPacketFactory factory, PacketLoader loader, com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory)
IPacketFactory
, PacketLoader
and ICipherFactory
.
The encrypted data will not be cached.factory
- The packet factory to use.loader
- The Packet Loader to use.cipherFactory
- The cipher factory to use.java.lang.NullPointerException
- factory, loader or cipherFactory is null.public EncryptedPacket(IPacketFactory factory, PacketLoader loader, com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory, boolean useCache)
IPacketFactory
, PacketLoader
, ICipherFactory
and if the encrypted data should be cached.factory
- The packet factory to use.loader
- The Packet Loader to use.cipherFactory
- The cipher factory to use.useCache
- If the encrypted data should be cached.java.lang.NullPointerException
- factory, loader or cipherFactory is null.public EncryptedPacket(IPacketFactory factory, PacketLoader loader, com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory, IPacket packet)
IPacketFactory
, PacketLoader
, ICipherFactory
and IPacket
.
The encrypted data will not be cached.factory
- The packet factory to use.loader
- The Packet Loader to use.cipherFactory
- The cipher factory to use.packet
- The packet to use.java.lang.NullPointerException
- factory, loader or cipherFactory is null.public EncryptedPacket(IPacketFactory factory, PacketLoader loader, com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory, IPacket packet, boolean useCache)
IPacketFactory
, PacketLoader
, ICipherFactory
,
IPacket
and if the encrypted data should be cached.factory
- The packet factory to use.loader
- The Packet Loader to use.cipherFactory
- The cipher factory to use.packet
- The packet to use.useCache
- If the encrypted data should be cached.java.lang.NullPointerException
- factory, loader or cipherFactory is null.public boolean isValid()
public PacketProtocolInformation getProtocol()
getProtocol
in interface IPacket
public static PacketProtocolInformation getTheProtocol()
public byte[] savePayload() throws PacketException
savePayload
in interface IPacket
PacketException
- An Exception has occurred.public void loadPayload(byte[] packetData) throws PacketException
loadPayload
in interface IPacket
packetData
- The packet payload data.java.lang.NullPointerException
- The new store data is null.PacketException
- An Exception has occurred.public void readData(java.io.OutputStream outputStream) throws java.io.IOException, PacketException
OutputStream
.readData
in interface IStreamedPacket
outputStream
- The output stream to read data to.java.lang.NullPointerException
- outputStream is null.java.io.IOException
- An IO Exception has occurred.PacketException
- An Exception has occurred.public void writeData(java.io.InputStream inputStream, int size) throws java.io.IOException, PacketException
InputStream
.writeData
in interface IStreamedPacket
inputStream
- The input stream to write data from.size
- The size of the input payload in bytes.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.public int getSize() throws PacketException
getSize
in interface IStreamedPacket
PacketException
- An Exception has occurred.public PacketLoader getPacketLoader()
PacketLoader
in use.public void setPacketLoader(PacketLoader loader)
PacketLoader
to use.loader
- The Packet Loader to use.java.lang.NullPointerException
- loader is null.public IPacketFactory getFactory()
IPacketFactory
in use.public void setFactory(IPacketFactory factory)
IPacketFactory
to use.factory
- The Packet Factory to use.java.lang.NullPointerException
- factory is null.public com.captainalm.lib.stdcrypt.encryption.ICipherFactory getCipherFactory()
ICipherFactory
being used.public void setCipherFactory(com.captainalm.lib.stdcrypt.encryption.ICipherFactory cipherFactory)
ICipherFactory
being used.cipherFactory
- The Cipher Factory.java.lang.NullPointerException
- cipherFactory is null.public java.lang.String getTrailingPassword()
public void setTrailingPassword(java.lang.String trailingPassword)
trailingPassword
- The new trailing password or null.public IPacket getHeldPacket()
public void setHeldPacket(IPacket packet)
packet
- The new packet or null.public boolean isCacheUsed()
isCacheUsed
in interface IInternalCache
public void setCacheUsed(boolean used)
setCacheUsed
in interface IInternalCache
used
- If the encrypted data should be cached.