Package org.cometd.annotation

Class ServerAnnotationProcessor

  • public class ServerAnnotationProcessor
extends Object

    Processes annotations in server-side service objects.

    Service objects must be annotated with Service at class level to be processed by this processor, for example:

     @Service
 public class MyService
 {
     @Session
     private ServerSession session;

     @Configure("/foo")
     public void configureFoo(ConfigurableServerChannel channel)
     {
         channel.setPersistent(...);
         channel.addListener(...);
         channel.addAuthorizer(...);
     }

     @Listener("/foo")
     public void handleFooMessages(ServerSession remote, ServerMessage.Mutable message)
     {
         // Do something
     }
 }

    The processor is used in this way:

     BayeuxServer bayeux = ...;
 ServerAnnotationProcessor processor = ServerAnnotationProcessor.get(bayeux);
 MyService s = new MyService();
 processor.process(s);
    See Also:
    ClientAnnotationProcessor

    • Field Detail

      • logger

        protected final org.slf4j.Logger logger

    • Constructor Detail

      • ServerAnnotationProcessor

        public ServerAnnotationProcessor​(BayeuxServer bayeuxServer)

      • ServerAnnotationProcessor

        public ServerAnnotationProcessor​(BayeuxServer bayeuxServer,
                                 Object... injectables)

    • Method Detail

      • process

        public boolean process​(Object bean)
        Processes dependencies annotated with Inject and Session, configuration methods annotated with Configure, callback methods annotated with Listener, Subscription and RemoteCall, and lifecycle methods annotated with PostConstruct.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if the bean contains at least one annotation that has been processed, false otherwise

      • processConfigurations

        public boolean processConfigurations​(Object bean)
        Processes the methods annotated with Configure.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if at least one annotated configure has been processed, false otherwise

      • processDependencies

        public boolean processDependencies​(Object bean)
        Processes the dependencies annotated with Inject and Session.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if at least one annotated dependency has been processed, false otherwise

      • processPostConstruct

        public boolean processPostConstruct​(Object bean)
        Processes lifecycle methods annotated with PostConstruct.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if at least one lifecycle method has been invoked, false otherwise

      • processCallbacks

        public boolean processCallbacks​(Object bean)
        Processes the callbacks annotated with Listener, Subscription and RemoteCall.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if at least one annotated callback has been processed, false otherwise

      • deprocess

        public boolean deprocess​(Object bean)
        Performs the opposite processing done by process(Object) on callbacks methods annotated with Listener, Subscription and RemoteCall, and on lifecycle methods annotated with PreDestroy.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if at least one deprocessing has been performed, false otherwise
        See Also:
        process(Object)

      • deprocessCallbacks

        public boolean deprocessCallbacks​(Object bean)
        Performs the opposite processing done by processCallbacks(Object) on callback methods annotated with Listener, Subscription and RemoteCall.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if the at least one callback has been deprocessed

      • processPreDestroy

        public boolean processPreDestroy​(Object bean)
        Processes lifecycle methods annotated with PreDestroy.
        Parameters:
        bean - the annotated service instance
        Returns:
        true if at least one lifecycle method has been invoked, false otherwise

      • processParameters

        protected List<String> processParameters​(Method method)

      • checkMethodsPublic

        protected static void checkMethodsPublic​(Object bean,
                                         Class<? extends Annotation> annotationClass)

      • checkSignaturesMatch

        protected static void checkSignaturesMatch​(Method method,
                                           Class<?>[] expectedTypes,
                                           List<String> paramNames)

      • processInjectables

        protected boolean processInjectables​(Object bean,
                                     List<Object> injectables)

      • processInjectable

        protected boolean processInjectable​(Object bean,
                                    Object injectable)