Implementing Generic Servers for Eclipse WebTools
- 1. Gorkem Ercan – Nokia EclipseCon 2006 Implementing Generic Servers
- 2. What is Generic Server Framework Easiest way to add server support to WTP No coding A special server and runtime that can adjust behavior Server type definition files determine behavior Uses WTP server tool extensions RuntimeTypes ServerTypes Provides UI support Server type definition file driven
- 3. Extensions - Runtime type Extension: org.eclipse.wst.server.core.runtimeTypes Implementation: org.eclipse.jst.server.generic.core.internal.GenericServerRuntime
- 4. Extensions – Server Type Extension: org.eclipse.wst.server.core.serverTypes Implementation: org.eclipse.jst.server.generic.core.internal.GenericServer behaviourClass: org.eclipse.jst.server.generic.core.internal.GenericServerBehaviour
- 5. Extensions - UI Extension: org.eclipse.wst.server.ui.wizardFragments Implementation(Server): org.eclipse.jst.server.generic.ui.internal.GenericServerWizardFragment Implementation(Runtime): org.eclipse.jst.server.generic.ui.internal.GenericServerRuntimeWizardFragment
- 6. Extensions - Classpath Extension: org.eclipse.jst.server.core.runtimeClasspathProviders Implementation: org.eclipse.jst.server.generic.core.internal.GenericServerRuntimeTargetHandler
- 7. Extension – Server definition file org.eclipse.jst.server.generic.core.serverdefinition Also remember other server extension points Server Images - org.eclipse.wst.server.ui.serverImages Facet runtimes - org.eclipse.wst.common.project.facet.core.runtimes Facet images- org.eclipse.wst.common.project.facet.ui.images Facet mappings - org.eclipse.jst.server.core.runtimeFacetMappings
- 8. Generic Publishers Handles publishing modules to servers for generic servers Introduced using org.eclipse.jst.server.generic. generic publisher extension point You do not need one for basic scenarios use ANT build file based publisher that is part of WTP Simple API extend org.eclipse.jst.server.generic.core.internal.GenericPublisher class See org.eclipse.jst.server.generic.core.internal.publishers.AntPublishe
- 9. .serverdef file explained XML based meta information about the server Introduced using “org.eclipse.jst.server.generic.core.serverdefinition ” extension Two parts Properties Derived server information Properties are variables that users provide values using server tools UI Derived server information used by the generic server to enable functionality
- 10. Properties to collect user data Properties determine the generic server user interface for collecting user data. Has following mandatory properties id: unique value to refer to property later in the file label: User friendly alias for the property. This is value is diplayed to users. type: determines the type of GUI to use. The allowed values, "string" renders a text widget, "boolean" renders a check box, "directory" renders a file path dialog, "file" renders a file dialog. “select” renders a Combo. context: Determineds whether the property is part of server runtime or a server instance. default: This is the initial value presented to user.
- 11. Property example
- 12. Classpath definitions Can be consumed by different sections of the server definition. start, stop project build path Contains following attributes id: identified by this in the framework archive and path: points either to a directory or a java library that will be a part of the classpath. Project classpaths are determined by the project element
- 13. Info that starts/stops used to define parameters to launch and stop a server, two launch kinds java launch external launch. determined by the launch configuration in the definition of the server type. These attributes are common to both launch types workingDirectory: directory in which the application server starts. programArguments: Specific values that the server is expecting environmentVariable: These are the name and value pairs for environment variables
- 14. A java launch In addition to common attributes the following is required mainClass Name of the class with main to start the server vmParameters: parameters to java virtual machine classpathReference: classpath definition used to invoke main class
- 15. External launch In addition to common attributes the following is required debugPort: port number eclipse debugger uses to connect external: This is the external executable or script that will be used
- 16. Publisher It is possible to provide server specific information for initializing the publisher id: id of the publisher that matches the id int the plugin.xml where publisher is defined publisherdata: value pair that will be passed to publisher
- 17. Modules Determines the supported module types and publisher information Has these attributes type: The module type, must match the plugin.xml value where the module type is defined publishDir: The directory where published publisherReference: The id of the generic publisher
- 18. Ports the port element indicates the ports and the protocols that the server starts no: The port number protocol: The protocol supported by this port name: User friendly name of the protocol
- 19. JNDI Properties The JNDI properties for a server. The jndiConnection element is used to provide the jndi information for accessing an application server. providerUrl: The url to jndi server. initialContextFactory: initial context factory class jndiProperty: Name, value pairs that may be used for connection
- 20. LAB Certain parts of a tomcat generic server plug-in project is commented Commented files are tomcat.serverdef and plugin.xml Search for “***” to discover commented parts.