org.atmosphere.runtime

Class DefaultAsyncSupportResolver

java.lang.Object

org.atmosphere.runtime.DefaultAsyncSupportResolver

All Implemented Interfaces:

AsyncSupportResolver

public class DefaultAsyncSupportResolver
extends Object
implements AsyncSupportResolver

This is the default implementation of @link {AsyncSupportResolver}.

Author:

Viktor Klang

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSR356_WEBSOCKET
static String	NETTY
static String	SERVLET_30

Constructor Summary

Constructors

Constructor and Description
DefaultAsyncSupportResolver(AtmosphereConfig config)

Method Summary

Modifier and Type	Method and Description
List<Class<? extends AsyncSupport>>	detectContainersPresent() Returns a list of comet support by containers available on the classpath.
List<Class<? extends AsyncSupport>>	detectWebSocketPresent(boolean useNativeIfPossible, boolean useServlet30Async)
AsyncSupport	newCometSupport(Class<? extends AsyncSupport> targetClass) Given a Class of something that extends AsyncSupport, it tries to return an instance of that class.
AsyncSupport	newCometSupport(String targetClassFQN)
AsyncSupport	resolve(boolean useNativeIfPossible, boolean defaultToBlocking, boolean useServlet30Async)
protected AsyncSupport	resolveMultipleNativeSupportConflict(List<Class<? extends AsyncSupport>> available) This method is called if there are more than one potential native container in scope.
protected AsyncSupport	resolveNativeCometSupport(List<Class<? extends AsyncSupport>> available) This method is called to determine which native comet support to the used.
AsyncSupport	resolveWebSocket(List<Class<? extends AsyncSupport>> available)
protected boolean	testClassExists(String testClass) Convenience method that tests if a class with the given FQN is present on the classpath.

Methods inherited from class java.lang.Object

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

Field Detail

SERVLET_30

public static final String SERVLET_30

See Also:

Constant Field Values

NETTY

public static final String NETTY

See Also:

Constant Field Values

JSR356_WEBSOCKET

public static final String JSR356_WEBSOCKET

See Also:

Constant Field Values

Constructor Detail

DefaultAsyncSupportResolver

public DefaultAsyncSupportResolver(AtmosphereConfig config)

Method Detail

testClassExists

protected boolean testClassExists(String testClass)

Convenience method that tests if a class with the given FQN is present on the classpath.

Parameters:

testClass -

Returns:

true if the class is present

detectContainersPresent

public List<Class<? extends AsyncSupport>> detectContainersPresent()

Returns a list of comet support by containers available on the classpath.

Returns:

detectWebSocketPresent

public List<Class<? extends AsyncSupport>> detectWebSocketPresent(boolean useNativeIfPossible,
                                                                  boolean useServlet30Async)

newCometSupport

public AsyncSupport newCometSupport(Class<? extends AsyncSupport> targetClass)

Given a Class of something that extends AsyncSupport, it tries to return an instance of that class.

The class has to have a visible constructor with the signature (@link {AtmosphereConfig}).

Parameters:

targetClass -

Returns:

an instance of the specified class or null if the class cannot be instantiated

newCometSupport

public AsyncSupport newCometSupport(String targetClassFQN)

resolve

public AsyncSupport resolve(boolean useNativeIfPossible,
                            boolean defaultToBlocking,
                            boolean useServlet30Async)

Specified by:

resolve in interface AsyncSupportResolver

resolveWebSocket

public AsyncSupport resolveWebSocket(List<Class<? extends AsyncSupport>> available)

resolveNativeCometSupport

protected AsyncSupport resolveNativeCometSupport(List<Class<? extends AsyncSupport>> available)

This method is called to determine which native comet support to the used.

Parameters:

available -

Returns:

the result of @link {resolveMultipleNativeSupportConflict} if there are more than 1 item in the list of available ontainers

resolveMultipleNativeSupportConflict

protected AsyncSupport resolveMultipleNativeSupportConflict(List<Class<? extends AsyncSupport>> available)

This method is called if there are more than one potential native container in scope.

Returns:

a AsyncSupport instance