mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-10-31 17:25:58 +01:00
f7de4be1f9
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2191 b35dd754-fafc-0310-a699-88a17e54d16e
301 lines
No EOL
12 KiB
Java
301 lines
No EOL
12 KiB
Java
/**
|
|
* $RCSfile$
|
|
* $Revision$
|
|
* $Date$
|
|
*
|
|
* Copyright (C) 2002-2003 Jive Software. All rights reserved.
|
|
* ====================================================================
|
|
* The Jive Software License (based on Apache Software License, Version 1.1)
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* 3. The end-user documentation included with the redistribution,
|
|
* if any, must include the following acknowledgment:
|
|
* "This product includes software developed by
|
|
* Jive Software (http://www.jivesoftware.com)."
|
|
* Alternately, this acknowledgment may appear in the software itself,
|
|
* if and wherever such third-party acknowledgments normally appear.
|
|
*
|
|
* 4. The names "Smack" and "Jive Software" must not be used to
|
|
* endorse or promote products derived from this software without
|
|
* prior written permission. For written permission, please
|
|
* contact webmaster@jivesoftware.com.
|
|
*
|
|
* 5. Products derived from this software may not be called "Smack",
|
|
* nor may "Smack" appear in their name, without prior written
|
|
* permission of Jive Software.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR
|
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
|
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
* ====================================================================
|
|
*/
|
|
|
|
package org.jivesoftware.smack;
|
|
|
|
import org.jivesoftware.smack.packet.Registration;
|
|
import org.jivesoftware.smack.packet.IQ;
|
|
import org.jivesoftware.smack.filter.*;
|
|
import org.jivesoftware.smack.util.StringUtils;
|
|
|
|
import java.util.*;
|
|
|
|
/**
|
|
* Allows creation and management of accounts on an XMPP server.
|
|
*
|
|
* @see XMPPConnection#getAccountManager()
|
|
* @author Matt Tucker
|
|
*/
|
|
public class AccountManager {
|
|
|
|
private XMPPConnection connection;
|
|
private Registration info = null;
|
|
|
|
/**
|
|
* Creates a new AccountManager instance.
|
|
*
|
|
* @param connection a connection to a XMPP server.
|
|
*/
|
|
public AccountManager(XMPPConnection connection) {
|
|
this.connection = connection;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the server supports creating new accounts. Many servers require
|
|
* that you not be currently authenticated when creating new accounts, so the safest
|
|
* behavior is to only create new accounts before having logged in to a server.
|
|
*
|
|
* @return true if the server support creating new accounts.
|
|
*/
|
|
public boolean supportsAccountCreation() {
|
|
try {
|
|
if (info == null) {
|
|
getRegistrationInfo();
|
|
}
|
|
return info.getType() != IQ.Type.ERROR;
|
|
}
|
|
catch (XMPPException xe) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns an Iterator for the (String) names of the required account attributes.
|
|
* All attributes must be set when creating new accounts. The standard
|
|
* attributes are as follows: <ul>
|
|
* <li>name -- the user's name.
|
|
* <li>first -- the user's first name.
|
|
* <li>last -- the user's last name.
|
|
* <li>email -- the user's email address.
|
|
* <li>city -- the user's city.
|
|
* <li>state -- the user's state.
|
|
* <li>zip -- the user's ZIP code.
|
|
* <li>phone -- the user's phone number.
|
|
* <li>url -- the user's website.
|
|
* <li>date -- the date the registration took place.
|
|
* <li>misc -- other miscellaneous information to associate with the account.
|
|
* <li>text -- textual information to associate with the account.
|
|
* <li>remove -- empty flag to remove account.
|
|
* </ul><p>
|
|
*
|
|
* Typically, servers require no attributes when creating new accounts, or just
|
|
* the user's email address.
|
|
*
|
|
* @return the required account attributes.
|
|
*/
|
|
public Iterator getAccountAttributes() {
|
|
try {
|
|
if (info == null) {
|
|
getRegistrationInfo();
|
|
}
|
|
Map attributes = info.getAttributes();
|
|
if (attributes != null) {
|
|
return attributes.keySet().iterator();
|
|
}
|
|
}
|
|
catch (XMPPException xe) { }
|
|
return Collections.EMPTY_LIST.iterator();
|
|
}
|
|
|
|
/**
|
|
* Returns the instructions for creating a new account, or <tt>null</tt> if there
|
|
* are no instructions. If present, instructions should be displayed to the end-user
|
|
* that will complete the registration process.
|
|
*
|
|
* @return the account creation instructions, or <tt>null</tt> if there are none.
|
|
*/
|
|
public String getAccountInstructions() {
|
|
try {
|
|
if (info == null) {
|
|
getRegistrationInfo();
|
|
}
|
|
return info.getInstructions();
|
|
}
|
|
catch (XMPPException xe) {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Creates a new account using the specified username and password. The server may
|
|
* require a number of extra account attributes such as an email address and phone
|
|
* number. In that case, Smack will attempt to automatically set all required
|
|
* attributes with blank values, which may or may not be accepted by the server.
|
|
* Therefore, it's recommended to check the required account attributes and to let
|
|
* the end-user populate them with real values instead.
|
|
*
|
|
* @param username the username.
|
|
* @param password the password.
|
|
* @throws XMPPException if an error occurs creating the account.
|
|
*/
|
|
public void createAccount(String username, String password) throws XMPPException {
|
|
if (!supportsAccountCreation()) {
|
|
throw new XMPPException("Server does not support account creation.");
|
|
}
|
|
// Create a map for all the required attributes, but give them blank values.
|
|
Map attributes = new HashMap();
|
|
for (Iterator i=getAccountAttributes(); i.hasNext(); ) {
|
|
String attributeName = (String)i.next();
|
|
attributes.put(attributeName, "");
|
|
}
|
|
createAccount(username, password, attributes);
|
|
}
|
|
|
|
/**
|
|
* Creates a new account using the specified username, password and account attributes.
|
|
* The attributes Map must contain only String name/value pairs and must also have values
|
|
* for all required attributes.
|
|
*
|
|
* @param username the username.
|
|
* @param password the password.
|
|
* @param attributes the account attributes.
|
|
* @throws XMPPException if an error occurs creating the account.
|
|
* @see #getAccountAttributes()
|
|
*/
|
|
public void createAccount(String username, String password, Map attributes)
|
|
throws XMPPException
|
|
{
|
|
if (!supportsAccountCreation()) {
|
|
throw new XMPPException("Server does not support account creation.");
|
|
}
|
|
Registration reg = new Registration();
|
|
reg.setType(IQ.Type.SET);
|
|
reg.setTo(connection.getHost());
|
|
reg.setUsername(username);
|
|
reg.setPassword(password);
|
|
reg.setAttributes(attributes);
|
|
PacketFilter filter = new AndFilter(new PacketIDFilter(reg.getPacketID()),
|
|
new PacketTypeFilter(IQ.class));
|
|
PacketCollector collector = connection.createPacketCollector(filter);
|
|
connection.sendPacket(reg);
|
|
IQ result = (IQ)collector.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
|
if (result == null) {
|
|
throw new XMPPException("No response from server.");
|
|
}
|
|
else if (result.getType() == IQ.Type.ERROR) {
|
|
throw new XMPPException(result.getError());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Changes the password of the currently logged-in account. This operation can only
|
|
* be performed after a successful login operation has been completed. Not all servers
|
|
* support changing passwords; an XMPPException will be thrown when that is the case.
|
|
*
|
|
* @throws IllegalStateException if not currently logged-in to the server.
|
|
* @throws XMPPException if an error occurs when changing the password.
|
|
*/
|
|
public void changePassword(String newPassword) throws XMPPException {
|
|
Registration reg = new Registration();
|
|
reg.setType(IQ.Type.SET);
|
|
reg.setTo(connection.getHost());
|
|
reg.setUsername(StringUtils.parseName(connection.getUser()));
|
|
reg.setPassword(newPassword);
|
|
PacketFilter filter = new AndFilter(new PacketIDFilter(reg.getPacketID()),
|
|
new PacketTypeFilter(IQ.class));
|
|
PacketCollector collector = connection.createPacketCollector(filter);
|
|
connection.sendPacket(reg);
|
|
IQ result = (IQ)collector.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
|
if (result == null) {
|
|
throw new XMPPException("No response from server.");
|
|
}
|
|
else if (result.getType() == IQ.Type.ERROR) {
|
|
throw new XMPPException(result.getError());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deletes the currently logged-in account from the server. This operation can only
|
|
* be performed after a successful login operation has been completed. Not all servers
|
|
* support deleting accounts; an XMPPException will be thrown when that is the case.
|
|
*
|
|
* @throws IllegalStateException if not currently logged-in to the server.
|
|
* @throws XMPPException if an error occurs when deleting the account.
|
|
*/
|
|
public void deleteAccount() throws XMPPException {
|
|
if (!connection.isAuthenticated()) {
|
|
throw new IllegalStateException("Must be logged in to delete a account.");
|
|
}
|
|
Registration reg = new Registration();
|
|
reg.setType(IQ.Type.SET);
|
|
reg.setTo(connection.getHost());
|
|
Map attributes = new HashMap();
|
|
// To delete an account, we add a single attribute, "remove", that is blank.
|
|
attributes.put("remove", "");
|
|
reg.setAttributes(attributes);
|
|
PacketFilter filter = new AndFilter(new PacketIDFilter(reg.getPacketID()),
|
|
new PacketTypeFilter(IQ.class));
|
|
PacketCollector collector = connection.createPacketCollector(filter);
|
|
connection.sendPacket(reg);
|
|
IQ result = (IQ)collector.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
|
if (result == null) {
|
|
throw new XMPPException("No response from server.");
|
|
}
|
|
else if (result.getType() == IQ.Type.ERROR) {
|
|
throw new XMPPException(result.getError());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the account registration info from the server.
|
|
*
|
|
* @throws XMPPException if an error occurs.
|
|
*/
|
|
private synchronized void getRegistrationInfo() throws XMPPException {
|
|
Registration reg = new Registration();
|
|
reg.setTo(connection.getHost());
|
|
PacketFilter filter = new AndFilter(new PacketIDFilter(reg.getPacketID()),
|
|
new PacketTypeFilter(IQ.class));
|
|
PacketCollector collector = connection.createPacketCollector(filter);
|
|
connection.sendPacket(reg);
|
|
IQ result = (IQ)collector.nextResult(SmackConfiguration.getPacketReplyTimeout());
|
|
if (result == null) {
|
|
throw new XMPPException("No response from server.");
|
|
}
|
|
else if (result.getType() == IQ.Type.ERROR) {
|
|
throw new XMPPException(result.getError());
|
|
}
|
|
else {
|
|
info = (Registration)result;
|
|
}
|
|
}
|
|
} |