Package org.metricshub.ipmi.client

Class IpmiAuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.metricshub.ipmi.client.IpmiClientException

org.metricshub.ipmi.client.IpmiAuthenticationException

All Implemented Interfaces:

Serializable

public class IpmiAuthenticationException
extends IpmiClientException

The BMC refused the login: unknown user name, wrong password or BMC key, role or privilege refused.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IpmiAuthenticationException(String message, Throwable cause)	Creates the exception for a login the console side rejected (the password or BMC key does not match).
IpmiAuthenticationException(String message, CompletionCode statusCode, Throwable cause)	Creates the exception for a login the BMC rejected with a status code.

Method Summary

Modifier and Type	Method	Description
CompletionCode	statusCode()	Returns the status code the BMC sent when it refused the login (IPMI 2.0 table 13-15): unauthorized name, unauthorized role, invalid integrity check value...

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

IpmiAuthenticationException

public IpmiAuthenticationException(String message,
 Throwable cause)

Creates the exception for a login the console side rejected (the password or BMC key does not match).

Parameters:

message - what failed

cause - the failure of the protocol core

IpmiAuthenticationException

public IpmiAuthenticationException(String message,
 CompletionCode statusCode,
 Throwable cause)

Creates the exception for a login the BMC rejected with a status code.

Parameters:

message - what failed

statusCode - the RAKP status code or completion code the BMC sent, null when it sent none

cause - the failure of the protocol core

Method Details

statusCode

public CompletionCode statusCode()

Returns the status code the BMC sent when it refused the login (IPMI 2.0 table 13-15): unauthorized name, unauthorized role, invalid integrity check value...

Returns:

the status code, or null when the login failed on the console side, which checks the key exchange codes of the BMC against the password and the BMC key