View Javadoc
1   package org.metricshub.ipmi.core.api.async.messages;
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.api.async.ConnectionHandle;
26  import org.metricshub.ipmi.core.api.async.IpmiResponseListener;
27  import org.metricshub.ipmi.core.coding.commands.PrivilegeLevel;
28  import org.metricshub.ipmi.core.coding.security.CipherSuite;
29  
30  /**
31   * Interface for response messages delivered to {@link IpmiResponseListener}s
32   */
33  public abstract class IpmiResponse {
34      private int tag;
35      private ConnectionHandle handle;
36  
37      /**
38       * {@link ConnectionHandle} to the message that was an origin of the
39       * response Handle contains only the id of the connection, not the
40       * {@link CipherSuite} and {@link PrivilegeLevel} used in that connection.
41       */
42      public ConnectionHandle getHandle() {
43          return handle;
44      }
45  
46      /**
47       * Tag of the message that is associated with the {@link IpmiResponse}
48       */
49      public int getTag() {
50          return tag;
51      }
52  
53      public IpmiResponse(int tag, ConnectionHandle handle) {
54          this.tag = tag;
55          this.handle = handle;
56      }
57  }