View Javadoc
1   package org.metricshub.ipmi.core.coding.commands.sel;
2   
3   /*-
4    * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
5    * IPMI Java Client
6    * ჻჻჻჻჻჻
7    * Copyright 2023 Verax Systems, MetricsHub
8    * ჻჻჻჻჻჻
9    * This program is free software: you can redistribute it and/or modify
10   * it under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation, either version 3 of the
12   * License, or (at your option) any later version.
13   *
14   * This program is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Lesser Public License for more details.
18   *
19   * You should have received a copy of the GNU General Lesser Public
20   * License along with this program.  If not, see
21   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22   * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
23   */
24  
25  import org.metricshub.ipmi.core.coding.commands.CommandCodes;
26  import org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder;
27  import org.metricshub.ipmi.core.coding.commands.IpmiVersion;
28  import org.metricshub.ipmi.core.coding.commands.ResponseData;
29  import org.metricshub.ipmi.core.coding.payload.CompletionCode;
30  import org.metricshub.ipmi.core.coding.payload.IpmiPayload;
31  import org.metricshub.ipmi.core.coding.payload.lan.IPMIException;
32  import org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest;
33  import org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse;
34  import org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction;
35  import org.metricshub.ipmi.core.coding.protocol.AuthenticationType;
36  import org.metricshub.ipmi.core.coding.protocol.IpmiMessage;
37  import org.metricshub.ipmi.core.coding.security.CipherSuite;
38  import org.metricshub.ipmi.core.common.TypeConverter;
39  
40  import java.security.InvalidKeyException;
41  import java.security.NoSuchAlgorithmException;
42  
43  /**
44   * Wrapper for Reserve SEL command.
45   */
46  public class ReserveSel extends IpmiCommandCoder {
47  
48      /**
49       * Initiates ReserveSel for both encoding and decoding.
50       *
51       * @param version
52       *            - IPMI version of the command.
53       * @param cipherSuite
54       *            - {@link CipherSuite} containing authentication,
55       *            confidentiality and integrity algorithms for this session.
56       * @param authenticationType
57       *            - Type of authentication used. Must be RMCPPlus for IPMI v2.0.
58       */
59      public ReserveSel(IpmiVersion version, CipherSuite cipherSuite,
60              AuthenticationType authenticationType) {
61          super(version, cipherSuite, authenticationType);
62      }
63  
64      @Override
65      public byte getCommandCode() {
66          return CommandCodes.RESERVE_SEL;
67      }
68  
69      @Override
70      public NetworkFunction getNetworkFunction() {
71          return NetworkFunction.StorageRequest;
72      }
73  
74      @Override
75      protected IpmiPayload preparePayload(int sequenceNumber)
76              throws NoSuchAlgorithmException, InvalidKeyException {
77          return new IpmiLanRequest(getNetworkFunction(), getCommandCode(), null,
78                  TypeConverter.intToByte(sequenceNumber));
79      }
80  
81      @Override
82      public ResponseData getResponseData(IpmiMessage message)
83              throws IPMIException,
84              NoSuchAlgorithmException, InvalidKeyException {
85  
86          if (!isCommandResponse(message)) {
87              throw new IllegalArgumentException(
88                      "This is not a response for Reserve SEL command");
89          }
90          if (!(message.getPayload() instanceof IpmiLanResponse)) {
91              throw new IllegalArgumentException("Invalid response payload");
92          }
93          if (((IpmiLanResponse) message.getPayload()).getCompletionCode() != CompletionCode.Ok) {
94              throw new IPMIException(
95                      ((IpmiLanResponse) message.getPayload())
96                              .getCompletionCode());
97          }
98  
99          byte[] raw = message.getPayload().getIpmiCommandData();
100 
101         if (raw == null || raw.length != 2) {
102             throw new IllegalArgumentException(
103                     "Invalid response payload length: " + (raw != null ? raw.length : "null"));
104         }
105 
106         ReserveSelResponseData responseData = new ReserveSelResponseData();
107 
108         byte[] buffer = new byte[4];
109 
110         buffer[0] = raw[0];
111         buffer[1] = raw[1];
112         buffer[2] = 0;
113         buffer[3] = 0;
114 
115         responseData.setReservationId(TypeConverter
116                 .littleEndianByteArrayToInt(buffer));
117 
118         return responseData;
119     }
120 
121 }