/*******************************************************************************
* 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.internal.webservice.componentcore.util;
import java.util.List;
import org.eclipse.core.resources.IProject;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.jst.j2ee.componentcore.EnterpriseArtifactEdit;
import org.eclipse.jst.j2ee.internal.webservice.plugin.WebServicePlugin;
import org.eclipse.jst.j2ee.project.JavaEEProjectUtilities;
import org.eclipse.jst.j2ee.webservice.jaxrpcmap.JavaWSDLMapping;
import org.eclipse.jst.j2ee.webservice.jaxrpcmap.JaxrpcmapFactory;
import org.eclipse.jst.j2ee.webservice.jaxrpcmap.JaxrpcmapResource;
import org.eclipse.jst.j2ee.webservice.jaxrpcmap.JaxrpcmapResourceFactory;
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.impl.WTPResourceFactoryRegistry;
import org.eclipse.wst.common.componentcore.resources.IVirtualComponent;
import org.eclipse.wst.common.internal.emf.resource.RendererFactory;
/**
* <p>
* WSDDArtifactEdit obtains a WS Deployment Descriptor metamodel specifec data from a
* {@see org.eclipse.jst.j2ee.ejb.EJBResource} which stores the metamodel. The
* {@see org.eclipse.jst.j2ee.ejb.EJBResource} is retrieved from the
* {@see org.eclipse.wst.common.modulecore.ArtifactEditModel} using a constant {@see
* J2EEConstants#EJBJAR_DD_URI_OBJ}. The defined methods extract data or manipulate the contents of
* the underlying resource.
* </p>
*
*/
public class JaxRPCMapArtifactEdit extends EnterpriseArtifactEdit {
/**
* <p>
* Identifier used to link WSDDArtifactEdit to a WsddAdapterFactory {@see
* WsddAdapterFactory} stored in an AdapterManger (@see AdapterManager)
* </p>
*/
public static final Class ADAPTER_TYPE = JaxRPCMapArtifactEdit.class;
/**
* @param aHandle
* @param toAccessAsReadOnly
* @throws IllegalArgumentException
*/
public JaxRPCMapArtifactEdit(IProject aProject, boolean toAccessAsReadOnly) throws IllegalArgumentException {
super(aProject, toAccessAsReadOnly);
}
/**
* <p>
* Creates an instance facade for the given {@see ArtifactEditModel}.
* </p>
*
* @param anArtifactEditModel
*/
public JaxRPCMapArtifactEdit(ArtifactEditModel model) {
super(model);
}
/**
* <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 JaxRPCMapArtifactEdit(ModuleCoreNature aNature, IVirtualComponent aModule, boolean toAccessAsReadOnly) {
super(aNature, aModule, toAccessAsReadOnly);
}
/**
*
* @return WsddResource from (@link getDeploymentDescriptorResource())
*
*/
public JaxrpcmapResource getJaxRPCMapXmiResource(String mappingFilePathURI) {
URI uri = URI.createPlatformResourceURI(mappingFilePathURI);
ResourceSet resSet = getArtifactEditModel().getResourceSet();
WTPResourceFactoryRegistry registry = (WTPResourceFactoryRegistry) resSet.getResourceFactoryRegistry();
registry.registerLastFileSegment(uri.lastSegment(), new JaxrpcmapResourceFactory(RendererFactory.getDefaultRendererFactory()));
JaxrpcmapResource jaxrpcmapRes = (JaxrpcmapResource) resSet.getResource(uri, true);
return jaxrpcmapRes;
}
/**
* <p>
* Retrieves J2EE version information from EJBResource.
* </p>
*
* @return an integer representation of a J2EE Spec version
*
*/
public int getJ2EEVersion(String mappingFilePathURI) {
return getJaxRPCMapXmiResource(mappingFilePathURI).getJ2EEVersionID();
}
/**
* <p>
* Retrieves the underlying resource from the ArtifactEditModel using defined URI.
* </p>
*
* @return Resource
*
*/
public Resource getDeploymentDescriptorResource(String mappingFilePathURI) {
return getJaxRPCMapXmiResource(mappingFilePathURI);
}
/**
*
* @return WebServices from (@link getDeploymentDescriptorRoot())
*
*/
public JavaWSDLMapping getJavaWSDLMapping() {
return (JavaWSDLMapping) getDeploymentDescriptorRoot();
}
/**
* <p>
* Obtains the WebServices (@see WebServices) root object from the WsddResource. If the root object does
* not exist, then one is created (@link addEJBJarIfNecessary(getEJBJarXmiResource())).
* The root object contains all other resource defined objects.
* </p>
*
* @return EObject
*
*/
public EObject getDeploymentDescriptorRoot(String mappingFilePathURI) {
List contents = getDeploymentDescriptorResource(mappingFilePathURI).getContents();
if (contents.size() > 0)
return (EObject) contents.get(0);
addJavaWSDLMappingIfNecessary(getJaxRPCMapXmiResource(mappingFilePathURI));
return (EObject) contents.get(0);
}
/**
* <p>
* Creates a deployment descriptor root object (WebServices) 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 addJavaWSDLMappingIfNecessary(JaxrpcmapResource aResource) {
if (aResource != null) {
if(aResource.getContents() == null || aResource.getContents().isEmpty()) {
JavaWSDLMapping map = JaxrpcmapFactory.eINSTANCE.createJavaWSDLMapping();
aResource.getContents().add(map);
}
aResource.getContents().get(0);
getArtifactEditModel().getModuleURI();
try {
aResource.saveIfNecessary();
}
catch (Exception e) {
WebServicePlugin.logError(e);
}
}
}
/**
* <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 JaxRPCMapArtifactEdit getJaxRPCMapArtifactEditForRead(IProject aProject) {
JaxRPCMapArtifactEdit artifactEdit = null;
try {
artifactEdit = new JaxRPCMapArtifactEdit(aProject, true);
} catch (IllegalArgumentException iae) {
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 JaxRPCMapArtifactEdit getJaxRPCMapArtifactEditForWrite(IProject aProject) {
JaxRPCMapArtifactEdit artifactEdit = null;
try {
artifactEdit = new JaxRPCMapArtifactEdit(aProject, false);
} catch (IllegalArgumentException iae) {
artifactEdit = null;
}
return artifactEdit;
}
/**
* <p>
* Returns an instance facade to manage the underlying edit model for the given
* {@see WorkbenchComponent}. Instances of WSDDArtifactEdit that are returned through this method
* must be {@see #dispose()}ed of when no longer in use.
* </p>
* <p>
* Use to acquire an WSDDArtifactEdit 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 WSDDArtifactEdit that may only be used to read the underlying content
* model
* @throws UnresolveableURIException
* could not resolve uri.
*/
public static JaxRPCMapArtifactEdit getJaxRPCMapArtifactEditForRead(IVirtualComponent aModule) {
IProject project = aModule.getProject();
ModuleCoreNature nature = ModuleCoreNature.getModuleCoreNature(project);
return new JaxRPCMapArtifactEdit(nature, aModule, true);
}
/**
* <p>
* Returns an instance facade to manage the underlying edit model for the given
* {@see WorkbenchComponent}. Instances of EJBArtifactEdit that are returned through this method
* must be {@see #dispose()}ed of when no longer in use.
* </p>
* <p>
* Use to acquire an WSDDArtifactEdit 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 WSDDArtifactEdit that may be used to modify and persist changes to the
* underlying content model
*/
public static JaxRPCMapArtifactEdit getJaxRPCMapArtifactEditForWrite(IVirtualComponent aModule) {
IProject project = aModule.getProject();
ModuleCoreNature nature = ModuleCoreNature.getModuleCoreNature(project);
return new JaxRPCMapArtifactEdit(nature, aModule, false);
}
/**
* @param component
* A {@see IVirtualComponent}
* @return True if the supplied module
* {@see ArtifactEdit#isValidEditableModule(IVirtualComponent)}and the moduleTypeId is a
* JST module
*/
public static boolean isValidEJBModule(IVirtualComponent aComponent) {
return JavaEEProjectUtilities.isEJBProject(aComponent.getProject());
}
/**
* @param component
* A {@see IVirtualComponent}
* @return True if the supplied module
* {@see ArtifactEdit#isValidEditableModule(IVirtualComponent)}and the moduleTypeId is a
* JST module
*/
public static boolean isValidWebModule(IVirtualComponent aComponent) {
return JavaEEProjectUtilities.isDynamicWebProject(aComponent.getProject());
}
/**
* @param component
* A {@see IVirtualComponent}
* @return True if the supplied module
* {@see ArtifactEdit#isValidEditableModule(IVirtualComponent)}and the moduleTypeId is a
* JST module
*/
public static boolean isValidAppClientModule(IVirtualComponent aComponent) {
return JavaEEProjectUtilities.isApplicationClientProject(aComponent.getProject());
}
/* (non-Javadoc)
* @see org.eclipse.jst.j2ee.internal.modulecore.util.EnterpriseArtifactEdit#createModelRoot()
*/
public EObject createModelRoot(String mappingFilePathURI) {
return createModelRoot(getJ2EEVersion(),mappingFilePathURI);
}
/* (non-Javadoc)
* @see org.eclipse.jst.j2ee.internal.modulecore.util.EnterpriseArtifactEdit#createModelRoot(int)
*/
public EObject createModelRoot(int version,String mappingFilePathURI) {
JaxrpcmapResource res = getJaxRPCMapXmiResource(mappingFilePathURI);
res.setModuleVersionID(version);
addJavaWSDLMappingIfNecessary(res);
return getJavaWSDLMapping();
}
@Override
public EObject createModelRoot() {
throw new IllegalArgumentException(WebServicePlugin.getMessage("_UI_JaxRPCMissingModel")); //$NON-NLS-1$
}
@Override
public EObject createModelRoot(int version) {
throw new IllegalArgumentException(WebServicePlugin.getMessage("_UI_JaxRPCMissingModel")); //$NON-NLS-1$
}
@Override
public Resource getDeploymentDescriptorResource() {
throw new IllegalArgumentException(WebServicePlugin.getMessage("_UI_JaxRPCMissingModel")); //$NON-NLS-1$
}
@Override
public int getJ2EEVersion() {
throw new IllegalArgumentException(WebServicePlugin.getMessage("_UI_JaxRPCMissingModel")); //$NON-NLS-1$
}
// [182417] This ArtifactEdit works for all project versions, so just return true.
@Override
protected boolean validProjectVersion(IProject project) {
return true;
}
}