Skip to content

Package: DeviceConfigurationStoreSettings

DeviceConfigurationStoreSettings

Coverage

1: /*******************************************************************************
2: * Copyright (c) 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.configuration.store.settings;
14:
15: import org.eclipse.kapua.service.device.management.app.settings.ByDeviceAppManagementSettings;
16: import org.eclipse.kapua.service.device.management.configuration.store.DeviceConfigurationStoreService;
17: import org.eclipse.kapua.service.device.management.configuration.store.DeviceConfigurationStoreXmlFactory;
18: import org.eclipse.kapua.service.device.registry.Device;
19:
20: import javax.xml.bind.annotation.XmlAccessType;
21: import javax.xml.bind.annotation.XmlAccessorType;
22: import javax.xml.bind.annotation.XmlElement;
23: import javax.xml.bind.annotation.XmlRootElement;
24: import javax.xml.bind.annotation.XmlType;
25:
26: /**
27: * {@link DeviceConfigurationStoreSettings} definition.
28: * <p>
29: * It represents settings of {@link DeviceConfigurationStoreService} by {@link Device}
30: *
31: * @since 2.0.0
32: */
33: @XmlRootElement(name = "deviceConfigurationStoreSettings")
34: @XmlAccessorType(XmlAccessType.PROPERTY)
35: @XmlType(factoryClass = DeviceConfigurationStoreXmlFactory.class, factoryMethod = "newDeviceConfigurationStoreSettings")
36: public interface DeviceConfigurationStoreSettings extends ByDeviceAppManagementSettings {
37:
38: /**
39: * Gets the {@link DeviceConfigurationStoreEnablementPolicy}
40: *
41: * @return The {@link DeviceConfigurationStoreEnablementPolicy}
42: * @since 2.0.0
43: */
44: @XmlElement(name = "enablementPolicy")
45: DeviceConfigurationStoreEnablementPolicy getEnablementPolicy();
46:
47: /**
48: * Sets the {@link DeviceConfigurationStoreEnablementPolicy}
49: *
50: * @param enablementPolicy The {@link DeviceConfigurationStoreEnablementPolicy}
51: * @since 2.0.0
52: */
53: void setEnablementPolicy(DeviceConfigurationStoreEnablementPolicy enablementPolicy);
54: }