Package org.metricshub.ipmi.core.coding.sol

Class SolCoder

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

org.metricshub.ipmi.core.coding.sol.SolCoder

public class SolCoder
extends PayloadCoder

Implementation of PayloadCoder for payload type PayloadType.Sol. This coder is used during exchanging SOL messages between BMC and application.

Constructor Summary

Constructors

Constructor	Description
SolCoder(byte[] message)	Creates new SolCoder.
SolCoder(byte[] message, byte ackNackSequenceNumber, byte acceptedCharacters, SolAckState ackState, Set<SolOperation> operations)	Creates new SolCoder.
SolCoder(byte ackNackSequenceNumber, byte acceptedCharacters, SolAckState ackState)	Creates new SolCoder.
SolCoder(byte ackNackSequenceNumber, byte acceptedCharacters, SolAckState ackState, Set<SolOperation> operations)	Creates new SolCoder.
SolCoder(Set<SolOperation> operations)	Creates new SolCoder.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ResponseData	getResponseData(IpmiMessage ipmiMessage)	Retrieves payload-specific response data from IPMI message
PayloadType	getSupportedPayloadType()
int	hashCode()
boolean	isAcknowledgeOnly()

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

Constructor Details

SolCoder

public SolCoder(byte[] message,
 byte ackNackSequenceNumber,
 byte acceptedCharacters,
 SolAckState ackState,
 Set<SolOperation> operations)

Creates new SolCoder. Use this constructor if you want to send character data, operations and ACK/NACK in single packet.

Parameters:

message - data to send as byte array

ackNackSequenceNumber - sequence number of packet that is ACKd/NACKd

acceptedCharacters - number of characters accepted from the ACKd/NACKd packet

ackState - actual acknowledge state - SolAckState.ACK or SolAckState.NACK

operations - set of operations to invoke on remote serial port

SolCoder

public SolCoder(byte[] message)

Creates new SolCoder. Use this constructor for character data only packets (no ACK/NACK and no operations will be sent).

Parameters:

message - data to send as byte array

SolCoder

public SolCoder(Set<SolOperation> operations)

Creates new SolCoder. Use this constructor for packets that should only invoke operations on remote serial port.

Parameters:

operations - set of operations to invoke on remote serial port.

SolCoder

public SolCoder(byte ackNackSequenceNumber,
 byte acceptedCharacters,
 SolAckState ackState)

Creates new SolCoder. Use this constructor for ACK/NACK packet, that only sends ACK/NACK for specific remote message.

Parameters:

ackNackSequenceNumber - sequence number of packet that is ACKd/NACKd

acceptedCharacters - number of characters accepted from the ACKd/NACKd packet

ackState - actual acknowledge state - SolAckState.ACK or SolAckState.NACK

SolCoder

public SolCoder(byte ackNackSequenceNumber,
 byte acceptedCharacters,
 SolAckState ackState,
 Set<SolOperation> operations)

Creates new SolCoder. Use this constructor for ACK/NACK packet, that only sends ACK/NACK for specific remote message, with the state of the serial lines the console holds.

Parameters:

ackNackSequenceNumber - sequence number of packet that is ACKd/NACKd

acceptedCharacters - number of characters accepted from the ACKd/NACKd packet

ackState - actual acknowledge state - SolAckState.ACK or SolAckState.NACK

operations - the operations of the packet: the serial line states the console holds

Method Details

isAcknowledgeOnly

public boolean isAcknowledgeOnly()

Returns:

whether the packet only acknowledges a packet of the BMC: it goes out with packet sequence number 0, and the BMC does not acknowledge it

getSupportedPayloadType

public PayloadType getSupportedPayloadType()

Specified by:

getSupportedPayloadType in class PayloadCoder

getResponseData

public ResponseData getResponseData(IpmiMessage ipmiMessage)
                             throws IPMIException,
NoSuchAlgorithmException,
InvalidKeyException

Description copied from class: PayloadCoder

Retrieves payload-specific response data from IPMI message

Specified by:

getResponseData in class PayloadCoder

Parameters:

ipmiMessage - - 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