Package org.metricshub.ipmi.core.coding.protocol

Class Ipmiv20Message

java.lang.Object

org.metricshub.ipmi.core.coding.protocol.IpmiMessage

org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message

public class Ipmiv20Message
extends IpmiMessage

Wrapper class for IPMI v2.0 message

Constructor Summary

Constructors

Constructor	Description
Ipmiv20Message(ConfidentialityAlgorithm confidentialityAlgorithm)

Method Summary

Modifier and Type	Method	Description
byte[]	getIntegrityAlgorithmBase(IpmiEncoder encoder)	Gets base for integrity algorithm calculations.
int	getOemIANA()
Object	getOemPayloadID()
PayloadType	getPayloadType()
boolean	isPayloadAuthenticated()
boolean	isPayloadEncrypted()
void	setOemIANA(int oemIANA)
void	setOemPayloadID(Object oemPayloadID)
void	setPayloadAuthenticated(boolean payloadAuthenticated)
void	setPayloadEncrypted(boolean payloadEncrypted)
void	setPayloadType(PayloadType payloadType)

Methods inherited from class org.metricshub.ipmi.core.coding.protocol.IpmiMessage

getAuthCode, getAuthenticationType, getConfidentialityAlgorithm, getPayload, getPayloadLength, getSessionID, getSessionSequenceNumber, setAuthCode, setAuthenticationType, setConfidentialityAlgorithm, setPayload, setPayloadLength, setSessionID, setSessionSequenceNumber

Methods inherited from class java.lang.Object

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

Constructor Details

Ipmiv20Message

public Ipmiv20Message(ConfidentialityAlgorithm confidentialityAlgorithm)

Method Details

setPayloadEncrypted

public void setPayloadEncrypted(boolean payloadEncrypted)

isPayloadEncrypted

public boolean isPayloadEncrypted()

setPayloadAuthenticated

public void setPayloadAuthenticated(boolean payloadAuthenticated)

isPayloadAuthenticated

public boolean isPayloadAuthenticated()

setPayloadType

public void setPayloadType(PayloadType payloadType)

getPayloadType

public PayloadType getPayloadType()

setOemIANA

public void setOemIANA(int oemIANA)

getOemIANA

public int getOemIANA()

setOemPayloadID

public void setOemPayloadID(Object oemPayloadID)

getOemPayloadID

public Object getOemPayloadID()

getIntegrityAlgorithmBase

public byte[] getIntegrityAlgorithmBase(IpmiEncoder encoder)
                                 throws InvalidKeyException

Gets base for integrity algorithm calculations. If used for the message being created, does not contain AuthCode field so amount of Integrity Pad bytes cannot be calculated. Therefore integrity algorithms using this base must add proper amount of the Integrity Pad bytes and modify the Pad Length byte.

Parameters:

encoder - - IpmiEncoder to be used to convert message to byte array format. Must be able to handle null authCode field with isPayloadAuthenticated() == true since this method is used in its generation.

Returns:

base for integrity algorithm calculations

Throws:

InvalidKeyException - - when initiation of the confidentiality algorithm fails