Package org.atmosphere.annotation

Class AnnotationUtil

java.lang.Object

org.atmosphere.annotation.AnnotationUtil

public class AnnotationUtil
extends Object

Utility class providing common helper methods for annotation processing. Methods in this class handle registration of AtmosphereInterceptors, BroadcastFilters, AtmosphereResourceEventListeners, and other framework components extracted from annotation attributes.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
AnnotationUtil()

Method Summary

Modifier and Type	Method	Description
static void	atmosphereConfig(String[] m, AtmosphereFramework framework)
static Broadcaster	broadcaster(AtmosphereFramework framework, Class<? extends Broadcaster> broadcaster, String path)
static Class<? extends Broadcaster>	broadcasterClass(AtmosphereFramework framework, Class<? extends Broadcaster> broadcaster)
static boolean	checkDefault(Class<? extends AtmosphereInterceptor> i)
static void	defaultManagedServiceInterceptors(AtmosphereFramework framework, List<AtmosphereInterceptor> l)
static void	filters(Class<? extends BroadcastFilter>[] bf, AtmosphereFramework framework)
static void	interceptors(Class<? extends AtmosphereInterceptor>[] interceptors, AtmosphereFramework framework)
static void	interceptorsForHandler(AtmosphereFramework framework, List<Class<? extends AtmosphereInterceptor>> interceptors, List<AtmosphereInterceptor> l)
static void	interceptorsForManagedService(AtmosphereFramework framework, List<Class<? extends AtmosphereInterceptor>> interceptors, List<AtmosphereInterceptor> l)
static void	interceptorsForManagedService(AtmosphereFramework framework, List<Class<? extends AtmosphereInterceptor>> interceptors, List<AtmosphereInterceptor> l, boolean checkDuplicate)
static AtmosphereInterceptor	listeners(Class<? extends AtmosphereResourceEventListener>[] listeners, AtmosphereFramework framework)
static List<Class<? extends AtmosphereInterceptor>>	managedServiceInterceptors()	The interceptors installed for every @ManagedService endpoint.

Methods inherited from class java.lang.Object

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

Field Details

logger

public static final org.slf4j.Logger logger

Constructor Details

AnnotationUtil

public AnnotationUtil()

Method Details

managedServiceInterceptors

public static List<Class<? extends AtmosphereInterceptor>> managedServiceInterceptors()

The interceptors installed for every @ManagedService endpoint.

Exposed because these are instantiated reflectively, which makes them an ahead-of-time concern: a GraalVM image that has not registered them cannot construct them, and newClassInstance reports that by logging and continuing — the endpoint quietly never comes up. Publishing the list lets the native-hint registry be checked against it instead of being kept in sync by hand.

Returns:

unmodifiable list of the managed-service interceptor types

interceptors

public static void interceptors(Class<? extends AtmosphereInterceptor>[] interceptors,
 AtmosphereFramework framework)

filters

public static void filters(Class<? extends BroadcastFilter>[] bf,
 AtmosphereFramework framework)
                    throws IllegalAccessException,
InstantiationException

Throws:

IllegalAccessException

InstantiationException

atmosphereConfig

public static void atmosphereConfig(String[] m,
 AtmosphereFramework framework)

defaultManagedServiceInterceptors

public static void defaultManagedServiceInterceptors(AtmosphereFramework framework,
 List<AtmosphereInterceptor> l)

interceptorsForManagedService

public static void interceptorsForManagedService(AtmosphereFramework framework,
 List<Class<? extends AtmosphereInterceptor>> interceptors,
 List<AtmosphereInterceptor> l)

interceptorsForManagedService

public static void interceptorsForManagedService(AtmosphereFramework framework,
 List<Class<? extends AtmosphereInterceptor>> interceptors,
 List<AtmosphereInterceptor> l,
 boolean checkDuplicate)

interceptorsForHandler

public static void interceptorsForHandler(AtmosphereFramework framework,
 List<Class<? extends AtmosphereInterceptor>> interceptors,
 List<AtmosphereInterceptor> l)

checkDefault

public static boolean checkDefault(Class<? extends AtmosphereInterceptor> i)

listeners

public static AtmosphereInterceptor listeners(Class<? extends AtmosphereResourceEventListener>[] listeners,
 AtmosphereFramework framework)

broadcaster

public static Broadcaster broadcaster(AtmosphereFramework framework,
 Class<? extends Broadcaster> broadcaster,
 String path)
                               throws Exception

Throws:

Exception

broadcasterClass

public static Class<? extends Broadcaster> broadcasterClass(AtmosphereFramework framework,
 Class<? extends Broadcaster> broadcaster)
                                                     throws Exception

Throws:

Exception