Package org.primefaces.push

Interface RemoteEndpoint

All Known Implementing Classes:

RemoteEndpointImpl

public interface RemoteEndpoint

A representation of a remote client.

Method Summary

Modifier and Type	Method	Description
String	address()	Return the remote client IP
String	body()	Return a String representation of the request's body
Map<String,String>	headersMap()	Return the HTTP Headers
boolean	isOpen()	Is the underlying connection to the Browser still open.
String	path()	The path matching the associated PushEndpoint
String	pathSegments(int position)	Return the path()'s segment value at the specified position, or null if there is no value at that position
Map<String,String[]>	queryStrings()	Return the HTTP Query String
org.atmosphere.cpr.AtmosphereResource	resource()	The underlying AtmosphereResource in case the AtmosphereRequest or AtmosphereResource is needed
Status	status()	The current Status
org.atmosphere.cpr.AtmosphereResource.TRANSPORT	transport()	Return the underlying Atmosphere's Transport used.
String	uri()	Return the request URI

Method Detail

headersMap

Map<String,String> headersMap()

Return the HTTP Headers

Returns:

a Map of headers

queryStrings

Map<String,String[]> queryStrings()

Return the HTTP Query String

Returns:

a Map of Query String Value

transport

org.atmosphere.cpr.AtmosphereResource.TRANSPORT transport()

Return the underlying Atmosphere's Transport used.

Returns:

path

String path()

The path matching the associated PushEndpoint

Returns:

uri

String uri()

Return the request URI

Returns:

body

String body()

Return a String representation of the request's body

Returns:

a String representation of the request's body

status

Status status()

The current Status

Returns:

Status

address

String address()

Return the remote client IP

Returns:

the remote client IP

pathSegments

String pathSegments(int position)

Return the path()'s segment value at the specified position, or null if there is no value at that position

Parameters:

position - the path segment

Returns:

the value, or null if not found.

isOpen

boolean isOpen()

Is the underlying connection to the Browser still open.

Returns:

resource

org.atmosphere.cpr.AtmosphereResource resource()

The underlying AtmosphereResource in case the AtmosphereRequest or AtmosphereResource is needed

Returns:

AtmosphereResource