| /******************************************************************************* |
| * Copyright (c) 2005 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.jst.j2ee.componentcore.EnterpriseArtifactEdit; |
| import org.eclipse.jst.j2ee.internal.J2EEConstants; |
| import org.eclipse.jst.j2ee.internal.project.J2EEProjectUtilities; |
| import org.eclipse.jst.j2ee.webservice.wsclient.WebServicesClient; |
| import org.eclipse.jst.j2ee.webservice.wsclient.WebServicesResource; |
| import org.eclipse.jst.j2ee.webservice.wsclient.Webservice_clientFactory; |
| 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.resources.IVirtualComponent; |
| |
| /** |
| * <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 WSCDDArtifactEdit 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 = WSCDDArtifactEdit.class; |
| |
| /** |
| * @param aHandle |
| * @param toAccessAsReadOnly |
| * @throws IllegalArgumentException |
| */ |
| public WSCDDArtifactEdit(IProject aProject, boolean toAccessAsReadOnly) throws IllegalArgumentException { |
| super(aProject, toAccessAsReadOnly); |
| // TODO Auto-generated constructor stub |
| } |
| |
| /** |
| * <p> |
| * Creates an instance facade for the given {@see ArtifactEditModel}. |
| * </p> |
| * |
| * @param anArtifactEditModel |
| */ |
| public WSCDDArtifactEdit(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} |
| */ |
| public WSCDDArtifactEdit(ModuleCoreNature aNature, IVirtualComponent aModule, boolean toAccessAsReadOnly) { |
| super(aNature, aModule, toAccessAsReadOnly); |
| } |
| |
| /** |
| * @return WsddResource from (@link getDeploymentDescriptorResource()) |
| */ |
| |
| public WebServicesResource getWscddXmiResource() { |
| return (WebServicesResource) getDeploymentDescriptorResource(); |
| } |
| |
| /** |
| * <p> |
| * Retrieves J2EE version information from EJBResource. |
| * </p> |
| * |
| * @return an integer representation of a J2EE Spec version |
| */ |
| |
| public int getJ2EEVersion() { |
| return getWscddXmiResource().getJ2EEVersionID(); |
| } |
| |
| /** |
| * <p> |
| * Retrieves the underlying resource from the ArtifactEditModel using |
| * defined URI. |
| * </p> |
| * |
| * @return Resource |
| */ |
| |
| public Resource getDeploymentDescriptorResource() { |
| if (getArtifactEditModel()!=null) |
| return getArtifactEditModel().getResource(getWebServicesClientXmlResourceURI()); |
| return null; |
| } |
| |
| public URI getWebServicesClientXmlResourceURI() { |
| URI resourceURI = J2EEConstants.WEB_SERVICES_CLIENT_WEB_INF_DD_URI_OBJ; |
| if (isValidAppClientModule(ComponentCore.createComponent(getProject()))) |
| resourceURI = J2EEConstants.WEB_SERVICES_CLIENT_META_INF_DD_URI_OBJ; |
| else if (isValidEJBModule(ComponentCore.createComponent(getProject()))) |
| resourceURI = J2EEConstants.WEB_SERVICES_CLIENT_META_INF_DD_URI_OBJ; |
| return resourceURI; |
| } |
| |
| /** |
| * @return WebServices from (@link getDeploymentDescriptorRoot()) |
| */ |
| public WebServicesClient getWebServicesClient() { |
| return (WebServicesClient) 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() { |
| List contents = getDeploymentDescriptorResource().getContents(); |
| if (contents.size() > 0) |
| return (EObject) contents.get(0); |
| addWebServicesClientIfNecessary(getWscddXmiResource()); |
| 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 addWebServicesClientIfNecessary(WebServicesResource aResource) { |
| if (aResource != null) { |
| if (aResource.getContents() == null || aResource.getContents().isEmpty()) { |
| WebServicesClient ws_client = Webservice_clientFactory.eINSTANCE.createWebServicesClient(); |
| aResource.getContents().add(ws_client); |
| } |
| aResource.getContents().get(0); |
| getArtifactEditModel().getModuleURI(); |
| try { |
| aResource.saveIfNecessary(); |
| } catch (Exception e) { |
| // TODO Auto-generated catch block |
| e.printStackTrace(); |
| } |
| } |
| } |
| |
| /** |
| * <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 WSCDDArtifactEdit getWSCDDArtifactEditForRead(IProject aProject) { |
| WSCDDArtifactEdit artifactEdit = null; |
| try { |
| artifactEdit = new WSCDDArtifactEdit(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 WSCDDArtifactEdit getWSCDDArtifactEditForWrite(IProject aProject) { |
| WSCDDArtifactEdit artifactEdit = null; |
| try { |
| artifactEdit = new WSCDDArtifactEdit(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 WSCDDArtifactEdit getWSCDDArtifactEditForRead(IVirtualComponent aModule) { |
| |
| IProject project = aModule.getProject(); |
| ModuleCoreNature nature = ModuleCoreNature.getModuleCoreNature(project); |
| if (aModule != null && isValidWSCDDModule(aModule)) |
| return new WSCDDArtifactEdit(nature, aModule, true); |
| return null; |
| } |
| |
| /** |
| * <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 WSCDDArtifactEdit getWSCDDArtifactEditForWrite(IVirtualComponent aModule) { |
| IProject project = aModule.getProject(); |
| ModuleCoreNature nature = ModuleCoreNature.getModuleCoreNature(project); |
| if (aModule != null && isValidWSCDDModule(aModule)) |
| return new WSCDDArtifactEdit(nature, aModule, false); |
| return null; |
| } |
| |
| /** |
| * @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 aComponent !=null && J2EEProjectUtilities.isEJBProject(aComponent.getProject()); |
| } |
| |
| /** |
| * @param component |
| * A {@see IVirtualComponent} |
| * @return True if the supplied module |
| * {@see ArtifactEdit#isValidWSDDModule(IVirtualComponent)}and the |
| * moduleTypeId is a JST module |
| */ |
| protected static boolean isValidWSCDDModule(IVirtualComponent aComponent) { |
| return (isValidAppClientModule(aComponent) || isValidWebModule(aComponent) || isValidEJBModule(aComponent)); |
| } |
| |
| /** |
| * @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 aComponent !=null && J2EEProjectUtilities.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 aComponent !=null && J2EEProjectUtilities.isApplicationClientProject(aComponent.getProject()); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.jst.j2ee.internal.modulecore.util.EnterpriseArtifactEdit#createModelRoot() |
| */ |
| public EObject createModelRoot() { |
| return createModelRoot(getJ2EEVersion()); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.jst.j2ee.internal.modulecore.util.EnterpriseArtifactEdit#createModelRoot(int) |
| */ |
| public EObject createModelRoot(int version) { |
| WebServicesResource res = getWscddXmiResource(); |
| res.setModuleVersionID(version); |
| addWebServicesClientIfNecessary(res); |
| return getWebServicesClient(); |
| } |
| } |