Package org.metricshub.ipmi.core.coding.commands

Class IpmiCommandCoder

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder

Direct Known Subclasses:

ActivatePayload, ChassisControl, CloseSession, DeactivatePayload, GetChannelAuthenticationCapabilities, GetChannelCipherSuites, GetChannelPayloadSupport, GetChassisStatus, GetFruInventoryAreaInfo, GetPayloadActivationStatus, GetSdr, GetSdrRepositoryInfo, GetSelEntry, GetSelInfo, GetSensorReading, OpenSession, Rakp1, Rakp3, ReadFruData, ReserveSdrRepository, ReserveSel, SetSessionPrivilegeLevel

public abstract class IpmiCommandCoder
extends PayloadCoder

A wrapper for IPMI command. Parameterless constructors in classes derived from IpmiCommandCoder are meant to be used for decoding. To avoid omitting setting an important parameter when encoding message use parametered constructors rather than the parameterless ones.

Constructor Summary

Constructors

Constructor	Description
IpmiCommandCoder()
IpmiCommandCoder(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType)

Method Summary

Modifier and Type	Method	Description
abstract byte	getCommandCode()	Retrieves command code specific for command represented by this class
abstract NetworkFunction	getNetworkFunction()	Retrieves network function specific for command represented by this class.
PayloadType	getSupportedPayloadType()
boolean	isCommandResponse(IpmiMessage message)	Checks if given message contains response command specific for this class.

Methods inherited from class org.metricshub.ipmi.core.coding.PayloadCoder

encodePayload, getAuthenticationType, getCipherSuite, getIpmiVersion, getResponseData, setAuthenticationType, setCipherSuite, setIpmiVersion, setSessionParameters

Methods inherited from class java.lang.Object

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

Constructor Details

IpmiCommandCoder

public IpmiCommandCoder()

IpmiCommandCoder

public IpmiCommandCoder(IpmiVersion version,
 CipherSuite cipherSuite,
 AuthenticationType authenticationType)

Method Details

getSupportedPayloadType

public PayloadType getSupportedPayloadType()

Specified by:

getSupportedPayloadType in class PayloadCoder

isCommandResponse

public boolean isCommandResponse(IpmiMessage message)

Checks if given message contains response command specific for this class.

Parameters:

message - IpmiMessage wrapping the IPMI message

Returns:

True if message contains response command specific for this class, false otherwise.

getCommandCode

public abstract byte getCommandCode()

Retrieves command code specific for command represented by this class

Returns:

command code

getNetworkFunction

public abstract NetworkFunction getNetworkFunction()

Retrieves network function specific for command represented by this class.

Returns:

network function

See Also:

• NetworkFunction