Package org.atmosphere.util

Class Utils

java.lang.Object

org.atmosphere.util.Utils

public final class Utils
extends Object

Utils class.

Constructor Summary

Constructors

Constructor	Description
Utils()

Method Summary

Modifier and Type	Method	Description
static boolean	atmosphereProtocol(AtmosphereRequest r)
static boolean	closeMessage(HttpServletRequest request)
static boolean	firefoxWebSocketEnabled(HttpServletRequest request)
static Set<Field>	getInheritedPrivateFields(Class<?> type)
static Set<Method>	getInheritedPrivateMethod(Class<?> type)
static void	inject(Object object, Class<?> clazz, AtmosphereConfig config)
static void	inject(Object object, Class<?> clazz, AtmosphereResource r)
static void	inject(AtmosphereResource r)
static Object	invoke(Object proxiedInstance, Method m, Object o)	Manages the invocation of the given method on the specified 'proxied' instance.
static boolean	isRunningTest()
static String	pathInfo(AtmosphereRequest request)
static boolean	pollableTransport(AtmosphereResource.TRANSPORT t)
static boolean	properProtocol(HttpServletRequest request)
static boolean	pushMessage(AtmosphereResource.TRANSPORT t)
static boolean	rawWebSocket(HttpServletRequest request)
static boolean	requestScopedInjection(AtmosphereConfig config, Object o)	Inject custom object.
static boolean	requestScopedInjection(AtmosphereConfig config, AtmosphereHandler h)
static boolean	resumableTransport(AtmosphereResource.TRANSPORT t)
static String	transportName(AtmosphereResource r)	The name of the transport a resource's client is connected with, for reports (admin, MCP, tracing, logs).
static boolean	twoConnectionsTransport(AtmosphereResource.TRANSPORT t)
static boolean	webSocketEnabled(HttpServletRequest request)
static boolean	webSocketMessage(AtmosphereResource r)
static boolean	webSocketQueryStringPresentOrNull(HttpServletRequest request)
static AtmosphereResource	websocketResource(AtmosphereResource r)

Methods inherited from class java.lang.Object

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

Constructor Details

Utils

public Utils()

Method Details

webSocketEnabled

public static boolean webSocketEnabled(HttpServletRequest request)

rawWebSocket

public static boolean rawWebSocket(HttpServletRequest request)

firefoxWebSocketEnabled

public static boolean firefoxWebSocketEnabled(HttpServletRequest request)

twoConnectionsTransport

public static boolean twoConnectionsTransport(AtmosphereResource.TRANSPORT t)

webSocketQueryStringPresentOrNull

public static boolean webSocketQueryStringPresentOrNull(HttpServletRequest request)

transportName

public static String transportName(AtmosphereResource r)

The name of the transport a resource's client is connected with, for reports (admin, MCP, tracing, logs). It is AtmosphereResource.transport()'s name, except for a WebTransport session: it is bridged onto the WebSocket processor and runs with AtmosphereResource.TRANSPORT.WEBSOCKET semantics, so transport() says WEBSOCKET while the client is on HTTP/3. Such a resource carries FrameworkConfig.WEBTRANSPORT_SESSION and is reported as WEBTRANSPORT.

Parameters:

r - the resource

Returns:

the upper-case transport name, UNDEFINED when unknown

resumableTransport

public static boolean resumableTransport(AtmosphereResource.TRANSPORT t)

pollableTransport

public static boolean pollableTransport(AtmosphereResource.TRANSPORT t)

pushMessage

public static boolean pushMessage(AtmosphereResource.TRANSPORT t)

atmosphereProtocol

public static boolean atmosphereProtocol(AtmosphereRequest r)

webSocketMessage

public static boolean webSocketMessage(AtmosphereResource r)

properProtocol

public static boolean properProtocol(HttpServletRequest request)

websocketResource

public static AtmosphereResource websocketResource(AtmosphereResource r)

closeMessage

public static boolean closeMessage(HttpServletRequest request)

invoke

public static Object invoke(Object proxiedInstance,
 Method m,
 Object o)

Manages the invocation of the given method on the specified 'proxied' instance. Logs any invocation failure.

Parameters:

proxiedInstance - the instance

m - the method to invoke that belongs to the instance

o - the optional parameter

Returns:

the result of the invocation

inject

public static void inject(AtmosphereResource r)
                   throws IllegalAccessException

Throws:

IllegalAccessException

inject

public static void inject(Object object,
 Class<?> clazz,
 AtmosphereResource r)
                   throws IllegalAccessException

Throws:

IllegalAccessException

inject

public static void inject(Object object,
 Class<?> clazz,
 AtmosphereConfig config)
                   throws IllegalAccessException

Throws:

IllegalAccessException

getInheritedPrivateFields

public static Set<Field> getInheritedPrivateFields(Class<?> type)

getInheritedPrivateMethod

public static Set<Method> getInheritedPrivateMethod(Class<?> type)

requestScopedInjection

public static boolean requestScopedInjection(AtmosphereConfig config,
 AtmosphereHandler h)

requestScopedInjection

public static boolean requestScopedInjection(AtmosphereConfig config,
 Object o)

Inject custom object. This method is mostly for external framework.

pathInfo

public static String pathInfo(AtmosphereRequest request)

isRunningTest

public static boolean isRunningTest()