Package: DeviceResponseCode

DeviceResponseCode

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.call.message.app.response;
14:
15:
16: import org.eclipse.kapua.service.device.call.message.app.request.DeviceRequestMessage;
17:
18: /**
19: * {@link DeviceResponseCode} definition.
20: * <p>
21: * REST-like response codes.
22: *
23: * @since 1.0.0
24: */
25: public interface DeviceResponseCode {
26:
27: /**
28: * The {@link DeviceRequestMessage} has been successfully processed.
29: *
30: * @return {@code truw} if the {@link DeviceRequestMessage} has been successfully processed, {@code false} otherwise.
31: * @since 1.0.0
32: */
33: boolean isAccepted();
34:
35: /**
36: * The {@link DeviceRequestMessage} is malformed.
37: *
38: * @return {@code truw} if the {@link DeviceRequestMessage} is malformed, {@code false} otherwise.
39: * @since 1.0.0
40: */
41: boolean isBadRequest();
42:
43: /**
44: * The {@link DeviceRequestMessage} resource is not available.
45: *
46: * @return {@code truw} if the {@link DeviceRequestMessage} resource is not available, {@code false} otherwise.
47: * @since 1.0.0
48: */
49: boolean isNotFound();
50:
51: /**
52: * The {@link DeviceRequestMessage} has encountered an error during processing.
53: *
54: * @return {@code truw} if the {@link DeviceRequestMessage} has encountered an error during processing, {@code false} otherwise.
55: * @since 1.0.0
56: */
57: boolean isInternalError();
58: }