com.ibm.iotf.client.device.Command 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-16 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:
 Sathiskumar Palaniappan - Initial Contribution
 *****************************************************************************
 *
 */
package com.ibm.iotf.client.device;

import java.io.UnsupportedEncodingException;
import org.eclipse.paho.client.mqttv3.MqttMessage;
import com.ibm.iotf.client.Message;

/**
 * The objects of this class hold the command and the format of the command sent to a device 

 * This class has only accessors and no mutators and later on might be made final
 * 
 */

public class Command extends Message{

	private String command;
	private String format;

	/**
	 * Note that this class does not have a default constructor 


	 * This class has only accessors and no mutators and later on might be made final 

	 * @param command
	 * 			Actual command in the form of String passed
	 * @param format
	 * 			Format is a String which can contain values such as "json"
	 * @param msg
	 * 			MqttMessage 
	 * @see Paho Client Library 
	 * @throws
	 * 			UnsupportedEncodingException When the Format is not UTF-8
	 * 
	 */	
	public Command(String command, String format, MqttMessage msg) throws UnsupportedEncodingException{
		super(msg, format);
		this.command = command;
		this.format = format;
	}
	
	/**
	 * Returns the name of the command
	 * @return the name of the command 
	 */
	public String getCommand() {
		return command;
	}
	
	public String getFormat() {
		return format.toString();
	}
	
	/**
	 * This method is deprecated. Instead use {@link #getData()} or {@link #getRawPayload()}
	 */
	@Deprecated
	public String getPayload() {
		return super.getPayload();
	}
	
	/**
	 * Returns the actual MQTT payload sent by the application
	 * 
	 * @return returns the command in either JSON, byte[] or String type based on the format specified.
	 */
	public Object getData() {
		return this.payload;
	}

	/**
	 * 
	 * Provides a human readable String representation of this Command, including the timestamp and the actual command passed.
	 */
	public String toString() {
		return "[" + timestamp.toString() + "] " + command + ": " + this.getPayload(); 
	}

}