public class GetChannelAuthenticationCapabilities extends IpmiCommandCoder
Constructor and Description |
---|
GetChannelAuthenticationCapabilities()
Initiates class for decoding in 1.5 version.
|
GetChannelAuthenticationCapabilities(IpmiVersion version,
IpmiVersion requestVersion,
CipherSuite cipherSuite)
Initiates class.
|
GetChannelAuthenticationCapabilities(IpmiVersion version,
IpmiVersion requestVersion,
CipherSuite cipherSuite,
PrivilegeLevel privilegeLevel,
byte channelNumber)
Initiates class.
|
Modifier and Type | Method and Description |
---|---|
IpmiMessage |
encodeCommand(int sequenceNumber,
int sessionId)
Prepares an IPMI request message containing class-specific command
|
int |
getChannelNumber() |
byte |
getCommandCode()
Retrieves command code specific for command represented by this class
|
NetworkFunction |
getNetworkFunction()
Retrieves network function specific for command represented by this
class.
|
PrivilegeLevel |
getRequestedPrivilegeLevel() |
ResponseData |
getResponseData(IpmiMessage message)
Retrieves command-specific response data from IPMI message
|
void |
setChannelNumber(int channelNumber)
Sets the channel number that will be put into IPMI command.
|
void |
setRequestedPrivilegeLevel(PrivilegeLevel requestedPrivilegeLevel) |
void |
setSessionParameters(IpmiVersion version,
CipherSuite cipherSuite,
AuthenticationType authenticationType)
Sets session parameters.
|
getAuthenticationType, getCipherSuite, getIpmiVersion, isCommandResponse, setAuthenticationType, setCipherSuite, setIpmiVersion
public GetChannelAuthenticationCapabilities()
public GetChannelAuthenticationCapabilities(IpmiVersion version, IpmiVersion requestVersion, CipherSuite cipherSuite)
version
- - Version of IPMI protocol usedrequestVersion
- - If Get Channel Authentication Capabilities command is sent
to BMC with requestVersion = IpmiVersion.V15
it will
respond, that it does not support IPMI v2.0 even if it does.cipherSuite
- - CipherSuite
containing authentication,
confidentiality and integrity algorithms for this session.IpmiVersion
public GetChannelAuthenticationCapabilities(IpmiVersion version, IpmiVersion requestVersion, CipherSuite cipherSuite, PrivilegeLevel privilegeLevel, byte channelNumber)
version
- - Version of IPMI protocol usedrequestVersion
- - If Get Channel Authentication Capabilities command is sent
to BMC with requestVersion = IpmiVersion.V15
it will
respond, that it does not support IPMI v2.0 even if it does.cipherSuite
- - CipherSuite
containing authentication,
confidentiality and integrity algorithms for this session.privilegeLevel
- - Maximum requested privilege level. Can't be
PrivilegeLevel.MaximumAvailable
.channelNumber
- - must be 0h-Bh or Eh-Fh IpmiVersion
,
PrivilegeLevel
public void setRequestedPrivilegeLevel(PrivilegeLevel requestedPrivilegeLevel)
public PrivilegeLevel getRequestedPrivilegeLevel()
public void setChannelNumber(int channelNumber) throws java.lang.IllegalArgumentException
channelNumber
- - must be 0h-Bh or Eh-Fh java.lang.IllegalArgumentException
public int getChannelNumber()
public IpmiMessage encodeCommand(int sequenceNumber, int sessionId) throws java.security.InvalidKeyException, java.security.NoSuchAlgorithmException
IpmiCommandCoder
encodeCommand
in class IpmiCommandCoder
sequenceNumber
- - A generated sequence number used for matching request and
response. If IPMI message is sent in a session, it is used as
a Session Sequence Number. For all IPMI messages,
sequenceNumber % 256 is used as a IPMI LAN Message sequence
number and as an IPMI payload message tag.sessionId
- - ID of the managed system's session message is being sent in.
For sessionless commands should b set to 0.java.security.InvalidKeyException
- - when creating of the algorithm key failsjava.security.NoSuchAlgorithmException
- - when authentication, confidentiality or integrity algorithm
fails.public byte getCommandCode()
IpmiCommandCoder
getCommandCode
in class IpmiCommandCoder
public NetworkFunction getNetworkFunction()
IpmiCommandCoder
getNetworkFunction
in class IpmiCommandCoder
NetworkFunction
public ResponseData getResponseData(IpmiMessage message) throws java.lang.IllegalArgumentException, IPMIException
IpmiCommandCoder
getResponseData
in class IpmiCommandCoder
message
- - IPMI messagejava.lang.IllegalArgumentException
- when message is not a response for class-specific command or
response has invalid length.IPMIException
- when response completion code isn't OK.public void setSessionParameters(IpmiVersion version, CipherSuite cipherSuite, AuthenticationType authenticationType)
setSessionParameters
in class IpmiCommandCoder
version
- - IPMI version of the command.cipherSuite
- - CipherSuite
containing authentication,
confidentiality and integrity algorithms for this session.authenticationType
- - Type of authentication used. Must be RMCPPlus for IPMI v2.0.