platform/sensinact-core/src/main/java/org/eclipse/sensinact/gateway/core/message/SnaErrorfulMessage.java

/*
* Copyright (c) 2020 Kentyou.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
*    Kentyou - initial API and implementation
 */
package org.eclipse.sensinact.gateway.core.message;

import org.json.JSONArray;

import org.eclipse.sensinact.gateway.common.props.KeysCollection;
import org.eclipse.sensinact.gateway.common.props.TypedKey;

/**
 * @author <a href="mailto:christophe.munilla@cea.fr">Christophe Munilla</a>
 *
 * @param <S>
 */
public interface SnaErrorfulMessage<S extends Enum<S> & SnaMessageSubType & KeysCollection> extends SnaMessage<S> {
	static final int NO_ERROR = 200;
	static final int BAD_REQUEST_ERROR_CODE = 400;
	static final int FORBIDDEN_ERROR_CODE = 403;
	static final int NOT_FOUND_ERROR_CODE = 404;
	static final int TIMEOUT_ERROR_CODE = 408;
	static final int INTERNAL_SERVER_ERROR_CODE = 500;
	static final int UNKNOWN_ERROR_CODE = 520;

	public static final TypedKey<?>[] PERMANENT_KEYS = new TypedKey[] {
			new TypedKey<JSONArray>(SnaConstants.ERRORS_KEY, JSONArray.class, false) };

	/**
	 * @return
	 */
	JSONArray getErrors();

	/**
	 * @param errorsArray
	 */
	void setErrors(JSONArray errorsArray);

	/**
	 * @param exception
	 */
	void setErrors(Exception exception);
}