Uses of Class
org.metricshub.ipmi.core.api.async.ConnectionHandle

Packages that use ConnectionHandle

Package	Description
org.metricshub.ipmi.core.api.async	The asynchronous API.
org.metricshub.ipmi.core.api.async.messages	The package containing asynchronous API message classes.
org.metricshub.ipmi.core.api.sol	The API for Serial Over LAN (SOL) communication for IPMI.
org.metricshub.ipmi.core.api.sync	The synchronous API of the protocol core: IpmiConnector opens RMCP+ sessions and sends commands, waiting for their responses.
org.metricshub.ipmi.core.connection	Package responsible for Connection management.

Uses of ConnectionHandle in org.metricshub.ipmi.core.api.async

Methods in org.metricshub.ipmi.core.api.async that return ConnectionHandle

Modifier and Type	Method	Description
ConnectionHandle	IpmiAsyncConnector.createConnection(InetAddress address, int port)	Creates connection to the remote host.
ConnectionHandle	IpmiAsyncConnector.createConnection(InetAddress address, int port, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel)	Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.

Methods in org.metricshub.ipmi.core.api.async with parameters of type ConnectionHandle

Modifier and Type	Method	Description
void	IpmiAsyncConnector.closeConnection(ConnectionHandle handle)	Closes the connection with the given handle, forgets its session, and wipes the credentials the handle keeps.
void	IpmiAsyncConnector.closeSession(ConnectionHandle connectionHandle)	Closes the session with the remote host if it is currently in open state, and wipes the password and the BMC key (Kg) the handle keeps.
List<CipherSuite>	IpmiAsyncConnector.getAvailableCipherSuites(ConnectionHandle connectionHandle)	Gets CipherSuites available for the connection with the remote host.
GetChannelAuthenticationCapabilitiesResponseData	IpmiAsyncConnector.getChannelAuthenticationCapabilities(ConnectionHandle connectionHandle, CipherSuite cipherSuite, PrivilegeLevel requestedPrivilegeLevel)	Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the remote host that IpmiAsyncConnector.getAvailableCipherSuites(ConnectionHandle) read (requested at the User level): sends nothing.
int	IpmiAsyncConnector.getTimeout(ConnectionHandle handle)	Returns the timeout of a single message on the given connection.
Session	IpmiAsyncConnector.openSession(ConnectionHandle connectionHandle, String username, byte[] password, byte[] bmcKey)	Establishes the session with the remote host, with the password as bytes: the caller can then clear them once the session is open, which an immutable String does not allow.
Session	IpmiAsyncConnector.openSession(ConnectionHandle connectionHandle, String username, String password, byte[] bmcKey)	Establishes the session with the remote host, and raises it to the requested privilege when that is Operator or Administrator (Set Session Privilege Level, IPMI 2.0 section 22.18: every session starts at User).
int	IpmiAsyncConnector.retry(ConnectionHandle connectionHandle, int tag, PayloadType messagePayloadType)	Attempts to retry sending a message.
int	IpmiAsyncConnector.sendMessage(ConnectionHandle connectionHandle, PayloadCoder request, boolean isOneWay)	Sends the IPMI message to the remote host.
void	IpmiAsyncConnector.setTimeout(ConnectionHandle handle, int timeout)	Changes the timeout value for connection with the given handle.

Constructors in org.metricshub.ipmi.core.api.async with parameters of type ConnectionHandle

Modifier	Constructor	Description
	InboundSolMessageListener(IpmiConnector connector, ConnectionHandle connectionHandle, List<SolEventListener> eventListeners)	Creates the listener of the SOL packets of a connection.

Uses of ConnectionHandle in org.metricshub.ipmi.core.api.async.messages

Methods in org.metricshub.ipmi.core.api.async.messages that return ConnectionHandle

Modifier and Type	Method	Description
ConnectionHandle	IpmiResponse.getHandle()	ConnectionHandle to the message that was an origin of the response Handle contains only the id of the connection, not the CipherSuite and PrivilegeLevel used in that connection.

Constructors in org.metricshub.ipmi.core.api.async.messages with parameters of type ConnectionHandle

Modifier	Constructor	Description
	IpmiError(Exception exception, int tag, ConnectionHandle handle)
	IpmiResponse(int tag, ConnectionHandle handle)
	IpmiResponseData(ResponseData data, int tag, ConnectionHandle handle)

Uses of ConnectionHandle in org.metricshub.ipmi.core.api.sol

Methods in org.metricshub.ipmi.core.api.sol that return ConnectionHandle

Modifier and Type	Method	Description
ConnectionHandle	SerialOverLan.getConnectionHandle()	Returns the connection the console exchanges its packets on: the one of the session it was given, or the one of the session it opened on the port of the payload when the BMC serves SOL on another port.
ConnectionHandle	SOLException.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.

Constructors in org.metricshub.ipmi.core.api.sol with parameters of type ConnectionHandle

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

Uses of ConnectionHandle in org.metricshub.ipmi.core.api.sync

Methods in org.metricshub.ipmi.core.api.sync that return ConnectionHandle

Modifier and Type	Method	Description
ConnectionHandle	IpmiConnector.createConnection(InetAddress address)	Creates connection to the remote host on default IPMI port.
ConnectionHandle	IpmiConnector.createConnection(InetAddress address, int port)	Creates connection to the remote host on specified port.
ConnectionHandle	IpmiConnector.createConnection(InetAddress address, int port, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel)	Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.
ConnectionHandle	IpmiConnector.createConnection(InetAddress address, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel)	Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.

Methods in org.metricshub.ipmi.core.api.sync with parameters of type ConnectionHandle

Modifier and Type	Method	Description
void	IpmiConnector.closeConnection(ConnectionHandle handle)	Closes the connection with the given handle, without closing its session: the requests still waiting for a reply on the connection fail, with a ConnectionException or an IllegalStateException.
void	IpmiConnector.closeSession(ConnectionHandle connectionHandle)	Closes the session with the remote host if it is currently in open state, and wipes the password and the BMC key (Kg) the handle keeps.
List<CipherSuite>	IpmiConnector.getAvailableCipherSuites(ConnectionHandle connectionHandle)	Gets CipherSuites available for the connection with the remote host.
GetChannelAuthenticationCapabilitiesResponseData	IpmiConnector.getChannelAuthenticationCapabilities(ConnectionHandle connectionHandle, CipherSuite cipherSuite, PrivilegeLevel requestedPrivilegeLevel)	Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the remote host that IpmiConnector.getAvailableCipherSuites(ConnectionHandle) read (requested at the User level): sends nothing.
int	IpmiConnector.getTimeout(ConnectionHandle handle)	Returns the timeout of a single message on the connection with the given handle.
Session	IpmiConnector.openSession(ConnectionHandle connectionHandle, String username, byte[] password, byte[] bmcKey)	Establishes the session with the remote host, with the password as bytes: the caller can then clear them once the session is open, which an immutable String does not allow.
Session	IpmiConnector.openSession(ConnectionHandle connectionHandle, String username, String password, byte[] bmcKey)	Establishes the session with the remote host, and raises it to the requested privilege when that is Operator or Administrator (Set Session Privilege Level, IPMI 2.0 section 22.18: every session starts at User).
ResponseData	IpmiConnector.retryMessage(ConnectionHandle connectionHandle, byte tag, PayloadType messagePayloadType)	Re-sends message with given tag having given PayloadType, using passed ConnectionHandle.
<R extends ResponseData> R	IpmiConnector.sendMessage(ConnectionHandle connectionHandle, IpmiCommandCoder<R> request)	Sends the IPMI command to the remote host and returns its typed response.
<R extends ResponseData> R	IpmiConnector.sendMessage(ConnectionHandle connectionHandle, IpmiCommandCoder<R> request, int resends)	Sends the IPMI command to the remote host with its own number of resends when no reply comes, instead of IpmiConnector.getRetries(): 0 for a command the BMC must not receive twice (a chassis reset, whose reply can be lost after the BMC carried it out).
ResponseData	IpmiConnector.sendMessage(ConnectionHandle connectionHandle, PayloadCoder request)	Sends the IPMI message to the remote host.
void	IpmiConnector.sendOneWayMessage(ConnectionHandle connectionHandle, PayloadCoder request)	Sends the IPMI message to the remote host and doesn't wait for any response.
void	IpmiConnector.setTimeout(ConnectionHandle handle, int timeout)	Changes the timeout value for connection with the given handle.

Constructors in org.metricshub.ipmi.core.api.sync with parameters of type ConnectionHandle

Modifier	Constructor	Description
	MessageListener(ConnectionHandle handle)	Initiates the MessageListener

Uses of ConnectionHandle in org.metricshub.ipmi.core.connection

Methods in org.metricshub.ipmi.core.connection that return ConnectionHandle

Modifier and Type	Method	Description
ConnectionHandle	Session.getConnectionHandle()

Methods in org.metricshub.ipmi.core.connection with parameters of type ConnectionHandle

Modifier and Type	Method	Description
static Session	SessionManager.establishSession(IpmiConnector connector, ConnectionHandle connectionHandle, int remotePort)	Opens a new connection and session on another UDP port of the BMC of the given connection (the port of a payload, IPMI 2.0 section 24.1), with its user name, password, BMC key and privilege level, and a copy of its cipher suite: opening the session keys the algorithms of its suite.
Session	SessionManager.registerSession(int newSessionId, int managedSystemSessionId, ConnectionHandle connectionHandle)	Either returns the Session registered for given connection, or creates new IPMI Session and registers it for the given connection handle, if no session was found for the connection.
Session	SessionManager.registerSession(int newSessionId, ConnectionHandle connectionHandle)	Either returns the Session registered for given connection, or creates new IPMI Session and registers it for the given connection handle, if no session was found for the connection.
void	SessionManager.unregisterSession(ConnectionHandle connectionHandle)	Unregisters session for given connection handle, and wipes the credentials of the handle it was registered with.

Constructors in org.metricshub.ipmi.core.connection with parameters of type ConnectionHandle

Modifier	Constructor	Description
	Session(int sessionId, int managedSystemSessionId, ConnectionHandle connectionHandle)
	Session(int sessionId, ConnectionHandle connectionHandle)