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

Class GetChannelCipherSuites

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

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

org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites

public class GetChannelCipherSuites
extends IpmiCommandCoder

Wrapper for RMCP+ Get Channel Cipher Suites command. This command can be executed prior to establishing a session with the BMC.

Constructor Summary

Constructors

Constructor	Description
GetChannelCipherSuites()	Initiates class for decoding.
GetChannelCipherSuites(byte channelNumber, byte index)	Initiates class for both encoding and decoding.

Method Summary

Modifier and Type	Method	Description
IpmiMessage	encodePayload(int messageSequenceNumber, int sessionSequenceNumber, int sessionId)	Prepares an IPMI request message containing class-specific payload.
int	getChannelNumber()
byte	getCommandCode()	Retrieves command code specific for command represented by this class
byte	getIndex()
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.
void	setIndex(byte index)

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

getSupportedPayloadType, isCommandResponse

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

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

GetChannelCipherSuites

public GetChannelCipherSuites()

Initiates class for decoding.

GetChannelCipherSuites

public GetChannelCipherSuites(byte channelNumber,
 byte index)

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

index - - (00h-3Fh). 0h selects the first set of 16 cipher suites, 1h selects the next set of 16, and so on

Method Details

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

getChannelNumber

public int getChannelNumber()

setIndex

public void setIndex(byte index)

getIndex

public byte getIndex()

encodePayload

public IpmiMessage encodePayload(int messageSequenceNumber,
 int sessionSequenceNumber,
 int sessionId)
                          throws NoSuchAlgorithmException,
InvalidKeyException

Description copied from class: PayloadCoder

Prepares an IPMI request message containing class-specific payload.

Overrides:

encodePayload in class PayloadCoder

Parameters:

messageSequenceNumber - - A generated sequence number used for matching request and response. For all IPMI messages, messageSequenceNumber is used as a IPMI LAN Message sequence number and as an IPMI payload message tag.

sessionSequenceNumber - - If IPMI message is sent in a session, it is used as a Session Sequence Number

sessionId - - ID of the managed system's session message is being sent in. For sessionless commands should b set to 0.

Returns:

IPMI message

Throws:

NoSuchAlgorithmException - - when authentication, confidentiality or integrity algorithm fails.

InvalidKeyException - - when creating of the algorithm key fails

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