Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware
Oracle WebLogic Server API Reference
11g Release 1 (10.3.6)

Part Number E13941-06
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.bea.httppubsub
Class LocalClient

java.lang.Object
  extended by com.bea.httppubsub.LocalClient
All Implemented Interfaces:
Client, Serializable
public abstract class LocalClient
extends 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.

Since:
10.3.0.0
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.bea.httppubsub.Client
Client.ConnectionType
 
Constructor Summary
LocalClient()
           
 
Method Summary
 AuthenticatedUser getAuthenticatedUser()
          Get authenticated user object of this client.
 Set<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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.bea.httppubsub.Client
getId, getPublishedMessageCount
 

Constructor Detail

LocalClient

public LocalClient()
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 Set<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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server API Reference
11g Release 1 (10.3.6)

Part Number E13941-06
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD