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

Part Number E13941-05

com.bea.httppubsub
Interface BayeuxMessage

All Superinterfaces:
Serializable
All Known Subinterfaces:
EventMessage

public interface BayeuxMessage
extends Serializable

Bayeux messages are JSON encoded objects exchanged between pub/sub server and Bayeux client.

Since:
10.3.0.0

Nested Class Summary
static class BayeuxMessage.TYPE
          The message type indicates the type of message.
 
Method Summary
 String getChannel()
          Get the channel name for this message.
 Client getClient()
          Get the client sending this message
 BayeuxMessage.TYPE getType()
          Get the type of the message
 String toJSONRequestString()
          A string representative for a Bayeux message when this message is a request from the client to pub/sub server.
 String toJSONResponseString()
          A string representative for a Bayeux message when this message is a response from pub/sub server to a client.
 

Method Detail

getClient

Client getClient()
Get the client sending this message

Returns:
the client sending this message

getType

BayeuxMessage.TYPE getType()
Get the type of the message

Returns:
the message type

getChannel

String getChannel()
Get the channel name for this message. The name could be a wild card pattern like /foo/* or /foo/bar/**

Returns:
the channel name

toJSONRequestString

String toJSONRequestString()
A string representative for a Bayeux message when this message is a request from the client to pub/sub server.

Returns:
string representative for incoming Bayeux message.

toJSONResponseString

String toJSONResponseString()
A string representative for a Bayeux message when this message is a response from pub/sub server to a client.

Returns:
string representative for outgoing Bayeux message.

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.5)

Part Number E13941-05