org.phoenixframework.channels

Class Envelope

java.lang.Object

org.phoenixframework.channels.Envelope

public class Envelope
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Envelope()
Envelope(java.lang.String topic, java.lang.String event, com.fasterxml.jackson.databind.JsonNode payload, java.lang.String ref)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEvent()
com.fasterxml.jackson.databind.JsonNode	getPayload()
java.lang.String	getReason() Helper to retrieve the value of "reason" from the payload
java.lang.String	getRef() Helper to retrieve the value of "ref" from the payload
java.lang.String	getResponseStatus() Helper to retrieve the value of "status" from the payload
java.lang.String	getTopic()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Envelope

public Envelope()

Envelope

public Envelope(java.lang.String topic,
                java.lang.String event,
                com.fasterxml.jackson.databind.JsonNode payload,
                java.lang.String ref)

Method Detail

getTopic

public java.lang.String getTopic()

getEvent

public java.lang.String getEvent()

getPayload

public com.fasterxml.jackson.databind.JsonNode getPayload()

getRef

public java.lang.String getRef()

Helper to retrieve the value of "ref" from the payload

Returns:

The ref string or null if not found

getResponseStatus

public java.lang.String getResponseStatus()

Helper to retrieve the value of "status" from the payload

Returns:

The status string or null if not found

getReason

public java.lang.String getReason()

Helper to retrieve the value of "reason" from the payload

Returns:

The reason string or null if not found

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object