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

Class DeactivatePayload

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

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

org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayload

public class DeactivatePayload
extends IpmiCommandCoder

A wrapper class for Deactivate Payload Command.

Constructor Summary

Constructors

Constructor	Description
DeactivatePayload(PayloadType payloadType, int payloadInstance)	Creates new instance of the DeactivatePayload command for deactivating given PayloadType.
DeactivatePayload(CipherSuite cipherSuite, PayloadType payloadType, int payloadInstance)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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
int	hashCode()

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

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

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DeactivatePayload

public DeactivatePayload(CipherSuite cipherSuite,
 PayloadType payloadType,
 int payloadInstance)

DeactivatePayload

public DeactivatePayload(PayloadType payloadType,
 int payloadInstance)

Creates new instance of the DeactivatePayload command for deactivating given PayloadType.

Parameters:

payloadType - payload to be deactivated.

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object