org.cometd.bayeux.server

Interface ServerSession.Extension

All Known Implementing Classes:

ServerSession.Extension.Adapter

Enclosing interface:

ServerSession

public static interface ServerSession.Extension

Extension API for ServerSession.

Implementations of this interface allow to modify incoming and outgoing messages respectively just before and just after they are handled by the implementation, either on client side or server side.

Extensions are be registered in order and one extension may allow subsequent extensions to process the message by returning true from the callback method, or forbid further processing by returning false.

See Also:

ServerSession.addExtension(Extension), BayeuxServer.Extension

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServerSession.Extension.Adapter Empty implementation of ServerSession.Extension.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	rcv(ServerSession session, ServerMessage.Mutable message) Callback method invoked every time a normal message is incoming.
boolean	rcvMeta(ServerSession session, ServerMessage.Mutable message) Callback method invoked every time a meta message is incoming.
ServerMessage	send(ServerSession to, ServerMessage message) Callback method invoked every time a normal message is outgoing.
boolean	sendMeta(ServerSession session, ServerMessage.Mutable message) Callback method invoked every time a meta message is outgoing.

Method Detail

rcv

boolean rcv(ServerSession session,
          ServerMessage.Mutable message)

Callback method invoked every time a normal message is incoming.

Parameters:

session - the session that sent the message

message - the incoming message

Returns:

true if message processing should continue, false if it should stop

rcvMeta

boolean rcvMeta(ServerSession session,
              ServerMessage.Mutable message)

Callback method invoked every time a meta message is incoming.

Parameters:

session - the session that is sent the message

message - the incoming meta message

Returns:

true if message processing should continue, false if it should stop

send

ServerMessage send(ServerSession to,
                 ServerMessage message)

Callback method invoked every time a normal message is outgoing.

Parameters:

to - the session receiving the message, or null for a publish

message - the outgoing message

Returns:

The message to send or null to not send the message

sendMeta

boolean sendMeta(ServerSession session,
               ServerMessage.Mutable message)

Callback method invoked every time a meta message is outgoing.

Parameters:

session - the session receiving the message

message - the outgoing meta message

Returns:

true if message processing should continue, false if it should stop