org.jivesoftware.smackx.amp.packet

Class AMPExtension

java.lang.Object

org.jivesoftware.smackx.amp.packet.AMPExtension

All Implemented Interfaces:

PacketExtension

public class AMPExtension
extends Object
implements PacketExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AMPExtension.Action amp action attribute See http://xmpp.org/extensions/xep-0079.html#actions-def
static interface	AMPExtension.Condition Interface for defining XEP-0079 Conditions and their values
static class	AMPExtension.Rule XEP-0079 Rule element.
static class	AMPExtension.Status amp notification status as defined by XEP-0079

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AMPExtension() Create a new amp request extension to be used with outgoing message.
AMPExtension(String from, String to, AMPExtension.Status status) Create a new AMPExtension instance with defined from, to and status attributes.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRule(AMPExtension.Rule rule) Adds a rule to the amp element.
String	getElementName() Returns the XML element name of the extension sub-packet root element.
String	getFrom()
String	getNamespace() Returns the XML namespace of the extension sub-packet root element.
Collection<AMPExtension.Rule>	getRules() Returns a Collection of the rules in the packet.
int	getRulesCount() Returns a count of the rules in the AMP packet.
AMPExtension.Status	getStatus() Status of this amp notification
String	getTo()
boolean	isPerHop() Returns true is this ruleset is "per-hop".
void	setPerHop(boolean enabled) Sets this amp ruleset to be "per-hop".
String	toXML() Returns the XML representation of a XHTML extension according the specification.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

AMPExtension

public AMPExtension(String from,
            String to,
            AMPExtension.Status status)

Create a new AMPExtension instance with defined from, to and status attributes. Used to create incoming packets.

Parameters:

from - jid that triggered this amp callback.

to - receiver of this amp receipt.

status - status of this amp receipt.

AMPExtension

public AMPExtension()

Create a new amp request extension to be used with outgoing message.

Method Detail

getFrom

public String getFrom()

Returns:

jid that triggered this amp callback.

getTo

public String getTo()

Returns:

receiver of this amp receipt.

getStatus

public AMPExtension.Status getStatus()

Status of this amp notification

Returns:

Status for this amp

getRules

public Collection<AMPExtension.Rule> getRules()

Returns a Collection of the rules in the packet.

Returns:

a Collection of the rules in the packet.

addRule

public void addRule(AMPExtension.Rule rule)

Adds a rule to the amp element. Amp can have any number of rules.

Parameters:

rule - the rule to add.

getRulesCount

public int getRulesCount()

Returns a count of the rules in the AMP packet.

Returns:

the number of rules in the AMP packet.

setPerHop

public void setPerHop(boolean enabled)

Sets this amp ruleset to be "per-hop".

Parameters:

enabled - true if "per-hop" should be enabled

isPerHop

public boolean isPerHop()

Returns true is this ruleset is "per-hop".

Returns:

true is this ruleset is "per-hop".

getElementName

public String getElementName()

Returns the XML element name of the extension sub-packet root element. Always returns "amp"

Specified by:

getElementName in interface PacketExtension

Returns:

the XML element name of the packet extension.

getNamespace

public String getNamespace()

Returns the XML namespace of the extension sub-packet root element. According the specification the namespace is always "http://jabber.org/protocol/xhtml-im"

Specified by:

getNamespace in interface PacketExtension

Returns:

the XML namespace of the packet extension.

toXML

public String toXML()

Returns the XML representation of a XHTML extension according the specification.

Specified by:

toXML in interface PacketExtension

Returns:

the packet extension as XML.