org.jamppa.client.plugin.xep0077

Class Registration

java.lang.Object

org.xmpp.packet.Packet

org.xmpp.packet.IQ

org.jamppa.client.plugin.xep0077.Registration

public class Registration
extends org.xmpp.packet.IQ

Represents registration packets. An empty GET query will cause the server to return information about it's registration support. SET queries can be used to create accounts or update existing account information. XMPP servers may require a number of attributes to be set when creating a new account. The standard account attributes are as follows:

• name -- the user's name.
• first -- the user's first name.
• last -- the user's last name.
• email -- the user's email address.
• city -- the user's city.
• state -- the user's state.
• zip -- the user's ZIP code.
• phone -- the user's phone number.
• url -- the user's website.
• date -- the date the registration took place.
• misc -- other miscellaneous information to associate with the account.
• text -- textual information to associate with the account.
• remove -- empty flag to remove account.

Author:

Matt Tucker

Nested Class Summary

Nested classes/interfaces inherited from class org.xmpp.packet.IQ

org.xmpp.packet.IQ.Type

Field Summary

Fields inherited from class org.xmpp.packet.Packet

docFactory, element, fromJID, toJID

Constructor Summary

Constructors

Constructor and Description
Registration()
Registration(org.dom4j.Element el)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns the map of String key/value pairs of account attributes.
String	getInstructions() Returns the registration instructions, or null if no instructions have been set.
void	setAttributes(Map<String,String> attributes) Sets the account attributes.
void	setInstructions(String instructions) Sets the registration instructions.

Methods inherited from class org.xmpp.packet.IQ

addExtension, createCopy, createResultIQ, deleteExtension, getChildElement, getExtension, getType, isRequest, isResponse, setChildElement, setChildElement, setType

Methods inherited from class org.xmpp.packet.Packet

getElement, getError, getFrom, getID, getTo, setError, setError, setFrom, setFrom, setID, setTo, setTo, toString, toXML

Methods inherited from class java.lang.Object

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

Constructor Detail

Registration

public Registration()

Registration

public Registration(org.dom4j.Element el)

Method Detail

getInstructions

public String getInstructions()

Returns the registration instructions, or null if no instructions have been set. If present, instructions should be displayed to the end-user that will complete the registration process.

Returns:

the registration instructions, or null if there are none.

setInstructions

public void setInstructions(String instructions)

Sets the registration instructions.

Parameters:

instructions - the registration instructions.

getAttributes

public Map<String,String> getAttributes()

Returns the map of String key/value pairs of account attributes.

Returns:

the account attributes.

setAttributes

public void setAttributes(Map<String,String> attributes)

Sets the account attributes. The map must only contain String key/value pairs.

Parameters:

attributes - the account attributes.