[lttng-ust.git] / liblttng-ust-java-agent / java / lttng-ust-agent-common / org / lttng / ust / agent / context / IContextInfoRetriever.java

/*
 * Copyright (C) 2015 - EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License, version 2.1 only,
 * as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

package org.lttng.ust.agent.context;

/**
 * Context-retrieving object specified by the application to extract
 * application-specific context information, which can then be passed on to the
 * Java agents and saved to a trace.
 *
 * Retriever objects should be registered to the {@link ContextInfoManager} to
 * make them available to the LTTng agents.
 *
 * @author Alexandre Montplaisir
 */
public interface IContextInfoRetriever {

	/**
	 * Retrieve a piece of context information from the application, identified
	 * by a key.
	 *
	 * @param key
	 *            The key identifying the context information
	 * @return The context information.
	 */
	Object retrieveContextInfo(String key);
}
Commit	Line	Data
27dbdc00 AM	1	/*
	2	* Copyright (C) 2015 - EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
	3	*
	4	* This library is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU Lesser General Public License, version 2.1 only,
	6	* as published by the Free Software Foundation.
	7	*
	8	* This library is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
	11	* for more details.
	12	*
	13	* You should have received a copy of the GNU Lesser General Public License
	14	* along with this library; if not, write to the Free Software Foundation,
	15	* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	16	*/
	17
	18	package org.lttng.ust.agent.context;
	19
	20	/**
	21	* Context-retrieving object specified by the application to extract
	22	* application-specific context information, which can then be passed on to the
	23	* Java agents and saved to a trace.
	24	*
	25	* Retriever objects should be registered to the {@link ContextInfoManager} to
	26	* make them available to the LTTng agents.
	27	*
	28	* @author Alexandre Montplaisir
	29	*/
	30	public interface IContextInfoRetriever {
	31
	32	/**
	33	* Retrieve a piece of context information from the application, identified
	34	* by a key.
	35	*
	36	* @param key
	37	* The key identifying the context information
	38	* @return The context information.
	39	*/
	40	Object retrieveContextInfo(String key);
	41	}