Package com.bea.httppubsub

Class LocalClient

java.lang.Object

com.bea.httppubsub.LocalClient

All Implemented Interfaces:

Client, java.io.Serializable

public abstract class LocalClient
extends java.lang.Object
implements Client

The main purpose of LocalClient class is for pubsub server side programming. The LocalClient class is the client representative on server side, which has no transport associate with it, no subscribed channel, and is always connected.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.bea.httppubsub.Client

Client.ConnectionType

Method Summary

Modifier and Type	Method	Description
AuthenticatedUser	getAuthenticatedUser()	Get authenticated user object of this client.
java.util.Set<java.lang.String>	getChannelSubscriptions()	Get all the channels currently subscribed by this client.
abstract void	registerMessageListener(DeliveredMessageListener listener)	Register a LocalClientMessageListener to this LocalClient, the listener will receive messages sent to channels that this LocalClient subscribes to.
abstract void	unregisterMessageListener(DeliveredMessageListener listener)	Unregister a LocalClientMessageListener to this LocalClient.

Methods inherited from interface com.bea.httppubsub.Client

getId, getPublishedMessageCount

Methods inherited from class java.lang.Object

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

Method Detail

getAuthenticatedUser

public AuthenticatedUser getAuthenticatedUser()

Description copied from interface: Client

Get authenticated user object of this client.

Specified by:

getAuthenticatedUser in interface Client

Returns:

AuthenticatedUser object.

getChannelSubscriptions

public java.util.Set<java.lang.String> getChannelSubscriptions()

Description copied from interface: Client

Get all the channels currently subscribed by this client.

Specified by:

getChannelSubscriptions in interface Client

Returns:

a Set of all active subscriptions

registerMessageListener

public abstract void registerMessageListener(DeliveredMessageListener listener)

Register a LocalClientMessageListener to this LocalClient, the listener will receive messages sent to channels that this LocalClient subscribes to. Multiple listeners could be registered to same LocalClient and one listener also could be registered to multiple LocalClients.

Parameters:

listener - the listener to be registered

unregisterMessageListener

public abstract void unregisterMessageListener(DeliveredMessageListener listener)

Unregister a LocalClientMessageListener to this LocalClient.

Parameters:

listener - the listener which has been registered to this LocalClient.