public class

SimpleHttpServerJaxWsServiceExporter

extends AbstractJaxWsServiceExporter
java.lang.Object
   ↳ org.springframework.remoting.jaxws.AbstractJaxWsServiceExporter
     ↳ org.springframework.remoting.jaxws.SimpleHttpServerJaxWsServiceExporter

Class Overview

Simple exporter for JAX-WS services, autodetecting annotated service beans (through the JAX-WS javax.jws.WebService annotation) and exporting them through the HTTP server included in Sun's JDK 1.6. The full address for each service will consist of the server's base address with the service name appended (e.g. "http://localhost:8080/OrderService").

Note that this exporter will only work on Sun's JDK 1.6 or higher, as well as on JDKs that ship Sun's entire class library as included in the Sun JDK. For a portable JAX-WS exporter, have a look at SimpleJaxWsServiceExporter.

See Also

Summary

Fields
protected final Log logger
Public Constructors
SimpleHttpServerJaxWsServiceExporter()
Public Methods
void afterPropertiesSet()
Immediately publish all endpoints when fully configured.
void destroy()
Stops all published endpoints, taking the web services offline.
void setAuthenticator(Authenticator authenticator)
Register a common com.sun.net.httpserver.Authenticator to be applied to all detected javax.jws.WebService annotated beans.
void setBacklog(int backlog)
Specify the HTTP server's TCP backlog.
void setBasePath(String basePath)
Set the base path for context publication.
void setFilters(List<Filter> filters)
Register common com.sun.net.httpserver.Filter Filters to be applied to all detected javax.jws.WebService annotated beans.
void setHostname(String hostname)
Specify the HTTP server's hostname to bind to.
void setPort(int port)
Specify the HTTP server's port.
void setServer(HttpServer server)
Specify an existing HTTP server to register the web service contexts with.
void setShutdownDelay(int shutdownDelay)
Specify the number of seconds to wait until HTTP exchanges have completed when shutting down the HTTP server.
Protected Methods
HttpContext buildHttpContext(Endpoint endpoint, String serviceName)
Build the HttpContext for the given endpoint.
String calculateEndpointPath(Endpoint endpoint, String serviceName)
Calculate the full endpoint path for the given endpoint.
void publishEndpoint(Endpoint endpoint, WebServiceProvider annotation)
Actually publish the given provider endpoint.
void publishEndpoint(Endpoint endpoint, WebService annotation)
Actually publish the given endpoint.
[Expand]
Inherited Methods
From class org.springframework.remoting.jaxws.AbstractJaxWsServiceExporter
From class java.lang.Object
From interface org.springframework.beans.factory.BeanFactoryAware
From interface org.springframework.beans.factory.DisposableBean
From interface org.springframework.beans.factory.InitializingBean

Fields

protected final Log logger

Public Constructors

public SimpleHttpServerJaxWsServiceExporter ()

Public Methods

public void afterPropertiesSet ()

Immediately publish all endpoints when fully configured.

Throws
Exception

public void destroy ()

Stops all published endpoints, taking the web services offline.

public void setAuthenticator (Authenticator authenticator)

Register a common com.sun.net.httpserver.Authenticator to be applied to all detected javax.jws.WebService annotated beans.

public void setBacklog (int backlog)

Specify the HTTP server's TCP backlog. Default is -1, indicating the system's default value.

Only applicable for a locally configured HTTP server. Ignored when the "server" property has been specified.

public void setBasePath (String basePath)

Set the base path for context publication. Default is "/".

For each context publication path, the service name will be appended to this base address. E.g. service name "OrderService" -> "/OrderService".

See Also

public void setFilters (List<Filter> filters)

Register common com.sun.net.httpserver.Filter Filters to be applied to all detected javax.jws.WebService annotated beans.

public void setHostname (String hostname)

Specify the HTTP server's hostname to bind to. Default is localhost; can be overridden with a specific network address to bind to.

Only applicable for a locally configured HTTP server. Ignored when the "server" property has been specified.

public void setPort (int port)

Specify the HTTP server's port. Default is 8080.

Only applicable for a locally configured HTTP server. Ignored when the "server" property has been specified.

public void setServer (HttpServer server)

Specify an existing HTTP server to register the web service contexts with. This will typically be a server managed by the general Spring SimpleHttpServerFactoryBean.

Alternatively, configure a local HTTP server through the "port", "hostname" and "backlog" properties (or rely on the defaults there).

public void setShutdownDelay (int shutdownDelay)

Specify the number of seconds to wait until HTTP exchanges have completed when shutting down the HTTP server. Default is 0.

Only applicable for a locally configured HTTP server. Ignored when the "server" property has been specified.

Protected Methods

protected HttpContext buildHttpContext (Endpoint endpoint, String serviceName)

Build the HttpContext for the given endpoint.

Parameters
endpoint the JAX-WS Provider Endpoint object
serviceName the given service name
Returns
  • the fully populated HttpContext

protected String calculateEndpointPath (Endpoint endpoint, String serviceName)

Calculate the full endpoint path for the given endpoint.

Parameters
endpoint the JAX-WS Provider Endpoint object
serviceName the given service name
Returns
  • the full endpoint path

protected void publishEndpoint (Endpoint endpoint, WebServiceProvider annotation)

Actually publish the given provider endpoint. To be implemented by subclasses.

Parameters
endpoint the JAX-WS Provider Endpoint object
annotation the service bean's WebServiceProvider annotation

protected void publishEndpoint (Endpoint endpoint, WebService annotation)

Actually publish the given endpoint. To be implemented by subclasses.

Parameters
endpoint the JAX-WS Endpoint object
annotation the service bean's WebService annotation