288 lines
12 KiB
Java
288 lines
12 KiB
Java
/**
|
|
*
|
|
* Copyright 2003-2007 Jive Software.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package org.jivesoftware.smack;
|
|
|
|
import java.util.Collection;
|
|
import java.util.Collections;
|
|
import java.util.HashMap;
|
|
import java.util.Map;
|
|
import java.util.WeakHashMap;
|
|
|
|
import org.jivesoftware.smack.SmackException.NoResponseException;
|
|
import org.jivesoftware.smack.SmackException.NotConnectedException;
|
|
import org.jivesoftware.smack.XMPPException.XMPPErrorException;
|
|
import org.jivesoftware.smack.packet.IQ;
|
|
import org.jivesoftware.smack.packet.Registration;
|
|
import org.jivesoftware.smack.util.StringUtils;
|
|
|
|
/**
|
|
* Allows creation and management of accounts on an XMPP server.
|
|
*
|
|
* @author Matt Tucker
|
|
*/
|
|
public class AccountManager extends Manager {
|
|
private static final Map<XMPPConnection, AccountManager> INSTANCES = new WeakHashMap<XMPPConnection, AccountManager>();
|
|
|
|
/**
|
|
* Returns the AccountManager instance associated with a given XMPPConnection.
|
|
*
|
|
* @param connection the connection used to look for the proper ServiceDiscoveryManager.
|
|
* @return the AccountManager associated with a given XMPPConnection.
|
|
*/
|
|
public static synchronized AccountManager getInstance(XMPPConnection connection) {
|
|
AccountManager accountManager = INSTANCES.get(connection);
|
|
if (accountManager == null)
|
|
accountManager = new AccountManager(connection);
|
|
return accountManager;
|
|
}
|
|
|
|
private Registration info = null;
|
|
|
|
/**
|
|
* Flag that indicates whether the server supports In-Band Registration.
|
|
* In-Band Registration may be advertised as a stream feature. If no stream feature
|
|
* was advertised from the server then try sending an IQ packet to discover if In-Band
|
|
* Registration is available.
|
|
*/
|
|
private boolean accountCreationSupported = false;
|
|
|
|
/**
|
|
* Creates a new AccountManager instance.
|
|
*
|
|
* @param connection a connection to a XMPP server.
|
|
*/
|
|
private AccountManager(XMPPConnection connection) {
|
|
super(connection);
|
|
INSTANCES.put(connection, this);
|
|
}
|
|
|
|
/**
|
|
* Sets whether the server supports In-Band Registration. In-Band Registration may be
|
|
* advertised as a stream feature. If no stream feature was advertised from the server
|
|
* then try sending an IQ packet to discover if In-Band Registration is available.
|
|
*
|
|
* @param accountCreationSupported true if the server supports In-Band Registration.
|
|
*/
|
|
void setSupportsAccountCreation(boolean accountCreationSupported) {
|
|
this.accountCreationSupported = accountCreationSupported;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
* @throws XMPPErrorException
|
|
* @throws NoResponseException
|
|
* @throws NotConnectedException
|
|
*/
|
|
public boolean supportsAccountCreation() throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
// Check if we already know that the server supports creating new accounts
|
|
if (accountCreationSupported) {
|
|
return true;
|
|
}
|
|
// No information is known yet (e.g. no stream feature was received from the server
|
|
// indicating that it supports creating new accounts) so send an IQ packet as a way
|
|
// to discover if this feature is supported
|
|
if (info == null) {
|
|
getRegistrationInfo();
|
|
accountCreationSupported = info.getType() != IQ.Type.ERROR;
|
|
}
|
|
return accountCreationSupported;
|
|
}
|
|
|
|
/**
|
|
* Returns an unmodifiable collection of the names of the required account attributes.
|
|
* All attributes must be set when creating new accounts. The standard set of possible
|
|
* 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.
|
|
* @throws XMPPErrorException
|
|
* @throws NoResponseException
|
|
* @throws NotConnectedException
|
|
*/
|
|
public Collection<String> getAccountAttributes() throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
if (info == null) {
|
|
getRegistrationInfo();
|
|
}
|
|
Map<String, String> attributes = info.getAttributes();
|
|
if (attributes != null) {
|
|
return Collections.unmodifiableSet(attributes.keySet());
|
|
} else {
|
|
return Collections.emptySet();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the value of a given account attribute or <tt>null</tt> if the account
|
|
* attribute wasn't found.
|
|
*
|
|
* @param name the name of the account attribute to return its value.
|
|
* @return the value of the account attribute or <tt>null</tt> if an account
|
|
* attribute wasn't found for the requested name.
|
|
* @throws XMPPErrorException
|
|
* @throws NoResponseException
|
|
* @throws NotConnectedException
|
|
*/
|
|
public String getAccountAttribute(String name) throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
if (info == null) {
|
|
getRegistrationInfo();
|
|
}
|
|
return info.getAttributes().get(name);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
* @throws XMPPErrorException
|
|
* @throws NoResponseException
|
|
* @throws NotConnectedException
|
|
*/
|
|
public String getAccountInstructions() throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
if (info == null) {
|
|
getRegistrationInfo();
|
|
}
|
|
return info.getInstructions();
|
|
}
|
|
|
|
/**
|
|
* 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 XMPPErrorException
|
|
* @throws NoResponseException
|
|
* @throws NotConnectedException
|
|
*/
|
|
public void createAccount(String username, String password) throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
// Create a map for all the required attributes, but give them blank values.
|
|
Map<String, String> attributes = new HashMap<String, String>();
|
|
for (String attributeName : getAccountAttributes()) {
|
|
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 XMPPErrorException if an error occurs creating the account.
|
|
* @throws NoResponseException if there was no response from the server.
|
|
* @throws NotConnectedException
|
|
* @see #getAccountAttributes()
|
|
*/
|
|
public void createAccount(String username, String password, Map<String, String> attributes)
|
|
throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
Registration reg = new Registration();
|
|
reg.setType(IQ.Type.SET);
|
|
reg.setTo(connection().getServiceName());
|
|
attributes.put("username", username);
|
|
attributes.put("password", password);
|
|
reg.setAttributes(attributes);
|
|
connection().createPacketCollectorAndSend(reg).nextResultOrThrow();
|
|
}
|
|
|
|
/**
|
|
* 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 XMPPErrorException if an error occurs when changing the password.
|
|
* @throws NoResponseException if there was no response from the server.
|
|
* @throws NotConnectedException
|
|
*/
|
|
public void changePassword(String newPassword) throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
Registration reg = new Registration();
|
|
reg.setType(IQ.Type.SET);
|
|
reg.setTo(connection().getServiceName());
|
|
Map<String, String> map = new HashMap<String, String>();
|
|
map.put("username",StringUtils.parseName(connection().getUser()));
|
|
map.put("password",newPassword);
|
|
reg.setAttributes(map);
|
|
connection().createPacketCollectorAndSend(reg).nextResultOrThrow();
|
|
}
|
|
|
|
/**
|
|
* 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 XMPPErrorException if an error occurs when deleting the account.
|
|
* @throws NoResponseException if there was no response from the server.
|
|
* @throws NotConnectedException
|
|
*/
|
|
public void deleteAccount() throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
Registration reg = new Registration();
|
|
reg.setType(IQ.Type.SET);
|
|
reg.setTo(connection().getServiceName());
|
|
Map<String, String> attributes = new HashMap<String, String>();
|
|
// To delete an account, we add a single attribute, "remove", that is blank.
|
|
attributes.put("remove", "");
|
|
reg.setAttributes(attributes);
|
|
connection().createPacketCollectorAndSend(reg).nextResultOrThrow();
|
|
}
|
|
|
|
/**
|
|
* Gets the account registration info from the server.
|
|
* @throws XMPPErrorException
|
|
* @throws NoResponseException
|
|
* @throws NotConnectedException
|
|
*
|
|
* @throws XMPPException if an error occurs.
|
|
* @throws SmackException if there was no response from the server.
|
|
*/
|
|
private synchronized void getRegistrationInfo() throws NoResponseException, XMPPErrorException, NotConnectedException {
|
|
Registration reg = new Registration();
|
|
reg.setTo(connection().getServiceName());
|
|
info = (Registration) connection().createPacketCollectorAndSend(reg).nextResultOrThrow();
|
|
}
|
|
}
|