Package org.metricshub.ipmi.core.coding.payload

Class IpmiPayload

java.lang.Object

org.metricshub.ipmi.core.coding.payload.IpmiPayload

Direct Known Subclasses:

IpmiLanMessage, PlainMessage, SolMessage

public abstract class IpmiPayload
extends Object

Payload for IPMI messages

Constructor Summary

Constructors

Constructor	Description
IpmiPayload()

Method Summary

Modifier and Type	Method	Description
void	encryptPayload(ConfidentialityAlgorithm confidentialityAlgorithm)	Encrypts getPayloadData().
byte[]	getData()
byte[]	getEncryptedPayload()	Returns encrypted payload encoded in byte array.
abstract byte[]	getIpmiCommandData()	Returns IPMI command encapsulated in IPMI Payload.
abstract byte[]	getPayloadData()	Returns unencrypted payload encoded in byte array (owner is responsible for encryption).
abstract int	getPayloadLength()	Returns encoded but UNENCRYPTED payload length.
void	setData(byte[] data)

Methods inherited from class java.lang.Object

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

Constructor Details

IpmiPayload

public IpmiPayload()

Method Details

setData

public void setData(byte[] data)

getData

public byte[] getData()

getEncryptedPayload

public byte[] getEncryptedPayload()

Returns encrypted payload encoded in byte array. Migth be null if payload was not yet encrypted.

See Also:

• encryptPayload(ConfidentialityAlgorithm)

getPayloadData

public abstract byte[] getPayloadData()

Returns unencrypted payload encoded in byte array (owner is responsible for encryption).

Returns:

payload

getPayloadLength

public abstract int getPayloadLength()

Returns encoded but UNENCRYPTED payload length.

getIpmiCommandData

public abstract byte[] getIpmiCommandData()

Returns IPMI command encapsulated in IPMI Payload.

encryptPayload

public void encryptPayload(ConfidentialityAlgorithm confidentialityAlgorithm)
                    throws InvalidKeyException

Encrypts getPayloadData().

Parameters:

confidentialityAlgorithm - ConfidentialityAlgorithm to be used to encrypt payload data.

Throws:

InvalidKeyException - - when confidentiality algorithm fails.

See Also:

• getEncryptedPayload()