com.dianping.cat.message.Message Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011-2018, Meituan Dianping. All Rights Reserved.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.dianping.cat.message;

/**
	* 
	* Message represents data collected during application runtime. It will be sent to back-end system asynchronous for
	* further processing.
	* 
	* 
	* 

	* Super interface of Event, Heartbeat and Transaction.
	* 
	*
	* @author Frankie Wu
	* @see Event, Heartbeat, Transaction
	*/
public interface Message {
	public static final String SUCCESS = "0";

	/**
		* add one or multiple key-value pairs to the message.
		*
		* @param keyValuePairs key-value pairs like 'a=1&b=2&...'
		*/
	public void addData(String keyValuePairs);

	/**
		* add one key-value pair to the message.
		*
		* @param key
		* @param value
		*/
	public void addData(String key, Object value);

	/**
		* Complete the message construction.
		*/
	public void complete();

	/**
		* @return key value pairs data
		*/
	public Object getData();

	/**
		* Message name.
		*
		* @return message name
		*/
	public String getName();

	/**
		* Get the message status.
		*
		* @return message status. "0" means success, otherwise error code.
		*/
	public String getStatus();

	/**
		* Set the message status with exception class name.
		*
		* @param e exception.
		*/
	public void setStatus(Throwable e);

	/**
		* The time stamp the message was created.
		*
		* @return message creation time stamp in milliseconds
		*/
	public long getTimestamp();

	public void setTimestamp(long timestamp);

	/**
		* Message type.
		* 
		* 

		* Typical message types are:
		* 

		* URL: maps to one method of an action
		* Service: maps to one method of service call
		* Search: maps to one method of search call
		* SQL: maps to one SQL statement
		* Cache: maps to one cache access
		* Error: maps to java.lang.Throwable (java.lang.Exception and java.lang.Error)
		* 
		* 
		*
		* @return message type
		*/
	public String getType();

	/**
		* If the complete() method was called or not.
		*
		* @return true means the complete() method was called, false otherwise.
		*/
	public boolean isCompleted();

	/**
		* @return
		*/
	public boolean isSuccess();

	/**
		* Set the message status.
		*
		* @param status message status. "0" means success, otherwise error code.
		*/
	public void setStatus(String status);

	public void setSuccessStatus();
}