| RE: [wtp-incubator-dev] Integrating the JAX-WS DOM Tools contribution |
|
Hi Danail, >The “org.eclipse.jst.ws.jaxws.dom.runtime.domruntimes” extension point schema allows specifying a list of project facet versions. >So if one would like to enable the WS model tooling for another facet, then the facet needs to be declared in the extension point contribution. It looks like the approve project method in org.eclipse.jst.ws.jaxws.dom.runtime.persistence.JaxWsWorkspaceResource will only allow jst.web version 2.5. Any objections in updating to support 2.4 projects as well? >As a first step I could switch the WS model validation from WST to APT. How would this switch work? Remove the EMF validation constraints, turn on APT processing on the project and check for errors? >Then we need to collect all the validation constraints CXF and WS model provide and eliminate duplicates. I'll take a look at the message property files and code later on and write up what's common to both and what's missing from the JDT-APT rules. >I think that it makes sense to move the complete validation logic to a dedicated plugin (e.g. org.eclipse.jst.ws.jaxws.validation) in order to have validation in one place. Possibly, let's see what's missing first and then decide. All the JDT-APT validation logic currently resides in org.eclipse.jst.ws.jaxws.core. >In case we do not manage to do all of the above, could we consider removing duplicate validation for M7 (i.e. could this be considered as non API change)? As long as that doesn't involve changes to extension points, API code or UI changes then yes. Thanks, Shane From: danail.branekov@xxxxxxx To: wtp-incubator-dev@xxxxxxxxxxx Date: Wed, 24 Feb 2010 15:00:38 +0100 Subject: RE: [wtp-incubator-dev] Integrating the JAX-WS DOM Tools contribution Hi Shane,
You have outlined the WST validation steps one needs to do precisely. > Using WST/EMF Validation If we want to provide rules for non-modeled objects e.g. javax.xml.ws.WebServiceProvider what's the best way to do that Ideally the web service model should contain all that web service relevant data. Currently this is not the case but the model could be extended in future. The direct answer to your question is that validating non-model objects seems to be impossible.
> Using the exisitng org.eclipse.jst.ws.jaxws.dom.runtime.domruntimes extension the WST/EMF Validation and the JAX-WS Web Services nodes in the Project Explorer are currently tied to jst.web 2.5 projects. What would we have to do to make both available for jst.web 2.4 projects? Provide another extension point for 2.4 projects? The “org.eclipse.jst.ws.jaxws.dom.runtime.domruntimes” extension point schema allows specifying a list of project facet versions. So if one would like to enable the WS model tooling for another facet, then the facet needs to be declared in the extension point contribution.
Having in mind that M6 is just over the corner I would propose to go ahead with the APT validation way. As a first step I could switch the WS model validation from WST to APT. Then we need to collect all the validation constraints CXF and WS model provide and eliminate duplicates. I think that it makes sense to move the complete validation logic to a dedicated plugin (e.g. org.eclipse.jst.ws.jaxws.validation) in order to have validation in one place. In case we do not manage to do all of the above, could we consider removing duplicate validation for M7 (i.e. could this be considered as non API change)?
Regards, Danail
From: wtp-incubator-dev-bounces@xxxxxxxxxxx
[mailto:wtp-incubator-dev-bounces@xxxxxxxxxxx] On Behalf Of shane clarke
We need to make that decision on which validation method to move forward with.
WTP 3.2.0 M6 is API and UI freeze.
So I'd like to get this done as soon as possible to enable any changes to extension points, dependencies, unit tests, adding more rules etc..
In
an effort to move the discussion along lets take a look at the validation
options from an end-users perspective.
Danail if i've stated anything that's wrong below about the WST/EMF Validation mechanism please correct me. For JDT-APT.
<extension point="org.eclipse.jst.ws.annotations.core.annotationProcessor"> <processor annotation="javax.jws.WebService" class="com.example.ValidatePortName"> <description> Validate a WebService portName attribute </description> </processor> <extension>
2. Provide a class that extends org.eclipse.jst.ws.annotations.core.processor.AbstractAnnotationProcessor and implement the process() method.
import org.eclipse.jst.ws.annotations.core.processor.AbstractAnnotationProcessor; import org.eclipse.jst.ws.annotations.core.utils.AnnotationUtils;
import com.sun.mirror.declaration.AnnotationMirror; import com.sun.mirror.declaration.AnnotationTypeDeclaration; import com.sun.mirror.declaration.AnnotationValue; import com.sun.mirror.declaration.Declaration;
public class ValidatePortName extends AbstractAnnotationProcessor {
@Override public void process() { AnnotationTypeDeclaration annotationDeclaration = (AnnotationTypeDeclaration) environment .getTypeDeclaration(javax.jws.WebService.class.getName());
Collection<Declaration> annotatedTypes = environment.getDeclarationsAnnotatedWith(annotationDeclaration);
for (Declaration declaration : annotatedTypes) { AnnotationMirror webService = AnnotationUtils.getAnnotation(declaration, javax.jws.WebService.class); AnnotationValue name = AnnotationUtils.getAnnotationValue(webService, "portName"); if (name.getValue().equals("eclipse")) { printError(name.getPosition(), "An informative error message"); } } } }
For WST/EMF-Validation:
We can use the JAX-WS DOM model and the existing org.eclipse.jst.ws.jaxws.dom.runtime.validation.JaxWsDomValidator.
<extension point="org.eclipse.emf.validation.constraintProviders"> <constraintProvider cache="true" class="org.example.ValidationConstraintProvider"> <package namespaceUri="http:///org/eclipse/jst/ws/jaxws/dom/runtime/dom.ecore"/> </constraintProvider> </extension>
3. Provide a class that implements the org.eclipse.emf.validation.service.IModelConstraintProvider interface that returns the constraint.
import org.eclipse.emf.common.notify.Notification; import org.eclipse.emf.ecore.EObject; import org.eclipse.emf.validation.model.IModelConstraint; import org.eclipse.emf.validation.service.IModelConstraintProvider; import org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebService; import org.eclipse.jst.ws.jaxws.dom.runtime.util.DomSwitch;
public class ValidationConstraintProvider implements IModelConstraintProvider {
private final DomSwitch<Collection<IModelConstraint>> domSwitch;
public ValidationConstraintProvider() { domSwitch = createDomSwitch(); }
@SuppressWarnings("unchecked") public Collection getBatchConstraints(EObject eObject, Collection constraints) { Collection<IModelConstraint> modelConstraints = domSwitch.doSwitch(eObject); if (modelConstraints != null) { constraints.addAll(modelConstraints); } return constraints; }
@SuppressWarnings("unchecked") public Collection getLiveConstraints(Notification arg0, Collection constraints) { return constraints; }
private DomSwitch<Collection<IModelConstraint>> createDomSwitch() { return new DomSwitch<Collection<IModelConstraint>>() { @Override public Collection<IModelConstraint> caseIWebService(IWebService object) { Set<IModelConstraint> constraints = new HashSet<IModelConstraint>(); constraints.add(new ValidationConstraint()); return constraints; } }; } }
4. Code the constraint that contains the validation logic:
import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IStatus; import org.eclipse.emf.validation.IValidationContext; import org.eclipse.jst.ws.jaxws.dom.runtime.api.IWebService; import org.eclipse.jst.ws.jaxws.dom.runtime.validation.AbstractValidationConstraint;
public class ValidationConstraint extends AbstractValidationConstraint {
public ValidationConstraint() { super(new ValidationConstraintDescriptor()); }
@Override protected IStatus doValidate(IValidationContext ctx) throws CoreException { IWebService webService = (IWebService) ctx.getTarget(); if (webService.getPortName().equals("eclipse")) { return createStatus(webService, "another informative message", "javax.jws.WebService", "portName"); } return createOkStatus(webService); }
}
5. We'll also need a descriptor to describe the problem.
import org.eclipse.emf.validation.model.ConstraintSeverity; import org.eclipse.jst.ws.jaxws.dom.runtime.validation.DomValidationConstraintDescriptor;
public class ValidationConstraintDescriptor extends DomValidationConstraintDescriptor {
public String getId() { return "validation.constraint"; }
public String getPluginId() { return Activator.PLUGIN_ID; }
public ConstraintSeverity getSeverity() { return ConstraintSeverity.ERROR; }
public int getStatusCode() { return -99; } }
That's a lot of overhead to add one constraint . Granted the above ValidationConstraintProvider and ValidationConstraintDescriptor can be resued, added to when adding more constraints to your plug-in.
Questions:
Hotmail: Powerful Free email with security by Microsoft. Get it now. Hotmail: Trusted email with powerful SPAM protection. Sign up now. |