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

Class ActivatePayload<R extends ActivatePayloadResponseData>

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

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

org.metricshub.ipmi.core.coding.commands.payload.ActivatePayload<R>

Direct Known Subclasses:

ActivateSolPayload

public abstract class ActivatePayload<R extends ActivatePayloadResponseData>
extends IpmiCommandCoder<R>

An abstract wrapper class for Activate Payload Command. Every PayloadType should have it's own concrete implementation.

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.
abstract PayloadType	getPayloadType()
R	getResponseData(IpmiMessage message)	Retrieves payload-specific response data from IPMI message
int	hashCode()

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

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

Method Details

getPayloadType

public abstract PayloadType getPayloadType()

Returns:

type of the payload activated by this command.

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<R extends ActivatePayloadResponseData>

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<R extends ActivatePayloadResponseData>

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 R 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<R extends ActivatePayloadResponseData>

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