1 / 25

Eclipse WTP Project Web Service Tools Inventory API

This document provides an overview of the Eclipse WTP Project Web Service Tools Inventory API, including the provisional API and its key features. It also lists the representative classes and their functionalities.

pbellanger
Download Presentation

Eclipse WTP Project Web Service Tools Inventory API

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript


  1. Eclipse WTP ProjectWeb Service ToolsInventory of Key Provisional API Chris Brealey 2005.04.29 Eclipse Foundation - www.eclipse.org

  2. Provisional API • Provisional API is provided for: • Web Services Framework • Command Framework • Environment Framework • The API in WTP 1.0 is all provisional instead of public because of the extreme youth of the API and the lack of any third-party extensions besides Apache Axis to help validate the design of the API. As the community begins extending the framework, the API can be validated, revised and promoted to public in a more appropriate release of the Eclipse WTP. • The classes summarized in the following pages are the most representative classes. Visit CVS for the rest. Eclipse Foundation - www.eclipse.org

  3. Web Service Framework • IWebServiceRuntime • IWebService • IWebServiceClient • IWebServiceTester • IWebServicePublisher • WebServiceInfo • WebServiceClientInfo • TestInfo • IObjectSelector Eclipse Foundation - www.eclipse.org

  4. IWebServiceRuntime • package org.eclipse.wst.ws.internal.provisional.wsrt • public interface IWebServiceRuntime{ public IWebService getWebService( WebServiceInfo info ); public IWebServiceClient getWebServiceClient( WebServiceClientInfo info ); public ICommandFactory announce( IWebService webService );} • Objects of this class represent known Web service runtimes, and act as factories for instances of known Web services and Web service clients. • Objects of this class can also contribute code that announces the successful deployment of a Web service, however, this method may move to IWebService. Eclipse Foundation - www.eclipse.org

  5. IWebService • package org.eclipse.wst.ws.internal.provisional.wsrt • public interface IWebService{ public WebServiceInfo getWebServiceInfo(); public ICommandFactory develop( Environment env, IContext ctx, ISelection sel, String project, String module, String earProject, String ear ); public ICommandFactory deploy( /* as above */ ); public ICommandFactory assemble( /* as above */ ); public ICommandFactory install( /* as above */ ); public ICommandFactory run( /* as above */ );} Eclipse Foundation - www.eclipse.org

  6. IWebServiceClient • package org.eclipse.wst.ws.internal.provisional.wsrt • public interface IWebServiceClient{ public WebServiceClientInfo getWebServiceClientInfo(); public ICommandFactory develop( Environment env, IContext ctx, ISelection sel, String project, String module, String earProject, String ear ); public ICommandFactory deploy( /* as above */ ); public ICommandFactory assemble( /* as above */ ); public ICommandFactory install( /* as above */ ); public ICommandFactory run( /* as above */ );} Eclipse Foundation - www.eclipse.org

  7. IWebServiceTester • package org.eclipse.wst.ws.internal.provisional.wsrt • public interface IWebServiceTester{ public ICommandFactory generate( TestInfo testInfo ); public ICommandFactory launch( TestInfo testInfo );} Eclipse Foundation - www.eclipse.org

  8. IWebServicePublisher • package org.eclipse.wst.ws.internal.provisional.wsrt • public interface IWebServicePublisher{ public ICommandFactory publish( Environment env, IWebService ws );} Eclipse Foundation - www.eclipse.org

  9. WebServiceInfo • package org.eclipse.wst.ws.internal.provisional.wsrt • public class WebServiceInfo... • WebServiceState state; • String servletLevel; • String j2eeLevel; • String serverFactoryId; • String serverInstanceId; • String webServiceRuntimeId; • String wsdlURL; • String endPointURL; • String implURL; Eclipse Foundation - www.eclipse.org

  10. WebServiceClientInfo • package org.eclipse.wst.ws.internal.provisional.wsrt • public class WebServiceClientInfo... • WebServiceState state; • String servletLevel; • String j2eeLevel; • String serverFactoryId; • String serverInstanceId; • String webServiceRuntimeId; • String wsdlURL; • String implURL; Eclipse Foundation - www.eclipse.org

  11. TestInfo • package org.eclipse.wst.ws.internal.provisional.wsrt • public class TestInfo... • String jspFolder; • String generationProject; • String serviceProject; • String proxyBean; • String setEndpointMethod; • String clientProject; • BooleanSelection[] methods; • String serviceServerTypeID; • String clientServerTypeID; • IServer serviceExistingServer; • IServer clientExistingServer; • List endpoints; • String wsdlServiceURL; Eclipse Foundation - www.eclipse.org

  12. IObjectSelector • package org.eclipse.wst.ws.internal.provisional.ui.wsrt • public interface IObjectSelector{ public void setInitialSelection( ISelection sel ); public ISelection getSelection(); public String getProject(); public Status validateSelection( ISelection sel ); public WidgetDataEvents addControls( Composite parent, Listener statusListener );} Eclipse Foundation - www.eclipse.org

  13. Command Framework • Command • ICommandFactory Eclipse Foundation - www.eclipse.org

  14. Command • package org.eclipse.wst.command.internal.provisional.env.core • public interface Command{ public String getName(); public String getDescription(); public boolean isUndoable(); public boolean isRedoable();public Status execute( Environment env ); public Status undo( Environment env ); public Status redo( Environment env );} • Intention: Converge with Eclipse commands and J2EE operations. Eclipse Foundation - www.eclipse.org

  15. ICommandFactory • package org.eclipse.wst.command.internal.provisional.env.core • public interface ICommandFactory extends Iterator { public Command getNextCommand();} Eclipse Foundation - www.eclipse.org

  16. Environment Framework • Environment • ProgressMonitor • StatusHandler • CommandManagerURIFactory • URIScheme • URI • INamedWidgetContributor • INamedWidgetContributorFactory Eclipse Foundation - www.eclipse.org

  17. Environment • package org.eclipse.wst.command.internal.provisional.env.core.common • public interface Environment{ public Log getLog (); public ProgressMonitor getProgressMonitor (); public StatusHandler getStatusHandler (); public URIFactory getURIFactory (); public CommandManager getCommandManager ();} Eclipse Foundation - www.eclipse.org

  18. ProgressMonitor • package org.eclipse.wst.command.internal.provisional.env.core.common • public interface ProgressMonitor{ public void report( String message ); public progressMonitor getChildProgressMonitor(); public boolean isCancelRequested();} Eclipse Foundation - www.eclipse.org

  19. StatusHandler • package org.eclipse.wst.command.internal.provisional.env.core.common • public interface StatusHandler{ public Choice report ( Status status, Choice[] choices ); public void report ( Status status ) throws StatusException; public void reportError( Status status ); public void reportInfo( Status status );} Eclipse Foundation - www.eclipse.org

  20. CommandManager • package org.eclipse.wst.command.internal.provisional.env.core.common • public interface CommandManager{ public boolean isUndoEnabled(); public DataMappingRegistry getMappingRegistry();} Eclipse Foundation - www.eclipse.org

  21. URIFactory • package org.eclipse.wst.command.internal.provisional.env.core.uri • public interface URIFactory{ public URI newURI( String uri ) throws URIException; public URI newURI( URL url ) throws URIException; public URIScheme newURIScheme( String schemeOrURI );} Eclipse Foundation - www.eclipse.org

  22. URIScheme • package org.eclipse.wst.command.internal.provisional.env.core.uri • public interface URIScheme{ public URI newURI ( String uri ) throws URIException; public URI newURI ( URL url ) throws URIException; public URI newURI ( URI uri ) throws URIException; public String toString (); public boolean isHierarchical (); public boolean isValid ( URI uri ); public Status validate ( URI uri );} Eclipse Foundation - www.eclipse.org

  23. URI • package org.eclipse.wst.command.internal.provisional.env.core.uri • public interface URI{ public String toString (); public URIScheme getURIScheme (); public boolean isPresent (); public boolean isLeaf (); public boolean isReadable (); public boolean isWritable (); public boolean isHierarchical (); public boolean isRelative (); public URI parent () throws URIException; public URI append ( URI relativeURI ) throws URIException; public InputStream getInputStream () throws URIException; public OutputStream getOutputStream () throws URIException; public void touchLeaf () throws URIException; public void touchFolder () throws URIException; public void erase () throws URIException; public void rename ( URI newURI ) throws URIException; public void visit ( URIVisitor uriVisitor ) throws URIException; public void visit ( URIVisitor uriVisitor, URIFilter uriFilter ) throws URIException; public URI[] list () throws URIException; public URI[] list ( URIFilter uriFilter ) throws URIException; public boolean isAvailableAsURL (); public URL asURL () throws URIException; public boolean isAvailableAsFile (); public File asFile () throws URIException; public String asString ();} Eclipse Foundation - www.eclipse.org

  24. INamedWidgetContributor • package org.eclipse.wst.command.internal.provisional.env.ui.widgets • public interface INamedWidgetContributor{ public WidgetContributorFactory getWidgetContributorFactory(); public String getName (); public String getDescription (); public String getTitle();} Eclipse Foundation - www.eclipse.org

  25. INamedWidgetContributorFactory • package org.eclipse.wst.command.internal.provisional.env.ui.widgets • public interface INamedWidgetContributorFactory{ public INamedWidgetContributor getFirstNamedWidget(); public INamedWidgetContributor getNextNamedWidget( INamedWidgetContributor widgetContributor ); public void registerDataMappings( DataMappingRegistry dataRegistry );} Eclipse Foundation - www.eclipse.org

More Related