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

Class GetSdr

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

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

org.metricshub.ipmi.core.coding.commands.sdr.GetSdr

public class GetSdr
extends IpmiCommandCoder

Wrapper for Get SDR command.

Constructor Summary

Constructors

Constructor	Description
GetSdr(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType, int reservationId, int recordId)	Initiates GetSdr for both encoding and decoding.
GetSdr(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType, int reservationId, int recordId, int offset, int bytesToRead)	Initiates GetSdr for both encoding and decoding.

Method Summary

Modifier and Type	Method	Description
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

GetSdr

public GetSdr(IpmiVersion version,
 CipherSuite cipherSuite,
 AuthenticationType authenticationType,
 int reservationId,
 int recordId)

Initiates GetSdr for both encoding and decoding. 'Offset info record' and 'bytes to read' fields are set to read whole record.

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.

reservationId - - SDR reservation ID received via ReserveSdrRepository command

recordId - - ID of the record to get

GetSdr

public GetSdr(IpmiVersion version,
 CipherSuite cipherSuite,
 AuthenticationType authenticationType,
 int reservationId,
 int recordId,
 int offset,
 int bytesToRead)

Initiates GetSdr 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.

reservationId - - SDR reservation ID received via ReserveSdrRepository command

recordId - - ID of the record to get

offset - - the offset into record, at which reading should be started

bytesToRead - - number of bytes to read

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