com.ibm.iotf.client.app.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.app;

import java.io.UnsupportedEncodingException;

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


public class Command extends Message {

	private String type;
	private String id;
	private String command;
	private String format;
	
	/**
	 * Note that this class does not have a default constructor
	 * @param type
	 * 			Object of String which denotes command type
	 * @param id
	 * 			Object of String which denotes command id
	 * @param command
	 * 			Object of String which denotes actual command type
	 * @param format
	 * 			Object of String which denotes command format, say json
	 * @param msg
	 * 			MqttMessage
	 * @see Paho Client Library 
	 * @throws UnsupportedEncodingException When the encoding format id not UTF-8 
	 * 
	 */	
	public Command(String type, String id, String command, String format, MqttMessage msg) throws UnsupportedEncodingException{
		super(msg, format);
		this.type = type;
		this.id = id;
		this.command = command;
		this.format = format;
	}
	
	/**
	 * Returns the device type
	 * @return Returns the device type
	 */
	public String getDeviceType() {
		return type;
	}

	/**
	 * Returns the device Id
	 * @return Returns the device Id
	 */
	public String getDeviceId() {
		return id;
	}
	
	/**
	 * Returns the name of the command
	 * @return Returns the name of the command
	 */
	public String getCommand() {
		return command;
	}
	
	/**
	 * This method is deprecated. Instead use {@link #getData()} or {@link #getRawPayload()}
	 */
	@Deprecated
	public String getPayload() {
		return super.getPayload();
	}
	
	/**
	 * Returns the format in string
	 * @return format in String
	 */
	public String getFormat() {
		return format;
	}
	
	/**
	 * 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, command type, command id and payload passed.
	 */
	public String toString() {
		return "Command [" + timestamp.toString() + "] " + type + ":" + id + " - " + command + ": " + this.getPayload();
	}
}