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

Class ReadFruData

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

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

org.metricshub.ipmi.core.coding.commands.fru.ReadFruData

public class ReadFruData
extends IpmiCommandCoder

A wrapper class for Read FRU Data Command request.
The command returns the specified data from the FRU Inventory Info area.

Constructor Summary

Constructors

Constructor	Description
ReadFruData(int fruId, BaseUnit unit, int offset, int countToRead)	Initiates ReadFruData for both encoding and decoding.
ReadFruData(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType, int fruId, BaseUnit unit, int offset, int countToRead)	Initiates ReadFruData for both encoding and decoding.

Method Summary

Modifier and Type	Method	Description
static List<FruRecord>	decodeFruData(List<ReadFruDataResponseData> fruData)	Decodes FruRecords from data provided by ReadFruData command.
byte	getCommandCode()	Retrieves command code specific for command represented by this class
NetworkFunction	getNetworkFunction()	Retrieves network function specific for command represented by this class.
ResponseData	getResponseData(IpmiMessage message)	Retrieves payload-specific response data from IPMI message

Methods inherited from class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder

getSupportedPayloadType, isCommandResponse

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ReadFruData

public ReadFruData(int fruId,
 BaseUnit unit,
 int offset,
 int countToRead)

Initiates ReadFruData for both encoding and decoding. Sets session parameters to default.

Parameters:

fruId - - ID of the FRU to get info from. Must be less than 256. To get FRU ID use GetSdr to retrieve FruDeviceLocatorRecord.

unit - - BaseUnit indicating if the FRU device is accessed in BaseUnit.Bytes or BaseUnit.Words

offset - - offset to read in units specified by unit

countToRead - - size of the area to read in unit. Cannot exceed 255;

See Also:

• PayloadCoder.setSessionParameters(IpmiVersion, CipherSuite, AuthenticationType)

ReadFruData

public ReadFruData(IpmiVersion version,
 CipherSuite cipherSuite,
 AuthenticationType authenticationType,
 int fruId,
 BaseUnit unit,
 int offset,
 int countToRead)

Initiates ReadFruData for both encoding and decoding.

Parameters:

version - - IPMI version of the command.

cipherSuite - - CipherSuite containing authentication, confidentiality and integrity algorithms for this session.

authenticationType - - Type of authentication used. Must be RMCPPlus for IPMI v2.0.

fruId - - ID of the FRU to get info from. Must be less than 256. To get FRU ID use GetSdr to retrieve FruDeviceLocatorRecord.

unit - - BaseUnit indicating if the FRU device is accessed in BaseUnit.Bytes or BaseUnit.Words

offset - - offset to read in units specified by unit

countToRead - - size of the area to read in unit. Cannot exceed 255;

Method Details

getCommandCode

public byte getCommandCode()

Description copied from class: IpmiCommandCoder

Retrieves command code specific for command represented by this class

Specified by:

getCommandCode in class IpmiCommandCoder

Returns:

command code

getNetworkFunction

public NetworkFunction getNetworkFunction()

Description copied from class: IpmiCommandCoder

Retrieves network function specific for command represented by this class.

Specified by:

getNetworkFunction in class IpmiCommandCoder

Returns:

network function

See Also:

• NetworkFunction

getResponseData

public ResponseData getResponseData(IpmiMessage message)
                             throws IPMIException,
NoSuchAlgorithmException,
InvalidKeyException

Description copied from class: PayloadCoder

Retrieves payload-specific response data from IPMI message

Specified by:

getResponseData in class PayloadCoder

Parameters:

message - - IPMI message

Returns:

response data

Throws:

IPMIException - when response completion code isn't OK.

NoSuchAlgorithmException - when authentication, confidentiality or integrity algorithm fails.

InvalidKeyException - when creating of the authentication algorithm key fails

decodeFruData

public static List<FruRecord> decodeFruData(List<ReadFruDataResponseData> fruData)

Decodes FruRecords from data provided by ReadFruData command. Size of the FRU Inventory Area might exceed size of the communication packet so it might come in many ReadFruDataResponseData packets.

Parameters:

fruData - - list of ReadFruDataResponseData containing FRU data

Returns:

list of FruRecords containing decoded FRU data.