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.smackx.packet; 22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.packet.IQ; 24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.text.DateFormat; 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.text.SimpleDateFormat; 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Calendar; 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Date; 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.TimeZone; 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * A Time IQ packet, which is used by XMPP clients to exchange their respective local 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * times. Clients that wish to fully support the entitity time protocol should register 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * a PacketListener for incoming time requests that then respond with the local time. 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * This class can be used to request the time from other clients, such as in the 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * following code snippet: 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <pre> 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * // Request the time from a remote user. 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Time timeRequest = new Time(); 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * timeRequest.setType(IQ.Type.GET); 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * timeRequest.setTo(someUser@example.com/resource); 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * // Create a packet collector to listen for a response. 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * PacketCollector collector = con.createPacketCollector( 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * new PacketIDFilter(timeRequest.getPacketID())); 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * con.sendPacket(timeRequest); 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * // Wait up to 5 seconds for a result. 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * IQ result = (IQ)collector.nextResult(5000); 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * if (result != null && result.getType() == IQ.Type.RESULT) { 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Time timeResult = (Time)result; 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * // Do something with result... 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * }</pre><p> 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Warning: this is an non-standard protocol documented by 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <a href="http://www.xmpp.org/extensions/xep-0090.html">XEP-0090</a>. Because this is a 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * non-standard protocol, it is subject to change. 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Matt Tucker 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic class Time extends IQ { 64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 65d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private static SimpleDateFormat utcFormat = new SimpleDateFormat("yyyyMMdd'T'HH:mm:ss"); 66d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private static DateFormat displayFormat = DateFormat.getDateTimeInstance(); 67d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 68d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private String utc = null; 69d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private String tz = null; 70d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private String display = null; 71d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 72d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 73d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Creates a new Time instance with empty values for all fields. 74d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 75d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Time() { 76d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 77d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 78d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 79d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 80d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Creates a new Time instance using the specified calendar instance as 81d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * the time value to send. 82d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 83d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param cal the time value. 84d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 85d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Time(Calendar cal) { 86d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen TimeZone timeZone = cal.getTimeZone(); 87d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen tz = cal.getTimeZone().getID(); 88d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen display = displayFormat.format(cal.getTime()); 89d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Convert local time to the UTC time. 90d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen utc = utcFormat.format(new Date( 91d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen cal.getTimeInMillis() - timeZone.getOffset(cal.getTimeInMillis()))); 92d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 93d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 94d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 95d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the local time or <tt>null</tt> if the time hasn't been set. 96d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 97d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the lcocal time. 98d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 99d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Date getTime() { 100d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (utc == null) { 101d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return null; 102d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 103d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen Date date = null; 104d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen try { 105d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen Calendar cal = Calendar.getInstance(); 106d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Convert the UTC time to local time. 107d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen cal.setTime(new Date(utcFormat.parse(utc).getTime() + 108d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen cal.getTimeZone().getOffset(cal.getTimeInMillis()))); 109d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen date = cal.getTime(); 110d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 111d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen catch (Exception e) { 112d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen e.printStackTrace(); 113d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 114d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return date; 115d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 116d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 117d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 118d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the time using the local time. 119d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 120d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param time the current local time. 121d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 122d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setTime(Date time) { 123d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Convert local time to UTC time. 124d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen utc = utcFormat.format(new Date( 125d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen time.getTime() - TimeZone.getDefault().getOffset(time.getTime()))); 126d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 127d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 128d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 129d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the time as a UTC formatted String using the format CCYYMMDDThh:mm:ss. 130d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 131d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the time as a UTC formatted String. 132d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 133d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getUtc() { 134d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return utc; 135d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 136d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 137d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 138d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the time using UTC formatted String in the format CCYYMMDDThh:mm:ss. 139d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 140d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param utc the time using a formatted String. 141d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 142d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setUtc(String utc) { 143d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.utc = utc; 144d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 145d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 146d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 147d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 148d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the time zone. 149d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 150d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the time zone. 151d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 152d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getTz() { 153d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return tz; 154d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 155d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 156d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 157d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the time zone. 158d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 159d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param tz the time zone. 160d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 161d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setTz(String tz) { 162d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.tz = tz; 163d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 164d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 165d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 166d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the local (non-utc) time in human-friendly format. 167d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 168d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the local time in human-friendly format. 169d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 170d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getDisplay() { 171d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return display; 172d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 173d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 174d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 175d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the local time in human-friendly format. 176d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 177d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param display the local time in human-friendly format. 178d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 179d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setDisplay(String display) { 180d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.display = display; 181d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 182d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 183d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getChildElementXML() { 184d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen StringBuilder buf = new StringBuilder(); 185d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<query xmlns=\"jabber:iq:time\">"); 186d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (utc != null) { 187d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<utc>").append(utc).append("</utc>"); 188d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 189d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (tz != null) { 190d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<tz>").append(tz).append("</tz>"); 191d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 192d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (display != null) { 193d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<display>").append(display).append("</display>"); 194d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 195d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("</query>"); 196d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return buf.toString(); 197d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 198d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen}