/*******************************************************************************
* Copyright (c) 2005, 2007 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.jst.j2ee.jca.modulecore.util;
import java.util.List;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.jst.j2ee.commonarchivecore.internal.Archive;
import org.eclipse.jst.j2ee.commonarchivecore.internal.CommonarchiveFactory;
import org.eclipse.jst.j2ee.commonarchivecore.internal.exception.OpenFailureException;
import org.eclipse.jst.j2ee.componentcore.EnterpriseArtifactEdit;
import org.eclipse.jst.j2ee.internal.J2EEConstants;
import org.eclipse.jst.j2ee.internal.common.XMLResource;
import org.eclipse.jst.j2ee.internal.componentcore.JavaEEBinaryComponentHelper;
import org.eclipse.jst.j2ee.internal.jca.archive.operations.ConnectorComponentLoadStrategyImpl;
import org.eclipse.jst.j2ee.internal.project.J2EEProjectUtilities;
import org.eclipse.jst.j2ee.jca.Connector;
import org.eclipse.jst.j2ee.jca.ConnectorResource;
import org.eclipse.jst.j2ee.jca.JcaFactory;
import org.eclipse.jst.j2ee.model.IModelProvider;
import org.eclipse.jst.j2ee.project.JavaEEProjectUtilities;
import org.eclipse.wst.common.componentcore.ArtifactEdit;
import org.eclipse.wst.common.componentcore.ComponentCore;
import org.eclipse.wst.common.componentcore.ModuleCoreNature;
import org.eclipse.wst.common.componentcore.UnresolveableURIException;
import org.eclipse.wst.common.componentcore.internal.ArtifactEditModel;
import org.eclipse.wst.common.componentcore.internal.BinaryComponentHelper;
import org.eclipse.wst.common.componentcore.internal.StructureEdit;
import org.eclipse.wst.common.componentcore.internal.impl.ModuleURIUtil;
import org.eclipse.wst.common.componentcore.internal.util.IArtifactEditFactory;
import org.eclipse.wst.common.componentcore.resources.IVirtualComponent;
/**
* Provides access to J2EE Connector models using the ArtifactEdit pattern.
* <p>
* Clients should use getConnectorArtifactForRead/Write() to acquire an instance of the correct
* artifact edit class.
* </p>
*/
public class ConnectorArtifactEdit extends EnterpriseArtifactEdit implements IArtifactEditFactory {
private static final String CONNECTOR_CONTENT_TYPE = "org.eclipse.jst.j2ee.connectorDD"; //$NON-NLS-1$
/**
* <p>
* Identifier used to link ConnectorArtifactEdit to a ConnectorEditAdapterFactory
* {@see ConnectorEditAdapterFactory} stored in an AdapterManger (@see AdapterManager)
* </p>
*/
public static final Class ADAPTER_TYPE = ConnectorArtifactEdit.class;
/**
*
*/
public ConnectorArtifactEdit() {
super();
}
public ConnectorArtifactEdit(IVirtualComponent aModule) {
super(aModule);
}
@Override
protected BinaryComponentHelper initBinaryComponentHelper(IVirtualComponent binaryModule) {
return new JavaEEBinaryComponentHelper(binaryModule);
}
/**
* @param aHandle
* @param toAccessAsReadOnly
* @throws IllegalArgumentException
*/
public ConnectorArtifactEdit(IProject aProject, boolean toAccessAsReadOnly) throws IllegalArgumentException {
super(aProject, toAccessAsReadOnly);
}
public ConnectorArtifactEdit(IProject aProject, boolean toAccessAsReadOnly, boolean forCreate) throws IllegalArgumentException {
super(aProject, toAccessAsReadOnly, forCreate, J2EEProjectUtilities.JCA);
}
/**
* <p>
* Creates an instance facade for the given {@see ArtifactEditModel}.
* </p>
*
* @param anArtifactEditModel
*/
public ConnectorArtifactEdit(ArtifactEditModel anArtifactEditModel) {
super(anArtifactEditModel);
}
/**
* <p>
* Creates an instance facade for the given {@see ArtifactEditModel}
* </p>
* <p>
* Note: This method is for internal use only. Clients should not call this method.
* </p>
*
* @param aNature
* A non-null {@see ModuleCoreNature}for an accessible project
* @param aModule
* A non-null {@see WorkbenchComponent}pointing to a module from the given
* {@see ModuleCoreNature}
*/
protected ConnectorArtifactEdit(ModuleCoreNature aNature, IVirtualComponent aModule, boolean toAccessAsReadOnly) {
super(aNature, aModule, toAccessAsReadOnly);
}
/**
* @return ConnectorResource from (@link getDeploymentDescriptorResource())
*/
public ConnectorResource getConnectorXmiResource() {
return (ConnectorResource) getDeploymentDescriptorResource();
}
/**
* <p>
* Retrieves the underlying resource from the ArtifactEditModel using defined URI.
* </p>
*
* @return Resource
*/
@Override
public Resource getDeploymentDescriptorResource() {
if (isBinary()) {
return getBinaryComponentHelper().getResource(J2EEConstants.RAR_DD_URI_OBJ);
}
return getArtifactEditModel().getResource(J2EEConstants.RAR_DD_URI_OBJ);
}
/**
* <p>
* Obtains the Connector (@see Connector) root object from the ConnectorResource. If the root
* object does not exist, then one is created (@link
* addConnectorIfNecessary(getConnectorXmiResource())). The root object contains all other
* resource defined objects.
* </p>
*
* @return EObject
*/
@Override
public EObject getDeploymentDescriptorRoot() {
List contents = getDeploymentDescriptorResource().getContents();
if (contents.size() > 0)
return (EObject) contents.get(0);
if (isBinary()) {
return null;
}
addConnectorIfNecessary(getConnectorXmiResource());
return (EObject) contents.get(0);
}
/**
* <p>
* Creates a deployment descriptor root object (Connector) and populates with data. Adds the
* root object to the deployment descriptor resource.
* </p>
* <p>
*
* @param aModule
* A non-null pointing to a {@see XMLResource} Note: This method is typically used
* for JUNIT - move?
* </p>
*/
protected void addConnectorIfNecessary(XMLResource aResource) {
if (isBinary()) {
throwAttemptedBinaryEditModelAccess();
}
if (aResource != null && aResource.getContents().isEmpty()) {
Connector connector = JcaFactory.eINSTANCE.createConnector();
aResource.getContents().add(connector);
URI moduleURI = getArtifactEditModel().getModuleURI();
try {
connector.setDisplayName(StructureEdit.getDeployedName(moduleURI));
} catch (UnresolveableURIException e) {
// Ignore
}
aResource.setID(connector, J2EEConstants.CONNECTOR_ID);
// TODO add more mandatory elements
}
}
/**
* <p>
* Returns an instance facade to manage the underlying edit model for the given
* {@see WorkbenchComponent}. Instances of ArtifactEdit that are returned through this method
* must be {@see #dispose()}ed of when no longer in use.
* </p>
* <p>
* Use to acquire an ArtifactEdit facade for a specific {@see WorkbenchComponent} that
* will not be used for editing. Invocations of any save*() API on an instance returned from
* this method will throw exceptions.
* </p>
* <p>
* <b>The following method may return null. </b>
* </p>
*
* @param aModule
* A valid {@see WorkbenchComponent} with a handle that resolves to an
* accessible project in the workspace
* @return An instance of ArtifactEdit that may only be used to read the underlying content
* model
*/
public static ConnectorArtifactEdit getConnectorArtifactEditForRead(IProject aProject) {
ConnectorArtifactEdit artifactEdit = null;
try {
if (isValidConnectorModule(ComponentCore.createComponent(aProject)))
artifactEdit = new ConnectorArtifactEdit(aProject, true, false);
} catch (Exception e) {
artifactEdit = null;
}
return artifactEdit;
}
/**
* <p>
* Returns an instance facade to manage the underlying edit model for the given
* {@see WorkbenchComponent}. Instances of ArtifactEdit that are returned through this method
* must be {@see #dispose()}ed of when no longer in use.
* </p>
* <p>
* Use to acquire an ArtifactEdit facade for a specific {@see WorkbenchComponent} that
* will be used for editing.
* </p>
* <p>
* <b>The following method may return null. </b>
* </p>
*
* @param aModule
* A valid {@see WorkbenchComponent} with a handle that resolves to an
* accessible project in the workspace
* @return An instance of ArtifactEdit that may be used to modify and persist changes to the
* underlying content model
*/
public static ConnectorArtifactEdit getConnectorArtifactEditForWrite(IProject aProject) {
ConnectorArtifactEdit artifactEdit = null;
try {
if (isValidConnectorModule(ComponentCore.createComponent(aProject)))
artifactEdit = new ConnectorArtifactEdit(aProject, false, false);
} catch (Exception e) {
artifactEdit = null;
}
return artifactEdit;
}
/**
* <p>
* Returns an instance facade to manage the underlying edit model for the given
* {@see WorkbenchComponent}. Instances of ConnectorArtifactEdit that are returned through this
* method must be {@see #dispose()}ed of when no longer in use.
* </p>
* <p>
* Use to acquire an ConnectorArtifactEdit facade for a specific {@see WorkbenchComponent} that
* will not be used for editing. Invocations of any save*() API on an instance returned from
* this method will throw exceptions.
* </p>
* <p>
* <b>This method may return null. </b>
* </p>
* <p>
* Note: This method is for internal use only. Clients should not call this method.
* </p>
*
* @param aModule
* A valid {@see WorkbenchComponent} with a handle that resolves to an
* accessible project in the workspace
* @return An instance of ConnectorArtifactEdit that may only be used to read the underlying
* content model
* @throws UnresolveableURIException
* could not resolve uri.
*/
public static ConnectorArtifactEdit getConnectorArtifactEditForRead(IVirtualComponent aModule) {
if (aModule == null)
return null;
if (aModule.isBinary()) {
return new ConnectorArtifactEdit(aModule);
}
return getConnectorArtifactEditForRead(aModule.getProject());
}
/**
* <p>
* Returns an instance facade to manage the underlying edit model for the given
* {@see WorkbenchComponent}. Instances of ConnectorArtifactEdit that are returned through this
* method must be {@see #dispose()}ed of when no longer in use.
* </p>
* <p>
* Use to acquire an ConnectorArtifactEdit facade for a specific {@see WorkbenchComponent} that
* will be used for editing.
* </p>
* <p>
* <b>This method may return null. </b>
* </p>
* <p>
* Note: This method is for internal use only. Clients should not call this method.
* </p>
*
* @param aModule
* A valid {@see WorkbenchComponent} with a handle that resolves to an
* accessible project in the workspace
* @return An instance of ConnectorArtifactEdit that may be used to modify and persist changes
* to the underlying content model
*/
public static ConnectorArtifactEdit getConnectorArtifactEditForWrite(IVirtualComponent aModule) {
if (aModule == null || aModule.isBinary())
return null;
return getConnectorArtifactEditForWrite(aModule.getProject());
}
/**
* @param module
* A {@see WorkbenchComponent}
* @return True if the supplied module
* {@see ArtifactEdit#isValidEditableModule(WorkbenchComponent)}and the moduleTypeId is
* a JST module
*/
public static boolean isValidConnectorModule(IVirtualComponent aModule) throws UnresolveableURIException {
if (!isValidEditableModule(aModule))
return false;
/* and match the JST_Connector_MODULE type */
return JavaEEProjectUtilities.isJCAProject(aModule.getProject());
}
/**
* <p>
* Retrieves J2EE version information from ConnectorResource.
* </p>
*
* @return an integer representation of a J2EE Spec version
*/
@Override
public int getJ2EEVersion() {
return getConnectorXmiResource().getJ2EEVersionID();
}
/**
* @return Connector from (@link getDeploymentDescriptorRoot())
*/
public Connector getConnector() {
return (Connector) getDeploymentDescriptorRoot();
}
@Override
public EObject createModelRoot() {
if (isBinary()) {
throwAttemptedBinaryEditModelAccess();
}
return createModelRoot(getJ2EEVersion());
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jst.j2ee.internal.modulecore.util.EnterpriseArtifactEdit#createModelRoot(java.lang.Integer)
*/
@Override
public EObject createModelRoot(int version) {
if (isBinary()) {
throwAttemptedBinaryEditModelAccess();
}
ConnectorResource res = (ConnectorResource) getDeploymentDescriptorResource();
res.setModuleVersionID(version);
addConnectorIfNecessary(res);
return ((ConnectorResource) getDeploymentDescriptorResource()).getRootObject();
}
public ArtifactEdit createArtifactEditForRead(IVirtualComponent aComponent) {
return getConnectorArtifactEditForRead(aComponent);
}
public ArtifactEdit createArtifactEditForWrite(IVirtualComponent aComponent) {
return getConnectorArtifactEditForWrite(aComponent);
}
@Override
public Archive asArchive(boolean includeSource, boolean includeClasspathComponents) throws OpenFailureException {
if (isBinary()) {
JavaEEBinaryComponentHelper helper = (JavaEEBinaryComponentHelper)getBinaryComponentHelper();
return helper.accessLegacyArchive();
}
ConnectorComponentLoadStrategyImpl loader = new ConnectorComponentLoadStrategyImpl(getComponent(), includeClasspathComponents);
loader.setExportSource(includeSource);
String uri = ModuleURIUtil.getHandleString(getComponent());
return CommonarchiveFactory.eINSTANCE.openRARFile(loader, uri);
}
public static void createDeploymentDescriptor(IProject project, int version) {
ConnectorArtifactEdit jcaEdit = new ConnectorArtifactEdit(project, false, true);
try {
jcaEdit.createModelRoot(version);
jcaEdit.save(null);
} finally {
jcaEdit.dispose();
}
}
@Override
public IModelProvider create(IProject project) {
return getConnectorArtifactEditForRead(project);
}
@Override
public IModelProvider create(IVirtualComponent component) {
return getConnectorArtifactEditForRead(component);
}
@Override
public void modify(Runnable runnable, IPath modelPath) {
setWritableEdit(getConnectorArtifactEditForWrite(getProject()));
try{
runnable.run();
if( getWritableEdit() != null ){
// Always save regardless of resource path passed - Artifactedits save resources as a unit
getWritableEdit().saveIfNecessary( new NullProgressMonitor() );
}
} finally { //Properly dispose the write artifact edit
getWritableEdit().dispose();
setWritableEdit(null);
}
}
@Override
protected String getContentTypeDescriber() {
return CONNECTOR_CONTENT_TYPE;
}
@Override
protected URI getRootURI() {
return J2EEConstants.RAR_DD_URI_OBJ;
}
}