org.eclipse.wst.validation.internal.plugin.ValidationPlugin Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2001, 2012 IBM Corporation and others.
* 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.wst.validation.internal.plugin;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.ProjectScope;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Plugin;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.core.runtime.preferences.IScopeContext;
import org.eclipse.wst.validation.ValidationFramework;
import org.eclipse.wst.validation.internal.DependencyIndex;
import org.eclipse.wst.validation.internal.EventManager;
import org.eclipse.wst.validation.internal.ProjectUnavailableError;
import org.eclipse.wst.validation.internal.ResourceUnavailableError;
import org.eclipse.wst.validation.internal.Tracing;
import org.eclipse.wst.validation.internal.core.Message;
import org.eclipse.wst.validation.internal.provisional.core.IMessage;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
/**
* How does this plug-in get activated? There are many other plug-ins that depend on this plug-in, so there are
* many paths that will activate it. One common path is the J2EE perspective. If the J2EE plug-in start method, they
* reference a class in this plug-in, which activates the plug-in. For that case this plug-in will be active even before
* the workbench is up.
*/
public class ValidationPlugin extends Plugin {
public static final String VALIDATION_PROP_FILE_NAME = "validate_base"; //$NON-NLS-1$
/** org.eclipse.wst.validation - the plug-in id */
public static final String PLUGIN_ID = "org.eclipse.wst.validation"; //$NON-NLS-1$
private static ValidationPlugin _plugin;
private static Message _message;
public static final String VALIDATION_BUILDER_ID = PLUGIN_ID + ".validationbuilder"; //$NON-NLS-1$// plugin id of the validation builder
public static final String VALIDATOR_EXT_PT_ID = "validator"; //$NON-NLS-1$// extension point declaration of the validator
public ValidationPlugin() {
super();
if (_plugin == null)_plugin = this;
}
/**
* Answer the name of the bundle's property file.
*
* @deprecated Use getBundlePropertyFileName() instead.
*/
public static String getBundleName() {
return getBundlePropertyFileName();
}
/**
* Answer the name of the bundle's property file.
*/
public static String getBundlePropertyFileName() {
return VALIDATION_PROP_FILE_NAME;
}
public static Message getMessage() {
if (_message == null) {
_message = new Message();
_message.setBundleName(getBundlePropertyFileName());
}
// clear the message for reuse
_message.setId(null);
_message.setParams(null);
_message.setTargetObject(null);
_message.setGroupName(null);
_message.setSeverity(IMessage.LOW_SEVERITY);
return _message;
}
public static ValidationPlugin getPlugin() {
return _plugin;
}
public static boolean isActivated() {
Bundle bundle = Platform.getBundle(PLUGIN_ID);
if (bundle != null)
return bundle.getState() == Bundle.ACTIVE;
return false;
}
public void start(BundleContext context) throws Exception {
super.start(context);
ResourcesPlugin.getWorkspace().addResourceChangeListener(EventManager.getManager(),
IResourceChangeEvent.PRE_CLOSE | IResourceChangeEvent.PRE_DELETE |
IResourceChangeEvent.POST_BUILD | IResourceChangeEvent.PRE_BUILD | IResourceChangeEvent.POST_CHANGE);
DependencyIndex di = (DependencyIndex)ValidationFramework.getDefault().getDependencyIndex();
IWorkspace ws = ResourcesPlugin.getWorkspace();
ws.addSaveParticipant(this, di);
// ws.addResourceChangeListener(ValOperationManager.getDefault(),
// IResourceChangeEvent.POST_BUILD | IResourceChangeEvent.PRE_BUILD);
}
public void stop(BundleContext context) throws Exception {
super.stop(context);
ResourcesPlugin.getWorkspace().removeResourceChangeListener( EventManager.getManager() );
ValidationFramework.getDefault().cancel();
// ResourcesPlugin.getWorkspace().removeResourceChangeListener( ValOperationManager.getDefault() );
EventManager.getManager().shutdown();
}
/*
* (non-Javadoc)
*
* @see org.eclipse.wst.common.frameworks.internal.WTPPlugin#getPluginID()
*/
public String getPluginID() {
return PLUGIN_ID;
}
public static IEclipsePreferences getPreferences(IProject project){
IScopeContext projectContext = new ProjectScope(project);
return projectContext.getNode(PLUGIN_ID);
}
/**
* Write this exception to the log.
*
* We are in the transition of moving to a new approach for localized messages. This is the new
* approach for exceptions.
*
* @param e the throwable, this can be null in which case it is a nop.
*/
public void handleException(Throwable e){
handleException(e, IStatus.ERROR);
}
/**
* Write this exception to the log.
*
* We are in the transition of moving to a new approach for localized messages. This is the new
* approach for exceptions.
*
* @param e the throwable, this can be null in which case it is a nop.
* @param severity the severity of the message. This must be one of the IStatus severities.
*/
public void handleException(Throwable e, int severity){
if (e == null)return;
Status status = new Status(severity, PLUGIN_ID, e.getLocalizedMessage(), e);
getLog().log(status);
}
public void handleProjectUnavailableError(ProjectUnavailableError e){
if (Tracing.isLogging())handleException(e);
}
public void handleResourceUnavailableError(ResourceUnavailableError e){
if (Tracing.isLogging())handleException(e);
}
/**
* Write a message into the log.
*
* We are in the transition of moving to a new approach for localized messages. This is the new
* approach for exceptions.
*
* @param severity message severity, see IStaus
* @param message a localized message
*/
public void logMessage(int severity, String message){
Status status = new Status(severity, PLUGIN_ID, message);
getLog().log(status);
}
}