1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $RCSfile$ 3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Revision$ 4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Date$ 5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2003-2007 Jive Software. 7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); 9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License. 10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at 11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * http://www.apache.org/licenses/LICENSE-2.0 13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software 15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS, 16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and 18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License. 19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage org.jivesoftware.smack.packet; 22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.ArrayList; 24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.HashMap; 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.List; 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Map; 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Represents registration packets. An empty GET query will cause the server to return information 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * about it's registration support. SET queries can be used to create accounts or update 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * existing account information. XMPP servers may require a number of attributes to be set 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * when creating a new account. The standard account attributes are as follows: 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <ul> 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>name -- the user's name. 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>first -- the user's first name. 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>last -- the user's last name. 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>email -- the user's email address. 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>city -- the user's city. 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>state -- the user's state. 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>zip -- the user's ZIP code. 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>phone -- the user's phone number. 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>url -- the user's website. 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>date -- the date the registration took place. 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>misc -- other miscellaneous information to associate with the account. 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>text -- textual information to associate with the account. 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <li>remove -- empty flag to remove account. 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * </ul> 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Matt Tucker 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic class Registration extends IQ { 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private String instructions = null; 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private Map<String, String> attributes = new HashMap<String,String>(); 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private List<String> requiredFields = new ArrayList<String>(); 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private boolean registered = false; 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private boolean remove = false; 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the registration instructions, or <tt>null</tt> if no instructions 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * have been set. If present, instructions should be displayed to the end-user 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * that will complete the registration process. 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the registration instructions, or <tt>null</tt> if there are none. 65d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 66d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getInstructions() { 67d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return instructions; 68d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 69d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 70d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 71d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the registration instructions. 72d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 73d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param instructions the registration instructions. 74d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 75d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setInstructions(String instructions) { 76d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.instructions = instructions; 77d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 78d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 79d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 80d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the map of String key/value pairs of account attributes. 81d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 82d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the account attributes. 83d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 84d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Map<String, String> getAttributes() { 85d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return attributes; 86d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 87d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 88d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 89d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the account attributes. The map must only contain String key/value pairs. 90d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 91d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param attributes the account attributes. 92d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 93d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setAttributes(Map<String, String> attributes) { 94d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.attributes = attributes; 95d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 96d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 97d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public List<String> getRequiredFields(){ 98d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return requiredFields; 99d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 100d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 101d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void addAttribute(String key, String value){ 102d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen attributes.put(key, value); 103d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 104d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 105d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setRegistered(boolean registered){ 106d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.registered = registered; 107d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 108d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 109d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public boolean isRegistered(){ 110d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.registered; 111d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 112d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 113d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getField(String key){ 114d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return attributes.get(key); 115d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 116d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 117d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public List<String> getFieldNames(){ 118d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return new ArrayList<String>(attributes.keySet()); 119d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 120d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 121d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setUsername(String username){ 122d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen attributes.put("username", username); 123d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 124d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 125d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setPassword(String password){ 126d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen attributes.put("password", password); 127d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 128d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 129d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setRemove(boolean remove){ 130d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.remove = remove; 131d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 132d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 133d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getChildElementXML() { 134d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen StringBuilder buf = new StringBuilder(); 135d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<query xmlns=\"jabber:iq:register\">"); 136d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (instructions != null && !remove) { 137d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<instructions>").append(instructions).append("</instructions>"); 138d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 139d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (attributes != null && attributes.size() > 0 && !remove) { 140d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen for (String name : attributes.keySet()) { 141d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen String value = attributes.get(name); 142d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<").append(name).append(">"); 143d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append(value); 144d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("</").append(name).append(">"); 145d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 146d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 147d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen else if(remove){ 148d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("</remove>"); 149d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 150d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Add packet extensions, if any are defined. 151d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append(getExtensionsXML()); 152d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("</query>"); 153d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return buf.toString(); 154d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 155d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen}