Package org.metricshub.ipmi.client

Class IpmiCompletionCodeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.metricshub.ipmi.client.IpmiClientException

org.metricshub.ipmi.client.IpmiCompletionCodeException

All Implemented Interfaces:

Serializable

public class IpmiCompletionCodeException
extends IpmiClientException

The BMC answered a command with an error completion code (IPMI 2.0 table 5-2).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IpmiCompletionCodeException(String what, IPMIException cause)	Creates the exception for an error reply received in the course of an operation, when the command the BMC answered is not known.
IpmiCompletionCodeException(IpmiCommandCoder<?> request, IPMIException cause)	Creates the exception for the error reply to a command.

Method Summary

Modifier and Type	Method	Description
int	command()	Returns the command code of the command the BMC answered.
CompletionCode	completionCode()	Returns the completion code, CompletionCode.Unknown when the library does not model it.
NetworkFunction	networkFunction()	Returns the network function of the command the BMC answered.
int	rawCompletionCode()	Returns the completion code byte as the BMC sent it, for the codes the library does not model (the command-specific and OEM ones).

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

IpmiCompletionCodeException

public IpmiCompletionCodeException(IpmiCommandCoder<?> request,
 IPMIException cause)

Creates the exception for the error reply to a command.

Parameters:

request - the command the BMC answered

cause - the error reply

IpmiCompletionCodeException

public IpmiCompletionCodeException(String what,
 IPMIException cause)

Creates the exception for an error reply received in the course of an operation, when the command the BMC answered is not known.

Parameters:

what - what the operation was doing

cause - the error reply

Method Details

completionCode

public CompletionCode completionCode()

Returns the completion code, CompletionCode.Unknown when the library does not model it.

Returns:

the completion code

rawCompletionCode

public int rawCompletionCode()

Returns the completion code byte as the BMC sent it, for the codes the library does not model (the command-specific and OEM ones).

Returns:

the completion code, 0 to 255

networkFunction

public NetworkFunction networkFunction()

Returns the network function of the command the BMC answered.

Returns:

the network function, or null when the command is not known or its network function is one NetworkFunction does not list (an extension or OEM command)

command

public int command()

Returns the command code of the command the BMC answered.

Returns:

the command code, 0 to 255, or -1 when the command is not known