org.atmosphere.cpr

Interface BroadcasterFactory

All Known Implementing Classes:

DefaultBroadcasterFactory, PoolableBroadcasterFactory

public interface BroadcasterFactory

Factory for Broadcaster used by Atmosphere when creating broadcasters.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BroadcasterFactory.BroadcasterCreationException

Method Summary

Modifier and Type	Method and Description
boolean	add(Broadcaster b, java.lang.Object id) Add a Broadcaster to the list.
BroadcasterFactory	addBroadcasterListener(BroadcasterListener b) Add a BroadcasterListener
java.util.Collection<BroadcasterListener>	broadcasterListeners() Return all BroadcasterListener
void	configure(java.lang.Class<? extends Broadcaster> clazz, java.lang.String broadcasterLifeCyclePolicy, AtmosphereConfig c) Configure the factory
void	destroy() Shutdown all Broadcasters.
Broadcaster	get() Return an instance of the default Broadcaster.
<T extends Broadcaster> T	get(java.lang.Class<T> c, java.lang.Object id) Create a new instance of Broadcaster and store it for.
Broadcaster	get(java.lang.Object id) Create a new instance of Broadcaster and store it for.
<T extends Broadcaster> T	lookup(java.lang.Class<T> c, java.lang.Object id) Lookup a Broadcaster instance using Broadcaster.getID() or ID
<T extends Broadcaster> T	lookup(java.lang.Class<T> c, java.lang.Object id, boolean createIfNull) Lookup a Broadcaster instance using Broadcaster.getID() or ID
<T extends Broadcaster> T	lookup(java.lang.Object id) Lookup a Broadcaster instance using Broadcaster.getID() or ID
<T extends Broadcaster> T	lookup(java.lang.Object id, boolean createIfNull) Lookup a Broadcaster instance using Broadcaster.getID() or ID
java.util.Collection<Broadcaster>	lookupAll() Return an immutable Collection of Broadcaster this factory contains.
boolean	remove(Broadcaster b, java.lang.Object id) Remove a Broadcaster from the list.
boolean	remove(java.lang.Object id) Remove the associated Broadcaster.
void	removeAllAtmosphereResource(AtmosphereResource r) Deprecated.
BroadcasterFactory	removeBroadcasterListener(BroadcasterListener b) Remove a BroadcasterListener

Method Detail

configure

void configure(java.lang.Class<? extends Broadcaster> clazz,
               java.lang.String broadcasterLifeCyclePolicy,
               AtmosphereConfig c)

Configure the factory

Parameters:

clazz - Broadcaster

broadcasterLifeCyclePolicy - BroadcasterLifeCyclePolicy

c - AtmosphereConfig

get

Broadcaster get()

Return an instance of the default Broadcaster.

The name of the Broadcaster will be randomly generated.

Returns:

an instance of the default Broadcaster

get

Broadcaster get(java.lang.Object id)

Create a new instance of Broadcaster and store it for.

Parameters:

id - The unique ID used to retrieve Broadcaster

Returns:

a new instance of Broadcaster

get

<T extends Broadcaster> T get(java.lang.Class<T> c,
                              java.lang.Object id)

Create a new instance of Broadcaster and store it for.

Parameters:

c - The Broadcaster class instance.

id - The unique ID used to retrieve Broadcaster

Returns:

a new instance of Broadcaster

destroy

void destroy()

Shutdown all Broadcasters.

add

boolean add(Broadcaster b,
            java.lang.Object id)

Add a Broadcaster to the list.

Parameters:

b - a Broadcaster

Returns:

false if a with the same name Broadcaster was already stored

remove

boolean remove(Broadcaster b,
               java.lang.Object id)

Remove a Broadcaster from the list.

Parameters:

b - a Broadcaster

id - the ID

Returns:

false if wasn't present, or Broadcaster

lookup

<T extends Broadcaster> T lookup(java.lang.Class<T> c,
                                 java.lang.Object id)

Lookup a Broadcaster instance using Broadcaster.getID() or ID

Parameters:

c -

id - The Broadcaster's unique ID, or name.

Returns:

a Broadcaster, or null if not found.

lookup

<T extends Broadcaster> T lookup(java.lang.Class<T> c,
                                 java.lang.Object id,
                                 boolean createIfNull)

Lookup a Broadcaster instance using Broadcaster.getID() or ID

Parameters:

c -

id - The Broadcaster's unique ID, or name.

createIfNull - If the broadcaster is not found, create it.

Returns:

a Broadcaster, or null if not found.

lookup

<T extends Broadcaster> T lookup(java.lang.Object id)

Lookup a Broadcaster instance using Broadcaster.getID() or ID

Parameters:

id - The Broadcaster's unique ID, or name.

Returns:

a Broadcaster, or null if not found.

lookup

<T extends Broadcaster> T lookup(java.lang.Object id,
                                 boolean createIfNull)

Lookup a Broadcaster instance using Broadcaster.getID() or ID

Parameters:

id - The Broadcaster's unique ID, or name.

createIfNull - If the broadcaster is not found, create it.

Returns:

a Broadcaster, or null if not found.

removeAllAtmosphereResource

@Deprecated
void removeAllAtmosphereResource(AtmosphereResource r)

Deprecated.

Remove all instances of AtmosphereResource from all registered Broadcasters.

Parameters:

r - an void AtmosphereResource

remove

boolean remove(java.lang.Object id)

Remove the associated Broadcaster.

lookupAll

java.util.Collection<Broadcaster> lookupAll()

Return an immutable Collection of Broadcaster this factory contains.

Returns:

an immutable Collection of Broadcaster this factory contains.

addBroadcasterListener

BroadcasterFactory addBroadcasterListener(BroadcasterListener b)

Add a BroadcasterListener

Parameters:

b - a BroadcasterListener

Returns:

this

removeBroadcasterListener

BroadcasterFactory removeBroadcasterListener(BroadcasterListener b)

Remove a BroadcasterListener

Parameters:

b - a BroadcasterListener

Returns:

this

broadcasterListeners

java.util.Collection<BroadcasterListener> broadcasterListeners()

Return all BroadcasterListener

Returns:

BroadcasterListener