com.ibm.internal.iotf.devicemgmt.handler.FirmwareDownloadRequestHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of watson-iot Show documentation
IBM Watson IoT client library to simplify device/gateway/application interactions with the IoT Platform
The newest version!
/**
 *****************************************************************************
  Copyright (c) 2015-17 IBM Corporation and other Contributors.
 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:
 Mike Tran - Initial Contribution
 Sathiskumar Palaniappan - Added Resource Model
 *****************************************************************************
 *
 */
package com.ibm.internal.iotf.devicemgmt.handler;

import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import com.ibm.internal.iotf.devicemgmt.ManagedClient;
import com.ibm.internal.iotf.devicemgmt.DMServerTopic;
import com.ibm.iotf.devicemgmt.DeviceFirmware;

import com.ibm.internal.iotf.devicemgmt.ResponseCode;
import com.ibm.iotf.util.LoggerUtility;

/**
 * Request handler for MMqttClient.SERVER_TOPIC_INITIATE_FIRMWARE_DOWNLOAD
 * 
Expected request message format
 * 
 * {
 * 	"reqId": "string"
 * }
 * 
 */	
public class FirmwareDownloadRequestHandler extends DMRequestHandler {

	private static final String CLASS_NAME = FirmwareDownloadRequestHandler.class.getName();
	
	public FirmwareDownloadRequestHandler(ManagedClient dmClient) {
		setDMClient(dmClient);
	}
	
	/**
	 * Return initiate firmware download topic
	 */
	@Override
	protected String getTopic() {
		DMServerTopic topic = this.getDMClient().getDMServerTopic();
		return topic.getInitiateFirmwareDownload();
	}
	
	/**
	 * Following are actions that needs to be taken after receiving the command
	 * 
	 * If mgmt.firmware.state is not 0 ("Idle") an error should be reported with 
	 * response code 400, and an optional message text.
	 * 
	 * If the action can be initiated immediately, set rc to 202.
	 * 
	 * If mgmt.firmware.url is not set or is not a valid URL, set rc to 400.
	 * 
	 * If firmware download attempt fails, set rc to 500 and optionally set message accordingly.
	 * 
	 * If firmware download is not supported, set rc to 501 and optionally set message accordingly.
	 */
	@Override
	public void handleRequest(JsonObject jsonRequest, String topic) {
		final String METHOD = "handleRequest";
		ResponseCode rc;
		
		JsonObject response = new JsonObject();
		response.add("reqId", jsonRequest.get("reqId"));
		DeviceFirmware deviceFirmware = getDMClient().getDeviceData().getDeviceFirmware();
		if (deviceFirmware == null || getDMClient().getFirmwareHandler() == null) {
			rc = ResponseCode.DM_FUNCTION_NOT_IMPLEMENTED;
		} else if(deviceFirmware.getState() != DeviceFirmware.FirmwareState.IDLE.getState()) {
			rc = ResponseCode.DM_BAD_REQUEST;		
		} else {
			if (deviceFirmware.getUrl() != null) {
				rc = ResponseCode.DM_ACCEPTED;
			} else {
				rc = ResponseCode.DM_BAD_REQUEST;
				LoggerUtility.severe(CLASS_NAME, METHOD, "No URL mentioned in the request");
			}
		} 
		response.add("rc", new JsonPrimitive(rc.getCode()));
		respond(response);
		if (rc == ResponseCode.DM_ACCEPTED) {
			LoggerUtility.fine(CLASS_NAME, METHOD, "fire firmware download");
			getDMClient().getFirmwareHandler().downloadFirmware(deviceFirmware);			
		}
	}
}