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<GetSdrResponseData>

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

Direct Known Subclasses:

GetDeviceSdr

public class GetSdr
extends IpmiCommandCoder<GetSdrResponseData>

Wrapper for Get SDR command.

Constructor Summary

Constructors

Constructor	Description
GetSdr(int reservationId, int recordId)	Initiates GetSdr for both encoding and decoding.
GetSdr(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.
GetSdrResponseData	getResponseData(IpmiMessage message)	Retrieves payload-specific response data from IPMI message

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

answers, getNetworkFunctionCode, 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(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:

reservationId - - SDR reservation ID received via ReserveSdrRepository command

recordId - - ID of the record to get

GetSdr

public GetSdr(int reservationId,
 int recordId,
 int offset,
 int bytesToRead)

Initiates GetSdr for both encoding and decoding.

Parameters:

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<GetSdrResponseData>

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<GetSdrResponseData>

Returns:

network function, or null for a command of a network function NetworkFunction does not list, which overrides IpmiCommandCoder.getNetworkFunctionCode() instead

See Also:

• NetworkFunction

getResponseData

public GetSdrResponseData 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 IpmiCommandCoder<GetSdrResponseData>

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