Package org.metricshub.ipmi.core.api.sol

Class SOLException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.metricshub.ipmi.core.api.sol.SOLException

All Implemented Interfaces:

Serializable

public class SOLException
extends Exception

Exception representing problem that might have been encountered during Serial over LAN communication.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SOLException(String message)	Creates the exception.
SOLException(String message, Throwable cause)	Creates the exception with its cause.
SOLException(String message, Throwable cause, IpmiCommandCoder<?> command, ConnectionHandle connectionHandle)	Creates the exception for a command of the console that failed.

Method Summary

Modifier and Type	Method	Description
IpmiCommandCoder<?>	getCommand()	Returns the command that failed: Get Payload Activation Status, Activate Payload, Set Session Privilege Level, Get Payload Instance Info or Deactivate Payload.
ConnectionHandle	getConnectionHandle()	Returns the connection the failed command was sent on: the one of the session given to the console, or the one of the session the console opened on the port of the payload.

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

SOLException

public SOLException(String message)

Creates the exception.

Parameters:

message - the description of the failure

SOLException

public SOLException(String message,
 Throwable cause)

Creates the exception with its cause.

Parameters:

message - the description of the failure

cause - the exception that made the operation fail

SOLException

public SOLException(String message,
 Throwable cause,
 IpmiCommandCoder<?> command,
 ConnectionHandle connectionHandle)

Creates the exception for a command of the console that failed.

Parameters:

message - the description of the failure

cause - the exception that made the command fail: an IPMIException for an error reply, a ConnectionException when the BMC did not answer

command - the command that failed

connectionHandle - the connection the command was sent on

Method Details

getCommand

public IpmiCommandCoder<?> getCommand()

Returns the command that failed: Get Payload Activation Status, Activate Payload, Set Session Privilege Level, Get Payload Instance Info or Deactivate Payload.

Returns:

the command, or null when the failure is not the one of a command (or the exception was deserialized)

getConnectionHandle

public ConnectionHandle getConnectionHandle()

Returns the connection the failed command was sent on: the one of the session given to the console, or the one of the session the console opened on the port of the payload.

Returns:

the connection, or null when the failure is not the one of a command (or the exception was deserialized)