* Provisional API: This class is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 3.0
* @since 3.0
*/
public class JptJaxbCorePlugin
extends Plugin {
private static volatile boolean flushPreferences = true;
/**
* The plug-in identifier of Dali JAXB core
* (value "org.eclipse.jpt.jaxb.core").
*/
public static final String PLUGIN_ID = "org.eclipse.jpt.jaxb.core"; //$NON-NLS-1$
public static final String PLUGIN_ID_ = PLUGIN_ID + '.';
/**
* The node for storing a JAXB project's platform in the project's preferences.
*/
public static final String PLATFORM_PREF_NODE = "platform"; //$NON-NLS-1$
/**
* The key for storing the platform id
*/
public static final String PLATFORM_ID_PREF_KEY = "platform-id"; //$NON-NLS-1$
/**
* The node for storing a JAXB project's schemas in the project's preferences.
*/
public static final String SCHEMAS_PREF_NODE = "schemas"; //$NON-NLS-1$
/**
* The node prefix for storing a particular JAXB project schema in the project's preferences.
* Specific schema nodes are followed by integers ("schema-1", "schema-2", etc.)
*/
public static final String SCHEMA_PREF_NODE_PREFIX = "schema-"; //$NON-NLS-1$
/**
* The key for storing a schema namespace in the project's preferences
*/
public static final String SCHEMA_NAMESPACE_PREF_KEY = "namespace"; //$NON-NLS-1$
/**
* The key for storing a schema location (such as a uri or catalog key) in the project's preferences
*/
public static final String SCHEMA_LOCATION_PREF_KEY = "location"; //$NON-NLS-1$
/**
* The key for storing the default JAXB platform ID for JAXB 2.1 in the workspace preferences.
*/
public static final String DEFAULT_JAXB_PLATFORM_2_1_PREF_KEY =
"defaultJaxbPlatform_" + JaxbFacet.VERSION_2_1.getVersionString(); //$NON-NLS-1$
/**
* The key for storing the default JAXB platform ID for JAXB 2.2 in the workspace preferences.
*/
public static final String DEFAULT_JAXB_PLATFORM_2_2_PREF_KEY =
"defaultJaxbPlatform_" + JaxbFacet.VERSION_2_2.getVersionString(); //$NON-NLS-1$
/**
* The identifier for the JAXB validation marker
* (value "org.eclipse.jpt.jaxb.core.jaxbProblemMarker").
*/
public static final String VALIDATION_MARKER_ID = PLUGIN_ID + ".jaxbProblemMarker"; //$NON-NLS-1$
/**
* The content type for jaxb.index files
*/
public static final IContentType JAXB_INDEX_CONTENT_TYPE = getJaxbContentType("jaxbIndex");
/**
* The resource type for jaxb.index files
*/
public static final JptResourceType JAXB_INDEX_RESOURCE_TYPE = new JptResourceType(JAXB_INDEX_CONTENT_TYPE);
/**
* The content type for jaxb.properties files
*/
public static final IContentType JAXB_PROPERTIES_CONTENT_TYPE = getJaxbContentType("jaxbProperties");
/**
* The resource type for jaxb.properties files
*/
public static final JptResourceType JAXB_PROPERTIES_RESOURCE_TYPE = new JptResourceType(JAXB_PROPERTIES_CONTENT_TYPE);
private static IContentType getJaxbContentType(String contentType) {
return getContentType(CONTENT_PREFIX_ + contentType);
}
public static final String CONTENT_PREFIX = PLUGIN_ID_ + "content"; //$NON-NLS-1$
public static final String CONTENT_PREFIX_ = CONTENT_PREFIX + '.';
private static IContentType getContentType(String contentType) {
return Platform.getContentTypeManager().getContentType(contentType);
}
// **************** fields ************************************************
private volatile GenericJaxbProjectManager projectManager;
// **************** singleton *********************************************
private static JptJaxbCorePlugin INSTANCE;
/**
* Return the singleton plug-in
*/
public static JptJaxbCorePlugin instance() {
return INSTANCE;
}
// ********** public static methods **********
/**
* Return the singular JAXB project manager corresponding to the current workspace.
*/
public static JaxbProjectManager getProjectManager() {
return INSTANCE.getProjectManager_();
}
/**
* Return the JAXB project corresponding to the specified Eclipse project,
* or null if unable to associate the specified project with a
* JAXB project.
*/
public static JaxbProject getJaxbProject(IProject project) {
return getProjectManager().getJaxbProject(project);
}
public static JaxbPlatformManager getJaxbPlatformManager() {
return JaxbPlatformManagerImpl.instance();
}
/**
* Return the default Dali preferences
* @see JpaPreferenceInitializer
*/
public static IEclipsePreferences getDefaultPreferences() {
return getPreferences(DefaultScope.INSTANCE);
}
/**
* Return the Dali preferences for the current workspace instance.
*/
public static IEclipsePreferences getWorkspacePreferences() {
return getPreferences(InstanceScope.INSTANCE);
}
/**
* Return the Dali preferences for the specified context.
*/
private static IEclipsePreferences getPreferences(IScopeContext context) {
return context.getNode(PLUGIN_ID);
}
/**
* Set the workspace preference.
*/
public static void setWorkspacePreference(String preferenceKey, String preferenceValue) {
IEclipsePreferences prefs = getWorkspacePreferences();
prefs.put(preferenceKey, preferenceValue);
flush(prefs);
}
/**
* This method is called (via reflection) when the test plug-in is loaded.
* The preferences end up getting flushed after the test case has deleted
* its project, resulting in resource exceptions in the log, e.g.
*
* Resource '/JpaProjectManagerTests' is not open. ** See
JptJaxbCoreTestsPlugin.start(BundleContext)
*/
@SuppressWarnings("unused")
private static void doNotFlushPreferences() {
flushPreferences = false;
}
/**
* Flush preferences in an asynchronous Job because the flush request will
* trigger a lock on the project, which can cause us some deadlocks (e.g.
* when deleting the metamodel source folder).
* Note: the flush will also remove the prefs node if it is empty
*/
private static void flush(IEclipsePreferences prefs) {
if (flushPreferences) {
new PreferencesFlushJob(prefs).schedule();
}
}
private static class PreferencesFlushJob extends Job {
private final IEclipsePreferences prefs;
PreferencesFlushJob(IEclipsePreferences prefs) {
super(NLS.bind(JptJaxbCoreMessages.PREFERENCES_FLUSH_JOB_NAME, prefs.absolutePath()));
this.prefs = prefs;
}
@Override
protected IStatus run(IProgressMonitor monitor) {
try {
prefs.flush();
} catch(BackingStoreException ex) {
log(ex);
}
return Status.OK_STATUS;
}
}
public static Preferences getProjectPreferences(IProject project) {
try {
IFacetedProject fproj = ProjectFacetsManager.create(project);
return fproj.getPreferences(JaxbFacet.FACET);
}
catch (BackingStoreException bse) {
log(bse);
}
catch (CoreException ce) {
log(ce);
}
return null;
}
/**
* Set the default {@link JaxbPlatformDescription} for new JAXB projects with the given
* JAXB facet version.
*/
public static void setDefaultJaxbPlatform(IProjectFacetVersion jaxbFacetVersion, JaxbPlatformDescription platform) {
String preferenceKey = null;
if (JaxbFacet.VERSION_2_1.equals(jaxbFacetVersion)) {
preferenceKey = DEFAULT_JAXB_PLATFORM_2_1_PREF_KEY;
}
else if (JaxbFacet.VERSION_2_2.equals(jaxbFacetVersion)) {
preferenceKey = DEFAULT_JAXB_PLATFORM_2_2_PREF_KEY;
}
else {
throw new IllegalArgumentException("Illegal JAXB facet version: " + jaxbFacetVersion); //$NON-NLS-1$
}
setWorkspacePreference(preferenceKey, platform.getId());
}
/**
* Return the default {@link JaxbPlatformDescription} for new JAXB projects with the given
* JAXB facet version.
*/
public static JaxbPlatformDescription getDefaultPlatform(IProjectFacetVersion jaxbFacetVersion) {
JaxbPlatformDescription defaultPlatform =
getDefaultPlatform(
jaxbFacetVersion,
getWorkspacePreferences(),
getDefaultPreferences());
if (defaultPlatform == null) {
// if the platform ID stored in the workspace prefs is invalid (i.e. null), look in the default prefs
defaultPlatform = getDefaultPlatform(jaxbFacetVersion, getDefaultPreferences());
}
return defaultPlatform;
}
private static JaxbPlatformDescription getDefaultPlatform(
IProjectFacetVersion jaxbFacetVersion, Preferences ... nodes) {
JaxbPlatformDescription defaultDefaultPlatform;
String preferenceKey;
if (jaxbFacetVersion.equals(JaxbFacet.VERSION_2_1)) {
defaultDefaultPlatform = GenericJaxbPlatform.VERSION_2_1;
preferenceKey = DEFAULT_JAXB_PLATFORM_2_1_PREF_KEY;
}
else if (jaxbFacetVersion.equals(JaxbFacet.VERSION_2_2)) {
defaultDefaultPlatform = GenericJaxbPlatform.VERSION_2_2;
preferenceKey = DEFAULT_JAXB_PLATFORM_2_2_PREF_KEY;
}
else {
throw new IllegalArgumentException("Illegal JAXB facet version: " + jaxbFacetVersion); //$NON-NLS-1$
}
return getDefaultPlatform(jaxbFacetVersion, preferenceKey, defaultDefaultPlatform, nodes);
}
private static JaxbPlatformDescription getDefaultPlatform(
IProjectFacetVersion jaxbFacetVersion, String preferenceKey,
JaxbPlatformDescription defaultDefault, Preferences ... nodes) {
String defaultDefaultId = (defaultDefault == null) ? null : defaultDefault.getId();
String defaultPlatformId = Platform.getPreferencesService().get(preferenceKey, defaultDefaultId, nodes);
JaxbPlatformDescription defaultPlatform = getJaxbPlatformManager().getJaxbPlatform(defaultPlatformId);
if (defaultPlatform != null && defaultPlatform.supportsJaxbFacetVersion(jaxbFacetVersion)) {
return defaultPlatform;
}
else if (defaultDefault != null && defaultDefault.supportsJaxbFacetVersion(jaxbFacetVersion)) {
return defaultDefault;
}
return null;
}
/**
* Return the JAXB platform ID associated with the specified Eclipse project.
*/
public static String getJaxbPlatformId(IProject project) {
Preferences prefs = getProjectPreferences(project);
Preferences platformPrefs = prefs.node(PLATFORM_PREF_NODE);
return platformPrefs.get(PLATFORM_ID_PREF_KEY, GenericJaxbPlatform.VERSION_2_1.getId());
}
/**
* Return the {@link JaxbPlatformDescription} associated with the specified Eclipse project.
*/
public static JaxbPlatformDescription getJaxbPlatformDescription(IProject project) {
String jpaPlatformId = getJaxbPlatformId(project);
return getJaxbPlatformManager().getJaxbPlatform(jpaPlatformId);
}
/**
* Set the {@link JaxbPlatformDescription} associated with the specified Eclipse project.
*/
public static void setJaxbPlatform(IProject project, JaxbPlatformDescription platform) {
Preferences prefs = getProjectPreferences(project);
Preferences platformPrefs = prefs.node(PLATFORM_PREF_NODE);
platformPrefs.put(PLATFORM_ID_PREF_KEY, platform.getId());
try {
platformPrefs.flush();
}
catch (BackingStoreException bse) {
log(bse);
}
}
public static Map