rapture.kernel.PluginApiImplWrapper Maven / Gradle / Ivy
/**
* The MIT License (MIT)
*
* Copyright (C) 2011-2016 Incapture Technologies LLC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* This is an autogenerated file. You should not edit this file as any changes
* will be overwritten.
*/
package rapture.kernel;
import org.apache.log4j.Logger;
import java.util.List;
import java.util.Map;
import rapture.common.api.PluginApi;
import rapture.common.CallingContext;
import rapture.common.RaptureEntitlementsContext;
import rapture.common.hooks.CallName;
import rapture.common.model.BasePayload;
import rapture.common.EntitlementSet;
import rapture.kernel.context.ContextValidator;
import rapture.common.PluginConfig;
import rapture.common.PluginManifest;
import rapture.common.PluginTransportItem;
import rapture.common.shared.plugin.GetInstalledPluginsPayload;
import rapture.common.shared.plugin.GetPluginManifestPayload;
import rapture.common.shared.plugin.RecordPluginPayload;
import rapture.common.shared.plugin.InstallPluginPayload;
import rapture.common.shared.plugin.InstallPluginItemPayload;
import rapture.common.shared.plugin.UninstallPluginPayload;
import rapture.common.shared.plugin.UninstallPluginItemPayload;
import rapture.common.shared.plugin.DeletePluginManifestPayload;
import rapture.common.shared.plugin.GetPluginItemPayload;
import rapture.common.shared.plugin.VerifyPluginPayload;
import rapture.common.shared.plugin.CreateManifestPayload;
import rapture.common.shared.plugin.AddManifestItemPayload;
import rapture.common.shared.plugin.AddManifestDataFolderPayload;
import rapture.common.shared.plugin.RemoveManifestDataFolderPayload;
import rapture.common.shared.plugin.SetManifestVersionPayload;
import rapture.common.shared.plugin.RemoveItemFromManifestPayload;
import rapture.common.shared.plugin.ExportPluginPayload;
/**
* This class is a wrapper around the class {@link PluginApiImpl}. This is an auto-generated class that gives us the ability to add hooks such as entitlmeent
* checks before each function call in the implementation. Since we always want to call these hooks, an instance of this class should be used
* (in {@link Kernel}) instead of using the implementation directly.
* implementation directly.
*
*/
@SuppressWarnings("all")
public class PluginApiImplWrapper implements PluginApi, KernelApi {
private static final Logger log = Logger.getLogger(PluginApiImplWrapper.class);
private PluginApiImpl apiImpl;
public PluginApiImplWrapper(Kernel kernel) {
apiImpl = new PluginApiImpl(kernel);
}
/**
* Returns the underlying implementation object. This should be used when a call is deliberately bypassing entitlement checks.
* @return {@link Plugin}
*/
public PluginApiImpl getTrusted() {
return apiImpl;
}
@Override
public void start() {
apiImpl.start();
}
/**
*
*/
@Override
public List getInstalledPlugins(CallingContext context) {
long functionStartTime = System.currentTimeMillis();
GetInstalledPluginsPayload requestObj = new GetInstalledPluginsPayload();
requestObj.setContext(context);
ContextValidator.validateContext(context, EntitlementSet.Plugin_getInstalledPlugins, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_getInstalledPlugins);
List returnValue = apiImpl.getInstalledPlugins(context); Kernel.getApiHooksService().post(context, CallName.Plugin_getInstalledPlugins);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.getInstalledPlugins.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.getInstalledPlugins.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
return returnValue;}
/**
*
*/
@Override
public PluginManifest getPluginManifest(CallingContext context, String manifestUri) {
long functionStartTime = System.currentTimeMillis();
GetPluginManifestPayload requestObj = new GetPluginManifestPayload();
requestObj.setContext(context);
requestObj.setManifestUri(manifestUri);
ContextValidator.validateContext(context, EntitlementSet.Plugin_getPluginManifest, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_getPluginManifest);
PluginManifest returnValue = apiImpl.getPluginManifest(context, manifestUri); Kernel.getApiHooksService().post(context, CallName.Plugin_getPluginManifest);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.getPluginManifest.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.getPluginManifest.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
return returnValue;}
/**
*
*/
@Override
public void recordPlugin(CallingContext context, PluginConfig plugin) {
long functionStartTime = System.currentTimeMillis();
RecordPluginPayload requestObj = new RecordPluginPayload();
requestObj.setContext(context);
requestObj.setPlugin(plugin);
ContextValidator.validateContext(context, EntitlementSet.Plugin_recordPlugin, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_recordPlugin);
apiImpl.recordPlugin(context, plugin); Kernel.getApiHooksService().post(context, CallName.Plugin_recordPlugin);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.recordPlugin.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.recordPlugin.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void installPlugin(CallingContext context, PluginManifest manifest, Map payload) {
long functionStartTime = System.currentTimeMillis();
InstallPluginPayload requestObj = new InstallPluginPayload();
requestObj.setContext(context);
requestObj.setManifest(manifest);
requestObj.setPayload(payload);
ContextValidator.validateContext(context, EntitlementSet.Plugin_installPlugin, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_installPlugin);
apiImpl.installPlugin(context, manifest, payload); Kernel.getApiHooksService().post(context, CallName.Plugin_installPlugin);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.installPlugin.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.installPlugin.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void installPluginItem(CallingContext context, String pluginName, PluginTransportItem item) {
long functionStartTime = System.currentTimeMillis();
InstallPluginItemPayload requestObj = new InstallPluginItemPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
requestObj.setItem(item);
ContextValidator.validateContext(context, EntitlementSet.Plugin_installPluginItem, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_installPluginItem);
apiImpl.installPluginItem(context, pluginName, item); Kernel.getApiHooksService().post(context, CallName.Plugin_installPluginItem);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.installPluginItem.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.installPluginItem.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void uninstallPlugin(CallingContext context, String name) {
long functionStartTime = System.currentTimeMillis();
UninstallPluginPayload requestObj = new UninstallPluginPayload();
requestObj.setContext(context);
requestObj.setName(name);
ContextValidator.validateContext(context, EntitlementSet.Plugin_uninstallPlugin, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_uninstallPlugin);
apiImpl.uninstallPlugin(context, name); Kernel.getApiHooksService().post(context, CallName.Plugin_uninstallPlugin);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.uninstallPlugin.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.uninstallPlugin.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void uninstallPluginItem(CallingContext context, PluginTransportItem item) {
long functionStartTime = System.currentTimeMillis();
UninstallPluginItemPayload requestObj = new UninstallPluginItemPayload();
requestObj.setContext(context);
requestObj.setItem(item);
ContextValidator.validateContext(context, EntitlementSet.Plugin_uninstallPluginItem, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_uninstallPluginItem);
apiImpl.uninstallPluginItem(context, item); Kernel.getApiHooksService().post(context, CallName.Plugin_uninstallPluginItem);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.uninstallPluginItem.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.uninstallPluginItem.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void deletePluginManifest(CallingContext context, String manifestUri) {
long functionStartTime = System.currentTimeMillis();
DeletePluginManifestPayload requestObj = new DeletePluginManifestPayload();
requestObj.setContext(context);
requestObj.setManifestUri(manifestUri);
ContextValidator.validateContext(context, EntitlementSet.Plugin_deletePluginManifest, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_deletePluginManifest);
apiImpl.deletePluginManifest(context, manifestUri); Kernel.getApiHooksService().post(context, CallName.Plugin_deletePluginManifest);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.deletePluginManifest.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.deletePluginManifest.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public PluginTransportItem getPluginItem(CallingContext context, String uri) {
long functionStartTime = System.currentTimeMillis();
GetPluginItemPayload requestObj = new GetPluginItemPayload();
requestObj.setContext(context);
requestObj.setUri(uri);
ContextValidator.validateContext(context, EntitlementSet.Plugin_getPluginItem, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_getPluginItem);
PluginTransportItem returnValue = apiImpl.getPluginItem(context, uri); Kernel.getApiHooksService().post(context, CallName.Plugin_getPluginItem);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.getPluginItem.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.getPluginItem.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
return returnValue;}
/**
*
*/
@Override
public Map verifyPlugin(CallingContext context, String plugin) {
long functionStartTime = System.currentTimeMillis();
VerifyPluginPayload requestObj = new VerifyPluginPayload();
requestObj.setContext(context);
requestObj.setPlugin(plugin);
ContextValidator.validateContext(context, EntitlementSet.Plugin_verifyPlugin, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_verifyPlugin);
Map returnValue = apiImpl.verifyPlugin(context, plugin); Kernel.getApiHooksService().post(context, CallName.Plugin_verifyPlugin);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.verifyPlugin.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.verifyPlugin.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
return returnValue;}
/**
*
*/
@Override
public void createManifest(CallingContext context, String pluginName) {
long functionStartTime = System.currentTimeMillis();
CreateManifestPayload requestObj = new CreateManifestPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
ContextValidator.validateContext(context, EntitlementSet.Plugin_createManifest, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_createManifest);
apiImpl.createManifest(context, pluginName); Kernel.getApiHooksService().post(context, CallName.Plugin_createManifest);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.createManifest.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.createManifest.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void addManifestItem(CallingContext context, String pluginName, String uri) {
long functionStartTime = System.currentTimeMillis();
AddManifestItemPayload requestObj = new AddManifestItemPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
requestObj.setUri(uri);
ContextValidator.validateContext(context, EntitlementSet.Plugin_addManifestItem, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_addManifestItem);
apiImpl.addManifestItem(context, pluginName, uri); Kernel.getApiHooksService().post(context, CallName.Plugin_addManifestItem);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.addManifestItem.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.addManifestItem.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void addManifestDataFolder(CallingContext context, String pluginName, String uri) {
long functionStartTime = System.currentTimeMillis();
AddManifestDataFolderPayload requestObj = new AddManifestDataFolderPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
requestObj.setUri(uri);
ContextValidator.validateContext(context, EntitlementSet.Plugin_addManifestDataFolder, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_addManifestDataFolder);
apiImpl.addManifestDataFolder(context, pluginName, uri); Kernel.getApiHooksService().post(context, CallName.Plugin_addManifestDataFolder);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.addManifestDataFolder.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.addManifestDataFolder.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void removeManifestDataFolder(CallingContext context, String pluginName, String uri) {
long functionStartTime = System.currentTimeMillis();
RemoveManifestDataFolderPayload requestObj = new RemoveManifestDataFolderPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
requestObj.setUri(uri);
ContextValidator.validateContext(context, EntitlementSet.Plugin_removeManifestDataFolder, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_removeManifestDataFolder);
apiImpl.removeManifestDataFolder(context, pluginName, uri); Kernel.getApiHooksService().post(context, CallName.Plugin_removeManifestDataFolder);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.removeManifestDataFolder.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.removeManifestDataFolder.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void setManifestVersion(CallingContext context, String pluginName, String version) {
long functionStartTime = System.currentTimeMillis();
SetManifestVersionPayload requestObj = new SetManifestVersionPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
requestObj.setVersion(version);
ContextValidator.validateContext(context, EntitlementSet.Plugin_setManifestVersion, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_setManifestVersion);
apiImpl.setManifestVersion(context, pluginName, version); Kernel.getApiHooksService().post(context, CallName.Plugin_setManifestVersion);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.setManifestVersion.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.setManifestVersion.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public void removeItemFromManifest(CallingContext context, String pluginName, String uri) {
long functionStartTime = System.currentTimeMillis();
RemoveItemFromManifestPayload requestObj = new RemoveItemFromManifestPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
requestObj.setUri(uri);
ContextValidator.validateContext(context, EntitlementSet.Plugin_removeItemFromManifest, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_removeItemFromManifest);
apiImpl.removeItemFromManifest(context, pluginName, uri); Kernel.getApiHooksService().post(context, CallName.Plugin_removeItemFromManifest);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.removeItemFromManifest.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.removeItemFromManifest.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
}
/**
*
*/
@Override
public String exportPlugin(CallingContext context, String pluginName, String path) {
long functionStartTime = System.currentTimeMillis();
ExportPluginPayload requestObj = new ExportPluginPayload();
requestObj.setContext(context);
requestObj.setPluginName(pluginName);
requestObj.setPath(path);
ContextValidator.validateContext(context, EntitlementSet.Plugin_exportPlugin, requestObj);
long preToPostStartTime = System.currentTimeMillis();
Kernel.getApiHooksService().pre(context, CallName.Plugin_exportPlugin);
String returnValue = apiImpl.exportPlugin(context, pluginName, path); Kernel.getApiHooksService().post(context, CallName.Plugin_exportPlugin);
long endFunctionTime = System.currentTimeMillis();
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.exportPlugin.fullFunctionTime.succeeded", (endFunctionTime-functionStartTime));
Kernel.getMetricsService().recordTimeDifference("apiMetrics.pluginApi.exportPlugin.preToPostTime.succeeded", (endFunctionTime-preToPostStartTime));
return returnValue;}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy