Index (atmosphere-stomp 0.4 API)

A B C D E F G H I L M O P R S T U V W

A

AbortInterceptor - Class in org.atmosphere.stomp.interceptor: Aborts a transaction began by the given AtmosphereResource.
AbortInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.AbortInterceptor
ACCEPT_VERSION - Static variable in interface org.atmosphere.stomp.protocol.Header: The versions of the STOMP protocol the client supports.
ACK - Static variable in interface org.atmosphere.stomp.protocol.Header: Specify message acknowledgment.
Action - Enum in org.atmosphere.stomp.protocol: This enumeration defines all the action that could performed in STOMP protocol.
addSubscription(String, String) - Method in class org.atmosphere.stomp.Subscriptions: Adds a subscription to the set of subscriptions.
apply(Subscriptions, String, AtmosphereFramework.AtmosphereHandlerWrapper) - Method in interface org.atmosphere.stomp.handler.HandlerHelper.Procedure: Processes an handler.

B

BeginInterceptor - Class in org.atmosphere.stomp.interceptor: Begins a transaction for the given AtmosphereResource.
BeginInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.BeginInterceptor

C

callHandler(AtmosphereResource, Map<String, String>, AtmosphereFramework, boolean, HandlerHelper.Procedure) - Method in enum org.atmosphere.stomp.handler.HandlerHelper: Gets the handler associated to the mapping specified in the given header and applies a procedure on it.
CommitInterceptor - Class in org.atmosphere.stomp.interceptor: Commits a transaction started by the given AtmosphereResource.
CommitInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.CommitInterceptor
configure(AtmosphereConfig) - Method in class org.atmosphere.stomp.interceptor.ConnectInterceptor
configure(AtmosphereConfig) - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor
ConnectInterceptor - Class in org.atmosphere.stomp.interceptor: Evaluates the connection frame.
ConnectInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.ConnectInterceptor
CONTENT_LENGTH - Static variable in interface org.atmosphere.stomp.protocol.Header: byte count for the length of the message body.
CONTENT_TYPE - Static variable in interface org.atmosphere.stomp.protocol.Header: Mime type which describes the format of the body.

D

DEFAULT_VERSION - Static variable in class org.atmosphere.stomp.interceptor.ConnectInterceptor: The default supported version.
DESTINATION - Static variable in interface org.atmosphere.stomp.protocol.Header: Indicates the destination to which the client wants to subscribe.
destroy() - Method in class org.atmosphere.stomp.StompBroadcastFilter
DisconnectInterceptor - Class in org.atmosphere.stomp.interceptor: Evaluates the connection frame.
DisconnectInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.DisconnectInterceptor

E

extractHeartbeatInterval(AtmosphereResourceImpl) - Method in class org.atmosphere.stomp.interceptor.ConnectInterceptor

F

filter(String, AtmosphereResource, Object, Object) - Method in class org.atmosphere.stomp.StompBroadcastFilter
filter(String, Object, Object) - Method in class org.atmosphere.stomp.StompBroadcastFilter
format(Frame) - Method in interface org.atmosphere.stomp.protocol.StompFormat: Takes the given Frame and converts it to a String representation.
format(Frame) - Method in class org.atmosphere.stomp.protocol.StompFormatImpl: Takes the given Frame and converts it to a String representation.
Frame - Class in org.atmosphere.stomp.protocol: In STOMP protocol, the frame basically defines an Action, some headers and eventually a body.
Frame(Action, Map<String, String>, String) - Constructor for class org.atmosphere.stomp.protocol.Frame: Builds a new instance.
Frame(Action, Map<String, String>) - Constructor for class org.atmosphere.stomp.protocol.Frame: Builds a new instance without body.
FrameInterceptor - Class in org.atmosphere.stomp.interceptor: This interceptor reads the frames and parse it thanks to the StompFormat.
FrameInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.FrameInterceptor
FrameInterceptor.PropertyClass - Enum in org.atmosphere.stomp.interceptor: This enum is dedicated to properties that represents a class to instantiate.
FrameInterceptor.StompAtmosphereResource - Class in org.atmosphere.stomp.interceptor: Inner class that wraps the AtmosphereResource during inspection to write frame and check the nature of the operations.
FrameInterceptor.StompAtmosphereResource(AtmosphereResource, Frame) - Constructor for class org.atmosphere.stomp.interceptor.FrameInterceptor.StompAtmosphereResource: Builds a new action.

G

getAction() - Method in class org.atmosphere.stomp.protocol.Frame: Gets the action.
getAllDestinations() - Method in class org.atmosphere.stomp.Subscriptions: Gets all the destinations this client has subscribed to.
getBody() - Method in class org.atmosphere.stomp.protocol.Frame: Gets the body.
getDestinationForId(String) - Method in class org.atmosphere.stomp.Subscriptions: Gets the destination for the given subscription ID.
getFromSession(AtmosphereResourceSession) - Static method in class org.atmosphere.stomp.Subscriptions: Gets a Subscriptions object from the given session.
getHeaders() - Method in class org.atmosphere.stomp.protocol.Frame: Gets the headers.
getResource() - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor.StompAtmosphereResource: Gets the wrapped resource.
getSubscriptionsForDestination(String) - Method in class org.atmosphere.stomp.Subscriptions: Gets the subscriptions for the given destination.

H

handle(AtmosphereFramework, Class<Object>) - Method in class org.atmosphere.cpr.packages.StompEndpointProcessor
HandlerHelper - Enum in org.atmosphere.stomp.handler: This enum defines a singleton that helps to extract an AtmosphereHandler according to the state of an AtmosphereResource.
HandlerHelper.Procedure - Interface in org.atmosphere.stomp.handler: This interface defined a method with a signature like a procedure to process an handler.
Header - Interface in org.atmosphere.stomp.protocol: This interface defines all default headers in STOMP protocol.
HEART_BEAT - Static variable in interface org.atmosphere.stomp.protocol.Header: Specify the test of healthiness of the underlying TCP connection
HIGHEST_VERSION - Static variable in class org.atmosphere.stomp.interceptor.ConnectInterceptor: The highest version we currently support.
HOST - Static variable in interface org.atmosphere.stomp.protocol.Header: The name of a virtual host that the client wishes to connect to.

I

ID - Static variable in interface org.atmosphere.stomp.protocol.Header: The subscription ID.
IllegalActionException - Exception in org.atmosphere.stomp.protocol: This class represents an exception thrown when we try to create an action with an unknown String representation.
IllegalActionException() - Constructor for exception org.atmosphere.stomp.protocol.IllegalActionException
init(AtmosphereConfig) - Method in class org.atmosphere.stomp.StompBroadcastFilter
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.AbortInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.BeginInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.CommitInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.ConnectInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.DisconnectInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.SendInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.SubscribeInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.UnsubscribeInterceptor: Inspects the AtmosphereResource with its extracted Frame.
inspect(AtmosphereFramework, Frame, FrameInterceptor.StompAtmosphereResource) - Method in interface org.atmosphere.stomp.StompInterceptor: Inspects the AtmosphereResource with its extracted Frame.
invokeOnHeartbeat(AtmosphereResourceEvent) - Static method in class org.atmosphere.cpr.packages.StompEndpointProcessor: Invokes the heartbeat method if not null which has been detected during endpoint detection.

L

LOGIN - Static variable in interface org.atmosphere.stomp.protocol.Header: The user id used to authenticate against a secured STOMP server.

M

MESSAGE - Static variable in interface org.atmosphere.stomp.protocol.Header: Error message.
MESSAGE_ID - Static variable in interface org.atmosphere.stomp.protocol.Header: Delivered message ID.

O

onHeartbeat(AtmosphereResourceEvent) - Method in class org.atmosphere.stomp.handler.StompSendActionAtmosphereHandler
onRequest(AtmosphereResource) - Method in class org.atmosphere.stomp.handler.StompSendActionAtmosphereHandler
org.atmosphere.cpr.packages - package org.atmosphere.cpr.packages
org.atmosphere.stomp - package org.atmosphere.stomp
org.atmosphere.stomp.annotation - package org.atmosphere.stomp.annotation
org.atmosphere.stomp.handler - package org.atmosphere.stomp.handler
org.atmosphere.stomp.interceptor - package org.atmosphere.stomp.interceptor
org.atmosphere.stomp.protocol - package org.atmosphere.stomp.protocol

P

parse(String) - Static method in enum org.atmosphere.stomp.protocol.Action: Gets an Action from its String representation.
parse() - Method in class org.atmosphere.stomp.protocol.Parser: Parses the Parser.stream to extract data.
parse(String) - Method in interface org.atmosphere.stomp.protocol.StompFormat: Takes the given String and converts it to a Frame.
parse(String) - Method in class org.atmosphere.stomp.protocol.StompFormatImpl: Takes the given String and converts it to a Frame.
ParseException - Exception in org.atmosphere.stomp.protocol: This class represents a base exception for any frame parsing issue.
ParseException(Exception) - Constructor for exception org.atmosphere.stomp.protocol.ParseException: Builds a new exception with an origin.
ParseException() - Constructor for exception org.atmosphere.stomp.protocol.ParseException: Builds a new exception.
Parser - Class in org.atmosphere.stomp.protocol: This class parses text stream that respects STOMP protocol to extract a structured Frame that provides a set of information.
Parser(String) - Constructor for class org.atmosphere.stomp.protocol.Parser: Builds a new Parser for the given text stream.
PASSCODE - Static variable in interface org.atmosphere.stomp.protocol.Header: The password used to authenticate against a secured STOMP server.
postInspect(AtmosphereResource) - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor

R

RECEIPT - Static variable in interface org.atmosphere.stomp.protocol.Header: Ask for server acknowledgment.
RECEIPT_ID - Static variable in interface org.atmosphere.stomp.protocol.Header: Server acknowledgment ID.
removeSubscription(String) - Method in class org.atmosphere.stomp.Subscriptions: Removes the subscription identified by the given ID.
retrieve(Class<T>, AtmosphereConfig) - Method in enum org.atmosphere.stomp.interceptor.FrameInterceptor.PropertyClass: Checks in the AtmosphereConfig if the FrameInterceptor.PropertyClass.propertyName is defined as an init-param and instantiate the appropriate class.

S

SendInterceptor - Class in org.atmosphere.stomp.interceptor: Invokes the method annotated with StompService inside any ManagedService that defines a destination that matched the destination String inside the specified Strings.
SendInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.SendInterceptor
SERVER - Static variable in interface org.atmosphere.stomp.protocol.Header: Server name and version that exposes STOMP support.
SESSION - Static variable in interface org.atmosphere.stomp.protocol.Header: ID that identifies the session.
setStompFormat(StompFormat) - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor: Sets the StompFormat that wire frames.
STOMP_HEARTBEAT_DATA - Static variable in class org.atmosphere.stomp.interceptor.ConnectInterceptor: The padding data for STOMP heartbeat.
STOMP_MESSAGE_BODY - Static variable in class org.atmosphere.stomp.interceptor.FrameInterceptor: The attribute name this interceptor uses to inject a parsed body in the request when it is extracted from the frame.
StompBroadcastFilter - Class in org.atmosphere.stomp: This filter transforms the broadcasted String considered as STOMP body to a message.
StompBroadcastFilter() - Constructor for class org.atmosphere.stomp.StompBroadcastFilter
StompEndpoint - Annotation Type in org.atmosphere.stomp.annotation: Enable Stomp support on an annotated ManagedService.
StompEndpointProcessor - Class in org.atmosphere.cpr.packages: This processor handles classes annotated with StompEndpoint.
StompEndpointProcessor() - Constructor for class org.atmosphere.cpr.packages.StompEndpointProcessor
StompFormat - Interface in org.atmosphere.stomp.protocol: This interfaces defines methods that allows to convert a String object into a Frame object and vice-versa.
StompFormatImpl - Class in org.atmosphere.stomp.protocol: This StompFormat implementation is based in apache Apollo.
StompFormatImpl() - Constructor for class org.atmosphere.stomp.protocol.StompFormatImpl
StompInterceptor - Interface in org.atmosphere.stomp: A StompInterceptor is an extension of AtmosphereInterceptor to inspect an AtmosphereResource that contains in its request body a Frame.
StompSendActionAtmosphereHandler - Class in org.atmosphere.stomp.handler: This handler wraps the method to be invoked when the send action is performed with a STOMP frame.
StompSendActionAtmosphereHandler(Object, Method, Encoder<Object, String>, Decoder<String, ?>, Broadcaster, Method) - Constructor for class org.atmosphere.stomp.handler.StompSendActionAtmosphereHandler: Creates a new instance.
StompService - Annotation Type in org.atmosphere.stomp.annotation: This annotation, when used on a method, indicates which invocation should be done for a particular send.
SubscribeInterceptor - Class in org.atmosphere.stomp.interceptor: Adds the given AtmosphereResource to the Broadcaster identified with the path specified in the given Strings.
SubscribeInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.SubscribeInterceptor
SUBSCRIPTION - Static variable in interface org.atmosphere.stomp.protocol.Header: Subscription ID.
Subscriptions - Class in org.atmosphere.stomp: An AtmosphereResource can subscribes to many destination.
Subscriptions() - Constructor for class org.atmosphere.stomp.Subscriptions: Builds a new instance.

T

toFrame() - Method in class org.atmosphere.stomp.protocol.Parser: Builds a Frame that provides information extracted from Parser.stream.
toString() - Method in enum org.atmosphere.stomp.interceptor.FrameInterceptor.PropertyClass
TRANSACTION - Static variable in interface org.atmosphere.stomp.protocol.Header: The transaction ID.

U

UnsubscribeInterceptor - Class in org.atmosphere.stomp.interceptor: Removes the given AtmosphereResource from the Broadcaster identified with the path specified in the given Strings.
UnsubscribeInterceptor() - Constructor for class org.atmosphere.stomp.interceptor.UnsubscribeInterceptor

V

valueOf(String) - Static method in enum org.atmosphere.stomp.handler.HandlerHelper: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.atmosphere.stomp.interceptor.FrameInterceptor.PropertyClass: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.atmosphere.stomp.protocol.Action: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.atmosphere.stomp.handler.HandlerHelper: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.atmosphere.stomp.interceptor.FrameInterceptor.PropertyClass: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.atmosphere.stomp.protocol.Action: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in interface org.atmosphere.stomp.protocol.Header: The supported protocol versions.
VERSIONS - Static variable in class org.atmosphere.stomp.interceptor.ConnectInterceptor: Supported versions.

W

write(Action, Map<String, String>) - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor.StompAtmosphereResource: Write a frame with its headers.
write(Action, Map<String, String>, String) - Method in class org.atmosphere.stomp.interceptor.FrameInterceptor.StompAtmosphereResource: Write a frame with its headers and a content.

A B C D E F G H I L M O P R S T U V W