public class

SimpleHttpServerFactoryBean

extends Object
implements DisposableBean FactoryBean<T> InitializingBean
java.lang.Object
   ↳ org.springframework.remoting.support.SimpleHttpServerFactoryBean

Class Overview

FactoryBean that creates a simple HTTP server, based on the HTTP server that is included in Sun's JRE 1.6. Starts the HTTP server on initialization and stops it on destruction. Exposes the resulting com.sun.net.httpserver.HttpServer object.

Allows for registering com.sun.net.httpserver.HttpHandler HttpHandlers for specific context paths. Alternatively, register such context-specific handlers programmatically on the com.sun.net.httpserver.HttpServer itself.

Summary

Fields
protected final Log logger
Public Constructors
SimpleHttpServerFactoryBean()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void destroy()
Invoked by a BeanFactory on destruction of a singleton.
HttpServer getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.
Class<? extends HttpServer> getObjectType()
Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean isSingleton()
Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory.

void setAuthenticator(Authenticator authenticator)
Register a common com.sun.net.httpserver.Authenticator to be applied to all locally registered contexts.
void setBacklog(int backlog)
Specify the HTTP server's TCP backlog.
void setContexts(Map<String, HttpHandler> contexts)
Register com.sun.net.httpserver.HttpHandler HttpHandlers for specific context paths.
void setExecutor(Executor executor)
Set the JDK concurrent executor to use for dispatching incoming requests.
void setFilters(List<Filter> filters)
Register common com.sun.net.httpserver.Filter Filters to be applied to all locally registered contexts.
void setHostname(String hostname)
Specify the HTTP server's hostname to bind to.
void setPort(int port)
Specify the HTTP server's port.
void setShutdownDelay(int shutdownDelay)
Specify the number of seconds to wait until HTTP exchanges have completed when shutting down the HTTP server.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.DisposableBean
From interface org.springframework.beans.factory.FactoryBean
From interface org.springframework.beans.factory.InitializingBean

Fields

protected final Log logger

Public Constructors

public SimpleHttpServerFactoryBean ()

Public Methods

public void afterPropertiesSet ()

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Throws
IOException

public void destroy ()

Invoked by a BeanFactory on destruction of a singleton.

public HttpServer getObject ()

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns
  • an instance of the bean (can be null)

public Class<? extends HttpServer> getObjectType ()

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns
  • the type of object that this FactoryBean creates, or null if not known at the time of the call

public boolean isSingleton ()

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

Returns
  • whether the exposed object is a singleton

public void setAuthenticator (Authenticator authenticator)

Register a common com.sun.net.httpserver.Authenticator to be applied to all locally registered contexts.

public void setBacklog (int backlog)

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

public void setContexts (Map<String, HttpHandler> contexts)

Register com.sun.net.httpserver.HttpHandler HttpHandlers for specific context paths.

Parameters
contexts a Map with context paths as keys and HttpHandler objects as values

public void setExecutor (Executor executor)

Set the JDK concurrent executor to use for dispatching incoming requests.

public void setFilters (List<Filter> filters)

Register common com.sun.net.httpserver.Filter Filters to be applied to all locally registered contexts.

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.

public void setPort (int port)

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

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.