Package org.atmosphere.cpr

Class DefaultAtmosphereResourceFactory

java.lang.Object

org.atmosphere.cpr.DefaultAtmosphereResourceFactory

All Implemented Interfaces:

AtmosphereResourceFactory, AtmosphereConfigAware

public class DefaultAtmosphereResourceFactory
extends Object
implements AtmosphereResourceFactory

A Factory used to manage AtmosphereResource instances. You can use this factory to create, remove and find AtmosphereResource instances that are associated with one or several Broadcasters.

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.cpr.AtmosphereResourceFactory

AtmosphereResourceFactory.Async

Constructor Summary

Constructors

Constructor	Description
DefaultAtmosphereResourceFactory()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
AtmosphereResource	create(AtmosphereConfig config, String uuid)	Create an AtmosphereResource associated with the uuid.
AtmosphereResource	create(AtmosphereConfig config, String uuid, AtmosphereRequest request)	Create an AtmosphereResource associated with the uuid.
AtmosphereResource	create(AtmosphereConfig config, AtmosphereRequest request, AtmosphereResponse response, AsyncSupport<?> a)	Create an AtmosphereResourceImpl
AtmosphereResource	create(AtmosphereConfig config, AtmosphereResponse response, AsyncSupport<?> a)	Create an AtmosphereResourceImpl.
AtmosphereResource	create(AtmosphereConfig config, Broadcaster broadcaster, AtmosphereRequest request, AtmosphereResponse response, AsyncSupport<?> a, AtmosphereHandler handler)	Create an AtmosphereResourceImpl.
AtmosphereResource	create(AtmosphereConfig config, Broadcaster broadcaster, AtmosphereRequest request, AtmosphereResponse response, AsyncSupport<?> a, AtmosphereHandler handler, AtmosphereResource.TRANSPORT t)	Create an AtmosphereResourceImpl.
AtmosphereResource	create(AtmosphereConfig config, Broadcaster broadcaster, AtmosphereResponse response, AsyncSupport<?> a, AtmosphereHandler handler)	Create an AtmosphereResourceImpl.
AtmosphereResource	create(AtmosphereConfig config, Broadcaster broadcaster, AtmosphereResponse response, AsyncSupport<?> a, AtmosphereHandler handler, AtmosphereResource.TRANSPORT t)
void	destroy()
AtmosphereResource	find(String uuid)	Deprecated. Use findResource(String) which returns Optional instead of null.
Collection<AtmosphereResource>	findAll()
Optional<AtmosphereResource>	findResource(String uuid)	Find an AtmosphereResource based on its AtmosphereResource.uuid().
void	locate(String uuid, AtmosphereResourceFactory.Async async)	Locate an AtmosphereResource, based on its AtmosphereResource.uuid(), in a cluster.
void	registerUuidForFindCandidate(AtmosphereResource r)	Register an AtmosphereResource for being a candidate to find(String) operation.
AtmosphereResource	remove(String uuid)	Remove the AtmosphereResource from all instances of Broadcaster.
ConcurrentMap<String,AtmosphereResource>	resources()
void	unRegisterUuidForFindCandidate(AtmosphereResource r)	Un register an AtmosphereResource for being a candidate to find(String) operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultAtmosphereResourceFactory

public DefaultAtmosphereResourceFactory()

Method Details

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Specified by:

configure in interface AtmosphereResourceFactory

Parameters:

config - AtmosphereConfig

create

public AtmosphereResource create(AtmosphereConfig config,
 AtmosphereRequest request,
 AtmosphereResponse response,
 AsyncSupport<?> a)

Create an AtmosphereResourceImpl

Specified by:

create in interface AtmosphereResourceFactory

Parameters:

config - an AtmosphereConfig

request - an AtmosphereResponse

a - AsyncSupport

Returns:

an AtmosphereResourceImpl

create

public AtmosphereResource create(AtmosphereConfig config,
 Broadcaster broadcaster,
 AtmosphereRequest request,
 AtmosphereResponse response,
 AsyncSupport<?> a,
 AtmosphereHandler handler)

Create an AtmosphereResourceImpl.

Specified by:

create in interface AtmosphereResourceFactory

Parameters:

config - an AtmosphereConfig

broadcaster - a Broadcaster

response - an AtmosphereResponse

a - AsyncSupport

handler - an AtmosphereHandler

Returns:

an AtmosphereResourceImpl

create

public AtmosphereResource create(AtmosphereConfig config,
 Broadcaster broadcaster,
 AtmosphereRequest request,
 AtmosphereResponse response,
 AsyncSupport<?> a,
 AtmosphereHandler handler,
 AtmosphereResource.TRANSPORT t)

Create an AtmosphereResourceImpl.

Specified by:

create in interface AtmosphereResourceFactory

Parameters:

config - an AtmosphereConfig

broadcaster - a Broadcaster

response - an AtmosphereResponse

a - AsyncSupport

handler - an AtmosphereHandler

t - an AtmosphereResource.TRANSPORT

Returns:

an AtmosphereResourceImpl

create

public AtmosphereResource create(AtmosphereConfig config,
 Broadcaster broadcaster,
 AtmosphereResponse response,
 AsyncSupport<?> a,
 AtmosphereHandler handler)

Create an AtmosphereResourceImpl.

Specified by:

create in interface AtmosphereResourceFactory

Parameters:

config - an AtmosphereConfig

broadcaster - a Broadcaster

response - an AtmosphereResponse

a - AsyncSupport

handler - an AtmosphereHandler

Returns:

an AtmosphereResourceImpl

create

public AtmosphereResource create(AtmosphereConfig config,
 Broadcaster broadcaster,
 AtmosphereResponse response,
 AsyncSupport<?> a,
 AtmosphereHandler handler,
 AtmosphereResource.TRANSPORT t)

Specified by:

create in interface AtmosphereResourceFactory

create

public AtmosphereResource create(AtmosphereConfig config,
 AtmosphereResponse response,
 AsyncSupport<?> a)

Create an AtmosphereResourceImpl.

Specified by:

create in interface AtmosphereResourceFactory

Parameters:

config - an AtmosphereConfig

response - an AtmosphereResponse

a - AsyncSupport

Returns:

an AtmosphereResourceImpl

create

public AtmosphereResource create(AtmosphereConfig config,
 String uuid)

Create an AtmosphereResource associated with the uuid.

Specified by:

create in interface AtmosphereResourceFactory

Parameters:

config - an AtmosphereConfig

uuid - a String representing a UUID

Returns:

create

public AtmosphereResource create(AtmosphereConfig config,
 String uuid,
 AtmosphereRequest request)

Create an AtmosphereResource associated with the uuid.

Specified by:

create in interface AtmosphereResourceFactory

Parameters:

config - an AtmosphereConfig

uuid - a String representing a UUID

request - a AtmosphereRequest

Returns:

remove

public AtmosphereResource remove(String uuid)

Remove the AtmosphereResource from all instances of Broadcaster.

Specified by:

remove in interface AtmosphereResourceFactory

Parameters:

uuid - the AtmosphereResource.uuid()

Returns:

the AtmosphereResource, or null if not found.

find

@Deprecated(since="4.0.0",
            forRemoval=false)
public AtmosphereResource find(String uuid)

Deprecated.

Use findResource(String) which returns Optional instead of null.

Find an AtmosphereResource based on its AtmosphereResource.uuid().

Specified by:

find in interface AtmosphereResourceFactory

Parameters:

uuid - the AtmosphereResource.uuid()

Returns:

the AtmosphereResource, or null if not found.

findResource

public Optional<AtmosphereResource> findResource(String uuid)

Find an AtmosphereResource based on its AtmosphereResource.uuid().

This is the preferred alternative to AtmosphereResourceFactory.find(String) as it returns an Optional instead of null, making the absent-resource case explicit at the call site.

Specified by:

findResource in interface AtmosphereResourceFactory

Parameters:

uuid - the AtmosphereResource.uuid()

Returns:

an Optional containing the AtmosphereResource, or empty if not found.

locate

public void locate(String uuid,
 AtmosphereResourceFactory.Async async)

Description copied from interface: AtmosphereResourceFactory

Locate an AtmosphereResource, based on its AtmosphereResource.uuid(), in a cluster. If the AtmosphereResource is available in the cluster, the AtmosphereResourceFactory.Async.available(org.atmosphere.cpr.AtmosphereResource) callback will be invoked. If not, the

invalid reference

org.atmosphere.cpr.AtmosphereResourceFactory.Async#notAvailable

Specified by:

locate in interface AtmosphereResourceFactory

Parameters:

uuid - the AtmosphereResource.uuid()

async - an AtmosphereResourceFactory.Async

registerUuidForFindCandidate

public void registerUuidForFindCandidate(AtmosphereResource r)

Register an AtmosphereResource for being a candidate to find(String) operation.

Specified by:

registerUuidForFindCandidate in interface AtmosphereResourceFactory

Parameters:

r - AtmosphereResource

unRegisterUuidForFindCandidate

public void unRegisterUuidForFindCandidate(AtmosphereResource r)

Un register an AtmosphereResource for being a candidate to find(String) operation.

Specified by:

unRegisterUuidForFindCandidate in interface AtmosphereResourceFactory

Parameters:

r - AtmosphereResource

destroy

public void destroy()

Specified by:

destroy in interface AtmosphereResourceFactory

resources

public ConcurrentMap<String,AtmosphereResource> resources()

Specified by:

resources in interface AtmosphereResourceFactory

findAll

public Collection<AtmosphereResource> findAll()

Specified by:

findAll in interface AtmosphereResourceFactory