org.jivesoftware.openfire.handler

Class IQPingHandler

java.lang.Object

org.jivesoftware.openfire.container.BasicModule

org.jivesoftware.openfire.handler.IQHandler

org.jivesoftware.openfire.handler.IQPingHandler

All Implemented Interfaces:

ChannelHandler, Module, ServerFeaturesProvider

public class IQPingHandler
extends IQHandler
implements ServerFeaturesProvider

Implements the XMPP Ping as defined by XEP-0199. This protocol offers an alternative to the traditional 'white space ping' approach of determining the availability of an entity. The XMPP Ping protocol allows pings to be performed in a more XML-friendly approach, which can be used over more than one hop in the communication path.

Author:

Guus der Kinderen

See Also:

XEP-0199:XMPP Ping

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME
static String	NAMESPACE

Fields inherited from class org.jivesoftware.openfire.handler.IQHandler

deliverer, sessionManager

Constructor Summary

Constructors

Constructor and Description
IQPingHandler() Constructs a new handler that will process XMPP Ping request.

Method Summary

Modifier and Type	Method and Description
Iterator<String>	getFeatures() Returns an Iterator (of String) with the supported features by the server.
IQHandlerInfo	getInfo() Returns the handler information to help generically handle IQ packets.
org.xmpp.packet.IQ	handleIQ(org.xmpp.packet.IQ packet) Handles the received IQ packet.

Methods inherited from class org.jivesoftware.openfire.handler.IQHandler

initialize, process

Methods inherited from class org.jivesoftware.openfire.container.BasicModule

destroy, getName, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

IQPingHandler

public IQPingHandler()

Constructs a new handler that will process XMPP Ping request.

Method Detail

handleIQ

public org.xmpp.packet.IQ handleIQ(org.xmpp.packet.IQ packet)

Description copied from class: IQHandler

Handles the received IQ packet.

Specified by:

handleIQ in class IQHandler

Parameters:

packet - the IQ packet to handle.

Returns:

the response to send back.

getInfo

public IQHandlerInfo getInfo()

Description copied from class: IQHandler

Returns the handler information to help generically handle IQ packets. IQHandlers that aren't local server iq handlers (e.g. chatbots, transports, etc) return null.

Specified by:

getInfo in class IQHandler

Returns:

The IQHandlerInfo for this handler

getFeatures

public Iterator<String> getFeatures()

Description copied from interface: ServerFeaturesProvider

Returns an Iterator (of String) with the supported features by the server. The features to include are the features offered and supported protocols by the SERVER. The idea is that different modules may provide their features that will ultimately be part of the features offered by the server.

Specified by:

getFeatures in interface ServerFeaturesProvider

Returns:

an Iterator (of String) with the supported features by the server.