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

Class GetChannelPayloadSupport

java.lang.Object

org.sentrysoftware.ipmi.core.coding.PayloadCoder

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

org.sentrysoftware.ipmi.core.coding.commands.payload.GetChannelPayloadSupport

public class GetChannelPayloadSupport
extends IpmiCommandCoder

A wrapper class for Get Channel Payload Support Command.

Constructor Summary

Constructors

Constructor	Description
GetChannelPayloadSupport()	Initiates class for decoding.
GetChannelPayloadSupport(byte channelNumber)	Initiates class for both encoding and decoding.
GetChannelPayloadSupport(byte channelNumber, CipherSuite cipherSuite, AuthenticationType authenticationType)	Initiates class for both encoding and decoding.

Method Summary

Modifier and Type	Method	Description
byte	getChannelNumber()
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
void	setChannelNumber(int channelNumber)	Sets the channel number that will be put into IPMI command.

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

GetChannelPayloadSupport

public GetChannelPayloadSupport()

Initiates class for decoding.

GetChannelPayloadSupport

public GetChannelPayloadSupport(byte channelNumber)

Initiates class for both encoding and decoding.

Parameters:

channelNumber - - must be 0h-Bh or Eh-Fh
Eh = retrieve information for channel this request was issued on

GetChannelPayloadSupport

public GetChannelPayloadSupport(byte channelNumber,
 CipherSuite cipherSuite,
 AuthenticationType authenticationType)

Initiates class for both encoding and decoding.

Parameters:

channelNumber - - must be 0h-Bh or Eh-Fh
Eh = retrieve information for channel this request was issued on

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

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

Method Details

getChannelNumber

public byte getChannelNumber()

setChannelNumber

public void setChannelNumber(int channelNumber)

Sets the channel number that will be put into IPMI command.

Parameters:

channelNumber - - must be 0h-Bh or Eh-Fh
Eh = retrieve information for channel this request was issued on

Throws:

IllegalArgumentException

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