Package: KapuaAppChannel

KapuaAppChannel

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2016, 2022 Eurotech and/or its affiliates and others
3: *
4: * This program and the accompanying materials are made
5: * available under the terms of the Eclipse Public License 2.0
6: * which is available at https://www.eclipse.org/legal/epl-2.0/
7: *
8: * SPDX-License-Identifier: EPL-2.0
9: *
10: * Contributors:
11: * Eurotech - initial API and implementation
12: *******************************************************************************/
13: package org.eclipse.kapua.service.device.management.message;
14:
15: import javax.xml.bind.annotation.XmlElement;
16:
17: /**
18: * Device Application {@link KapuaControlChannel} definition.
19: * <p>
20: * This object defines the common channel behavior for a Kapua request or response message.<br>
21: * The request message is used to perform interactive operations with the device (e.g. to send command to the device, to ask configurations...)
22: *
23: * @since 1.0.0
24: */
25: public interface KapuaAppChannel extends KapuaControlChannel {
26:
27: /**
28: * Gets the device application name.
29: *
30: * @return The device application name.
31: * @since 1.0.0
32: */
33: @XmlElement(name = "appName")
34: KapuaAppProperties getAppName();
35:
36: /**
37: * Sets the device application name.
38: *
39: * @param appName The device application name.
40: * @since 1.0.0
41: */
42: void setAppName(KapuaAppProperties appName);
43:
44: /**
45: * Gets the device application version.
46: *
47: * @return The device application version.
48: * @since 1.0.0
49: */
50: @XmlElement(name = "version")
51: KapuaAppProperties getVersion();
52:
53: /**
54: * Sets the device application version.
55: *
56: * @param appVersion The device application version.
57: * @since 1.0.0
58: */
59: void setVersion(KapuaAppProperties appVersion);
60: }