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

Class GetFruInventoryAreaInfo

java.lang.Object

org.sentrysoftware.ipmi.core.coding.PayloadCoder

org.sentrysoftware.ipmi.core.coding.commands.IpmiCommandCoder

org.sentrysoftware.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfo

public class GetFruInventoryAreaInfo
extends IpmiCommandCoder

A wrapper class for Get FRU Inventory Area Info Command.

Constructor Summary

Constructors

Constructor	Description
GetFruInventoryAreaInfo(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType, int fruId)	Initiates GetFruInventoryAreaInfo 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.sentrysoftware.ipmi.core.coding.commands.IpmiCommandCoder

getSupportedPayloadType, isCommandResponse

Methods inherited from class org.sentrysoftware.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

GetFruInventoryAreaInfo

public GetFruInventoryAreaInfo(IpmiVersion version,
 CipherSuite cipherSuite,
 AuthenticationType authenticationType,
 int fruId)

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

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