com.predic8.membrane.core

Class Router

java.lang.Object

com.predic8.membrane.core.Router

Direct Known Subclasses:

HttpRouter

public class Router
extends Object

Description

Membrane Service Proxy's main object.

The router is a Spring Lifecycle object: It is automatically started and stopped according to the Lifecycle of the Spring Context containing it. In Membrane's standard setup (standalone or in a J2EE web app), Membrane itself controls the creation of the Spring Context and its Lifecycle.

In this case, the router is hot deployable: It can monitor proxies.xml, the Spring configuration file, for changes and reinitialize the Spring Context, when a change is detected. Note that, during the Spring Context restart, the router object itself along with almost all other Membrane objects (interceptors, etc.) will be recreated.

Topic

1. Membrane Service Proxy

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorService	backgroundInitializator
protected DNSCache	dnsCache
protected ExchangeStore	exchangeStore
protected String	jmxRouterName
protected ResolverMap	resolverMap
protected RuleManager	ruleManager
protected Statistics	statistics
protected Transport	transport
protected URIFactory	uriFactory

Constructor Summary

Constructors

Constructor and Description
Router()

Method Summary

Modifier and Type	Method and Description
void	add(Rule rule)
ExecutorService	getBackgroundInitializator()
String	getBaseLocation()
DNSCache	getDnsCache()
ExchangeStore	getExchangeStore()
HttpClientConfiguration	getHttpClientConfig()
String	getId()
String	getJmx()
Rule	getParentProxy(Interceptor interceptor)
ResolverMap	getResolverMap()
int	getRetryInitInterval()
RuleManager	getRuleManager()
Collection<Rule>	getRules()
Statistics	getStatistics()
Transport	getTransport()
URIFactory	getUriFactory()
void	init()
static Router	init(String configFileName)
static Router	init(String resource, ClassLoader classLoader)
boolean	isRetryInit()
boolean	isRunning()
void	setBaseLocation(String baseLocation)
void	setBeanName(String s)
void	setExchangeStore(ExchangeStore exchangeStore)
void	setHttpClientConfig(HttpClientConfiguration httpClientConfig)
void	setJmx(String name)
void	setRetryInit(boolean retryInit)
void	setRetryInitInterval(int retryInitInterval)
void	setRuleManager(RuleManager ruleManager)
void	setRules(Collection<Rule> proxies)
void	setTransport(Transport transport)
void	setUriFactory(URIFactory uriFactory)
void	shutdown() Closes all ports (if any were opened) and waits for running exchanges to complete.
void	shutdownNoWait() Deprecated. Simply invokes shutdown(). "Not waiting" is not supported anymore, as open connections can now be forcibly closed after a timeout. See HttpTransport.setForceSocketCloseOnHotDeployAfter(int).
void	start()
void	stop()
void	tryReinitialization()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ruleManager

protected RuleManager ruleManager

exchangeStore

protected ExchangeStore exchangeStore

transport

protected Transport transport

resolverMap

protected ResolverMap resolverMap

dnsCache

protected DNSCache dnsCache

backgroundInitializator

protected ExecutorService backgroundInitializator

uriFactory

protected URIFactory uriFactory

statistics

protected Statistics statistics

jmxRouterName

protected String jmxRouterName

Constructor Detail

Router

public Router()

Method Detail

getRules

public Collection<Rule> getRules()

setRules

public void setRules(Collection<Rule> proxies)

init

public static Router init(String configFileName)
                   throws MalformedURLException

Throws:

MalformedURLException

init

public static Router init(String resource,
                          ClassLoader classLoader)

getRuleManager

public RuleManager getRuleManager()

setRuleManager

public void setRuleManager(RuleManager ruleManager)

getExchangeStore

public ExchangeStore getExchangeStore()

setExchangeStore

public void setExchangeStore(ExchangeStore exchangeStore)

Default

create a LimitedMemoryExchangeStore limited to the size of 1 MB.

Description

Spring Bean ID of an ExchangeStore. The exchange store will be used by this router's components (AdminConsoleInterceptor, ExchangeStoreInterceptor, etc.) by default, if no other exchange store is explicitly set to be used by them.

getTransport

public Transport getTransport()

setTransport

public void setTransport(Transport transport)

getHttpClientConfig

public HttpClientConfiguration getHttpClientConfig()

setHttpClientConfig

public void setHttpClientConfig(HttpClientConfiguration httpClientConfig)

getDnsCache

public DNSCache getDnsCache()

getResolverMap

public ResolverMap getResolverMap()

shutdown

public void shutdown()
              throws IOException

Closes all ports (if any were opened) and waits for running exchanges to complete. When running as an embedded servlet, this has no effect.

Throws:

IOException

shutdownNoWait

@Deprecated
public void shutdownNoWait()
                                throws IOException

Deprecated. Simply invokes shutdown(). "Not waiting" is not supported anymore, as open connections can now be forcibly closed after a timeout. See HttpTransport.setForceSocketCloseOnHotDeployAfter(int).

Closes all ports (if any were opened), but does not wait for running exchanges to complete.

Throws:

IOException

getBackgroundInitializator

public ExecutorService getBackgroundInitializator()

getParentProxy

public Rule getParentProxy(Interceptor interceptor)

add

public void add(Rule rule)
         throws IOException

Throws:

IOException

init

public void init()
          throws Exception

Throws:

Exception

start

public void start()

tryReinitialization

public void tryReinitialization()

stop

public void stop()

isRunning

public boolean isRunning()

getRetryInitInterval

public int getRetryInitInterval()

setRetryInitInterval

public void setRetryInitInterval(int retryInitInterval)

Default

5 minutes

Description

number of milliseconds after which reinitialization of <soapProxy>s should be attempted periodically

getBaseLocation

public String getBaseLocation()

setBaseLocation

public void setBaseLocation(String baseLocation)

isRetryInit

public boolean isRetryInit()

setRetryInit

public void setRetryInit(boolean retryInit)

Default

false

Explanation

Whether the router should continue startup, if initialization of a rule (proxy, serviceProxy or soapProxy) failed (for example, when a WSDL a component depends on could not be downloaded).

If false, the router will exit with code -1 just after startup, when the initialization of a rule failed.

If true, the router will continue startup, and all rules which could not be initialized will be inactive (=not Rule.isActive()).

Inactive rules

Inactive rules will simply be ignored for routing decissions for incoming requests. This means that requests for inactive rules might be routed using different routes or result in a "400 Bad Request" when no active route could be matched to the request.

Once rules become active due to reinitialization, they are considered in future routing decissions.

Reinitialization

Inactive rules may be reinitialized and, if reinitialization succeeds, become active.

By default, reinitialization is attempted at regular intervals using a timer (see setRetryInitInterval(int)).

Additionally, using the AdminConsoleInterceptor, an admin may trigger reinitialization of inactive rules at any time.

getUriFactory

public URIFactory getUriFactory()

setUriFactory

public void setUriFactory(URIFactory uriFactory)

getStatistics

public Statistics getStatistics()

setJmx

public void setJmx(String name)

getJmx

public String getJmx()

setBeanName

public void setBeanName(String s)

getId

public String getId()