package org.metricshub.ipmi.core.coding.commands.session;
   
   /*-
    * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
    * IPMI Java Client
    * ჻჻჻჻჻჻
    * Copyright 2023 Verax Systems, MetricsHub
    * ჻჻჻჻჻჻
    * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Lesser General Public License as
   * published by the Free Software Foundation, either version 3 of the
   * License, or (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Lesser Public License for more details.
   *
   * You should have received a copy of the GNU General Lesser Public
   * License along with this program.  If not, see
   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
   * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
   */
  
  import org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder;
  import org.metricshub.ipmi.core.coding.commands.IpmiVersion;
  import org.metricshub.ipmi.core.coding.commands.ResponseData;
  import org.metricshub.ipmi.core.coding.payload.IpmiPayload;
  import org.metricshub.ipmi.core.coding.payload.lan.IPMIException;
  import org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest;
  import org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction;
  import org.metricshub.ipmi.core.coding.protocol.AuthenticationType;
  import org.metricshub.ipmi.core.coding.protocol.IpmiMessage;
  import org.metricshub.ipmi.core.coding.security.CipherSuite;
  import org.metricshub.ipmi.core.common.TypeConverter;
  
  import java.security.InvalidKeyException;
  import java.security.NoSuchAlgorithmException;
  
  /**
   * Wrapper for Close Session request
   */
  public class CloseSession extends IpmiCommandCoder {
  
      private int sessionId;
  
      /**
       * Initiates CloseSession for both encoding and decoding.
       *
       * @param version
       *            - IPMI version of the command.
       * @param cipherSuite
       *            - {@link CipherSuite} containing authentication,
       *            confidentiality and integrity algorithms for this session.
       * @param authenticationType
       *            - Type of authentication used. Must be RMCPPlus for IPMI v2.0.
       * @param sessionId
       *            - Generated by managed system ID of the session to close.
       */
      public CloseSession(IpmiVersion version, CipherSuite cipherSuite,
              AuthenticationType authenticationType, int sessionId) {
          super(version, cipherSuite, authenticationType);
  
          if (sessionId == 0) {
              throw new IllegalArgumentException("Cannot close session '0'");
          }
  
          this.sessionId = sessionId;
      }
  
      @Override
      public byte getCommandCode() {
          return TypeConverter.intToByte(0x3c);
      }
  
      @Override
      public NetworkFunction getNetworkFunction() {
          return NetworkFunction.ApplicationRequest;
      }
  
      @Override
      protected IpmiPayload preparePayload(int sequenceNumber)
              throws NoSuchAlgorithmException, InvalidKeyException {
  
          byte[] payload = TypeConverter.intToLittleEndianByteArray(sessionId);
  
          return new IpmiLanRequest(getNetworkFunction(), getCommandCode(),
                  payload, TypeConverter.intToByte(sequenceNumber));
      }
  
      @Override
      public ResponseData getResponseData(IpmiMessage message) throws IPMIException, NoSuchAlgorithmException, InvalidKeyException {
          return new CloseSessionResponseData();
      }
  
  }