Package org.red5.server

Class ClientRegistry

java.lang.Object

org.red5.server.ClientRegistry

All Implemented Interfaces:

IClientRegistry, ClientRegistryMXBean

@ManagedResource(objectName="org.red5.server:type=ClientRegistry,name=default",
                 description="ClientRegistry")
public class ClientRegistry
extends Object
implements IClientRegistry, ClientRegistryMXBean

Registry for clients, wherein clients are mapped by their id.

Author:

The Red5 Project

Constructor Summary

Constructors

Constructor	Description
ClientRegistry()	Constructor for ClientRegistry.
ClientRegistry(String name)	Constructor for ClientRegistry.

Method Summary

Modifier and Type	Method	Description
void	addClient(IClient client)	Adds a client to the registry.
Client	getClient(String id)	getClient.
ClientList<Client>	getClientList()	Returns a list of Clients.
protected Collection<IClient>	getClients()	Return collection of clients
boolean	hasClient(String id)	Check if a client with a given id exists.
protected boolean	hasClients()	Check if client registry contains clients.
IClient	lookupClient(String id)	Return an existing client from a client id.
IClient	newClient(Object[] params)	Return client from next id with given params
String	nextId()	Return next client id
String	previousId()	Return previous client id
void	removeClient(IClient client)	Removes client from registry

Methods inherited from class java.lang.Object

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

Constructor Details

ClientRegistry

public ClientRegistry()

Constructor for ClientRegistry.

ClientRegistry

public ClientRegistry(String name)

Constructor for ClientRegistry.

Parameters:

name - a String object

Method Details

addClient

public void addClient(IClient client)

Adds a client to the registry. Add client to registry

Specified by:

addClient in interface IClientRegistry

Parameters:

client - client

getClient

public Client getClient(String id)
                 throws ClientNotFoundException

getClient.

Specified by:

getClient in interface ClientRegistryMXBean

Parameters:

id - a String object

Returns:

a Client object

Throws:

ClientNotFoundException - if any.

getClientList

public ClientList<Client> getClientList()

Returns a list of Clients.

Specified by:

getClientList in interface ClientRegistryMXBean

Returns:

a ClientList object

hasClients

protected boolean hasClients()

Check if client registry contains clients.

Returns:

 True
 

if clients exist, otherwise

 False
 

getClients

protected Collection<IClient> getClients()

Return collection of clients

Returns:

Collection of clients

hasClient

public boolean hasClient(String id)

Check if a client with a given id exists. Check whether registry has client with given id

Specified by:

hasClient in interface ClientRegistryMXBean

Specified by:

hasClient in interface IClientRegistry

Parameters:

id - the id of the client to check for

Returns:

 true
 

if the client exists,

 false
 

otherwise

lookupClient

public IClient lookupClient(String id)
                     throws ClientNotFoundException

Return an existing client from a client id. Return client by id

Specified by:

lookupClient in interface IClientRegistry

Parameters:

id - the id of the client to return

Returns:

the client object

Throws:

ClientNotFoundException - no client with the passed id exists

newClient

public IClient newClient(Object[] params)
                  throws ClientNotFoundException,
ClientRejectedException

Return client from next id with given params

Specified by:

newClient in interface IClientRegistry

Parameters:

params - Client params

Returns:

Client object

Throws:

ClientNotFoundException - if client not found

ClientRejectedException - if client rejected

nextId

public String nextId()

Return next client id

Specified by:

nextId in interface ClientRegistryMXBean

Returns:

Next client id

previousId

public String previousId()

Return previous client id

Specified by:

previousId in interface ClientRegistryMXBean

Returns:

Previous client id

removeClient

public void removeClient(IClient client)

Removes client from registry

Parameters:

client - Client to remove