org.glowroot.agent.plugin.api.Agent Maven / Gradle / Ivy
/*
* Copyright 2015-2018 the original author or authors.
*
* Licensed 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 org.glowroot.agent.plugin.api;
import org.glowroot.agent.plugin.api.config.ConfigService;
import org.glowroot.agent.plugin.api.internal.PluginService;
import org.glowroot.agent.plugin.api.internal.PluginServiceHolder;
import org.glowroot.agent.plugin.api.weaving.Pointcut;
public class Agent {
private static final PluginService service = PluginServiceHolder.get();
private Agent() {}
/**
* Returns the {@code TimerName} instance for the specified {@code adviceClass}.
*
* {@code adviceClass} must be a {@code Class} with a {@link Pointcut} annotation that has a
* non-empty {@link Pointcut#timerName()}. This is how the {@code TimerName} is named.
*
* The same {@code TimerName} is always returned for a given {@code adviceClass}.
*
* The return value can (and should) be cached by the plugin for the life of the jvm to avoid
* looking it up every time it is needed (which is often).
*/
public static TimerName getTimerName(Class adviceClass) {
return service.getTimerName(adviceClass);
}
public static TimerName getTimerName(String name) {
return service.getTimerName(name);
}
/**
* Returns the {@code ConfigService} instance for the specified {@code pluginId}.
*
* The return value can (and should) be cached by the plugin for the life of the jvm to avoid
* looking it up every time it is needed (which is often).
*/
public static ConfigService getConfigService(String pluginId) {
return service.getConfigService(pluginId);
}
}