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

Class SetSessionPrivilegeLevel

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder<SetSessionPrivilegeLevelResponseData>

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

public class SetSessionPrivilegeLevel
extends IpmiCommandCoder<SetSessionPrivilegeLevelResponseData>

Wrapper class for Set Session Privilege Level command

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LEVEL_ABOVE_LIMIT	Completion code: the requested level exceeds the privilege limit of the channel or of the user.
static final int	LEVEL_NOT_AVAILABLE	Completion code: the requested level is not available for this user (IPMI 2.0 table 22-24).

Constructor Summary

Constructors

Constructor	Description
SetSessionPrivilegeLevel(PrivilegeLevel privilegeLevel)	Initiates SetSessionPrivilegeLevel for encoding and decoding

Method Summary

Modifier and Type	Method	Description
static String	describeRefusal(IPMIException refusal)	Says why the BMC refused the level: the meaning of the command-specific completion codes of Set Session Privilege Level (IPMI 2.0 table 22-24), or the message of the error reply for the other codes, then the code.
byte	getCommandCode()	Retrieves command code specific for command represented by this class
NetworkFunction	getNetworkFunction()	Retrieves network function specific for command represented by this class.
PrivilegeLevel	getPrivilegeLevel()	Returns the level the command requests.
SetSessionPrivilegeLevelResponseData	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

Field Details

LEVEL_NOT_AVAILABLE

public static final int LEVEL_NOT_AVAILABLE

Completion code: the requested level is not available for this user (IPMI 2.0 table 22-24).

See Also:

• Constant Field Values

LEVEL_ABOVE_LIMIT

public static final int LEVEL_ABOVE_LIMIT

Completion code: the requested level exceeds the privilege limit of the channel or of the user.

See Also:

• Constant Field Values

Constructor Details

SetSessionPrivilegeLevel

public SetSessionPrivilegeLevel(PrivilegeLevel privilegeLevel)

Initiates SetSessionPrivilegeLevel for encoding and decoding

Parameters:

privilegeLevel - - Requested PrivilegeLevel to acquire. Can not be higher than level declared during starting session.

Method Details

describeRefusal

public static String describeRefusal(IPMIException refusal)

Says why the BMC refused the level: the meaning of the command-specific completion codes of Set Session Privilege Level (IPMI 2.0 table 22-24), or the message of the error reply for the other codes, then the code.

Parameters:

refusal - the error reply

Returns:

the reason, ending with the completion code in hexadecimal

getPrivilegeLevel

public PrivilegeLevel getPrivilegeLevel()

Returns the level the command requests.

Returns:

the privilege level, PrivilegeLevel.MaximumAvailable when the command only returns the present level of the session

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

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

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

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