ch.rasc.wampspring.annotation

Annotation Type WampUnsubscribeListener

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Documented
public @interface WampUnsubscribeListener

Annotation that denotes a method that is called when the server receives a UnsubscribeMessage and the topicURI matches one of the listed values of the annotation. If no topicURI is provided the method is accessible by the topicURI 'beanName.methodName' In the following example the method can be called by sending a UnsubscribeMessage with the topicURI 'myService.doSomething'

 @Service
 public class MyService {
 
        @WampUnsubscribeListener
        public void doSomething(UnsubscribeMessage message) {
 
        }
 }
 

If the attribute replyTo has a value the return value of the method (if any) will be wrapped into an EventMessage and sent to the listed topicURI(s). Additionally if the excludeSender attribute is true the sender of the UnsubscribeMessage does not receive an EventMessage.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean[]	authenticated If true a call to this annotated method has to be authenticated.
boolean	excludeSender Exclude the sender of the UnsubscribeMessage from the replyTo receivers.
String[]	replyTo Send the return value with an EventMessage to the listed TopicURI(s)
String[]	value TopicURI(s) for the subscription.

Element Detail

value

public abstract String[] value

TopicURI(s) for the subscription.

Default:

{}

replyTo

public abstract String[] replyTo

Send the return value with an EventMessage to the listed TopicURI(s)

Default:

{}

excludeSender

public abstract boolean excludeSender

Exclude the sender of the UnsubscribeMessage from the replyTo receivers. This attribut will be ignored if no EventMessage is created.

Default:

false

authenticated

public abstract boolean[] authenticated

If true a call to this annotated method has to be authenticated. If false no authentication is required. Takes precedence over WampAuthenticated and the global setting WampConfigurer.authenticationRequired()

Default:

{}