org.atmosphere.stomp.handler

Enum HandlerHelper

java.lang.Object

java.lang.Enum<HandlerHelper>

org.atmosphere.stomp.handler.HandlerHelper

All Implemented Interfaces:

Serializable, Comparable<HandlerHelper>

public enum HandlerHelper
extends Enum<HandlerHelper>

This enum defines a singleton that helps to extract an AtmosphereHandler according to the state of an AtmosphereResource.

Since:

0.2

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HandlerHelper.Procedure This interface defined a method with a signature like a procedure to process an handler.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton.

Method Summary

Methods

Modifier and Type	Method and Description
void	callHandler(org.atmosphere.cpr.AtmosphereResource resource, Map<String,String> headers, org.atmosphere.cpr.AtmosphereFramework framework, boolean byId, HandlerHelper.Procedure call) Gets the handler associated to the mapping specified in the given header and applies a procedure on it.
static HandlerHelper	valueOf(String name) Returns the enum constant of this type with the specified name.
static HandlerHelper[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final HandlerHelper INSTANCE

Singleton.

Method Detail

values

public static HandlerHelper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HandlerHelper c : HandlerHelper.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HandlerHelper valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

callHandler

public void callHandler(org.atmosphere.cpr.AtmosphereResource resource,
               Map<String,String> headers,
               org.atmosphere.cpr.AtmosphereFramework framework,
               boolean byId,
               HandlerHelper.Procedure call)
                 throws IOException

Gets the handler associated to the mapping specified in the given header and applies a procedure on it.

Parameters:

resource - the resource

headers - the headers with mapping

framework - the framework providing the handler

call - the procedure to call

byId - consider the Header.ID to find the handler or directly use the Header.DESTINATION

Throws:

IOException - of procedure fails