Package org.atmosphere.cpr

Interface AtmosphereResourceFactory

All Superinterfaces:

AtmosphereConfigAware

All Known Implementing Classes:

DefaultAtmosphereResourceFactory

public interface AtmosphereResourceFactory
extends AtmosphereConfigAware

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

Modifier and Type	Interface	Description
static interface	AtmosphereResourceFactory.Async	An interface to use in order to retrieve an AtmosphereResource inside a cluster.

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()
default 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.

Method Details

configure

void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Parameters:

config - AtmosphereConfig

create

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

Create an AtmosphereResourceImpl

Parameters:

config - an AtmosphereConfig

request - an AtmosphereResponse

a - AsyncSupport

Returns:

an AtmosphereResourceImpl

create

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

Create an AtmosphereResourceImpl.

Parameters:

config - an AtmosphereConfig

broadcaster - a Broadcaster

response - an AtmosphereResponse

a - AsyncSupport

handler - an AtmosphereHandler

Returns:

an AtmosphereResourceImpl

create

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

Create an AtmosphereResourceImpl.

Parameters:

config - an AtmosphereConfig

broadcaster - a Broadcaster

response - an AtmosphereResponse

a - AsyncSupport

handler - an AtmosphereHandler

t - an AtmosphereResource.TRANSPORT

Returns:

an AtmosphereResourceImpl

create

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

Create an AtmosphereResourceImpl.

Parameters:

config - an AtmosphereConfig

broadcaster - a Broadcaster

response - an AtmosphereResponse

a - AsyncSupport

handler - an AtmosphereHandler

Returns:

an AtmosphereResourceImpl

create

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

create

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

Create an AtmosphereResourceImpl.

Parameters:

config - an AtmosphereConfig

response - an AtmosphereResponse

a - AsyncSupport

Returns:

an AtmosphereResourceImpl

create

AtmosphereResource create(AtmosphereConfig config,
 String uuid)

Create an AtmosphereResource associated with the uuid.

Parameters:

config - an AtmosphereConfig

uuid - a String representing a UUID

Returns:

create

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

Create an AtmosphereResource associated with the uuid.

Parameters:

config - an AtmosphereConfig

uuid - a String representing a UUID

request - a AtmosphereRequest

Returns:

remove

AtmosphereResource remove(String uuid)

Remove the AtmosphereResource from all instances of Broadcaster.

Parameters:

uuid - the AtmosphereResource.uuid()

Returns:

the AtmosphereResource, or null if not found.

find

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

Deprecated.

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

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

Parameters:

uuid - the AtmosphereResource.uuid()

Returns:

the AtmosphereResource, or null if not found.

findResource

default Optional<AtmosphereResource> findResource(String uuid)

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

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

Parameters:

uuid - the AtmosphereResource.uuid()

Returns:

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

locate

void locate(String uuid,
 AtmosphereResourceFactory.Async async)

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

Parameters:

uuid - the AtmosphereResource.uuid()

async - an AtmosphereResourceFactory.Async

registerUuidForFindCandidate

void registerUuidForFindCandidate(AtmosphereResource r)

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

Parameters:

r - AtmosphereResource

unRegisterUuidForFindCandidate

void unRegisterUuidForFindCandidate(AtmosphereResource r)

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

Parameters:

r - AtmosphereResource

destroy

void destroy()

resources

ConcurrentMap<String,AtmosphereResource> resources()

findAll

Collection<AtmosphereResource> findAll()