/**
* $RCSfile$
* $Revision: 7071 $
* $Date: 2007-02-11 18:59:05 -0600 (Sun, 11 Feb 2007) $
*
* Copyright 2003-2007 Jive Software.
*
* All rights reserved. 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.smackx.packet;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.TimeZone;
import org.jivesoftware.smack.packet.PacketExtension;
/**
* Represents extended presence information whose sole purpose is to signal the
* ability of the occupant to speak the MUC protocol when joining a room. If the
* room requires a password then the MUCInitialPresence should include one.
* <p>
*
* The amount of discussion history provided on entering a room (perhaps because
* the user is on a low-bandwidth connection or is using a small-footprint
* client) could be managed by setting a configured History instance to the
* MUCInitialPresence instance.
*
* @see MUCInitialPresence#setHistory(MUCInitialPresence.History).
*
* @author Gaston Dombiak
*/
public class MUCInitialPresence implements PacketExtension {
/**
* The History class controls the number of characters or messages to
* receive when entering a room.
*
* @author Gaston Dombiak
*/
public static class History {
private int maxChars = -1;
private int maxStanzas = -1;
private int seconds = -1;
private Date since;
/**
* Returns the total number of characters to receive in the history.
*
* @return total number of characters to receive in the history.
*/
public int getMaxChars() {
return maxChars;
}
/**
* Returns the total number of messages to receive in the history.
*
* @return the total number of messages to receive in the history.
*/
public int getMaxStanzas() {
return maxStanzas;
}
/**
* Returns the number of seconds to use to filter the messages received
* during that time. In other words, only the messages received in the
* last "X" seconds will be included in the history.
*
* @return the number of seconds to use to filter the messages received
* during that time.
*/
public int getSeconds() {
return seconds;
}
/**
* Returns the since date to use to filter the messages received during
* that time. In other words, only the messages received since the
* datetime specified will be included in the history.
*
* @return the since date to use to filter the messages received during
* that time.
*/
public Date getSince() {
return since;
}
/**
* Sets the total number of characters to receive in the history.
*
* @param maxChars
* the total number of characters to receive in the history.
*/
public void setMaxChars(int maxChars) {
this.maxChars = maxChars;
}
/**
* Sets the total number of messages to receive in the history.
*
* @param maxStanzas
* the total number of messages to receive in the history.
*/
public void setMaxStanzas(int maxStanzas) {
this.maxStanzas = maxStanzas;
}
/**
* Sets the number of seconds to use to filter the messages received
* during that time. In other words, only the messages received in the
* last "X" seconds will be included in the history.
*
* @param seconds
* the number of seconds to use to filter the messages
* received during that time.
*/
public void setSeconds(int seconds) {
this.seconds = seconds;
}
/**
* Sets the since date to use to filter the messages received during
* that time. In other words, only the messages received since the
* datetime specified will be included in the history.
*
* @param since
* the since date to use to filter the messages received
* during that time.
*/
public void setSince(Date since) {
this.since = since;
}
public String toXML() {
final StringBuilder buf = new StringBuilder();
buf.append("<history");
if (getMaxChars() != -1) {
buf.append(" maxchars=\"").append(getMaxChars()).append("\"");
}
if (getMaxStanzas() != -1) {
buf.append(" maxstanzas=\"").append(getMaxStanzas())
.append("\"");
}
if (getSeconds() != -1) {
buf.append(" seconds=\"").append(getSeconds()).append("\"");
}
if (getSince() != null) {
final SimpleDateFormat utcFormat = new SimpleDateFormat(
"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
utcFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
buf.append(" since=\"").append(utcFormat.format(getSince()))
.append("\"");
}
buf.append("/>");
return buf.toString();
}
}
private String password;
private History history;
@Override
public String getElementName() {
return "x";
}
/**
* Returns the history that manages the amount of discussion history
* provided on entering a room.
*
* @return the history that manages the amount of discussion history
* provided on entering a room.
*/
public History getHistory() {
return history;
}
@Override
public String getNamespace() {
return "http://jabber.org/protocol/muc";
}
/**
* Returns the password to use when the room requires a password.
*
* @return the password to use when the room requires a password.
*/
public String getPassword() {
return password;
}
/**
* Sets the History that manages the amount of discussion history provided
* on entering a room.
*
* @param history
* that manages the amount of discussion history provided on
* entering a room.
*/
public void setHistory(History history) {
this.history = history;
}
/**
* Sets the password to use when the room requires a password.
*
* @param password
* the password to use when the room requires a password.
*/
public void setPassword(String password) {
this.password = password;
}
@Override
public String toXML() {
final StringBuilder buf = new StringBuilder();
buf.append("<").append(getElementName()).append(" xmlns=\"")
.append(getNamespace()).append("\">");
if (getPassword() != null) {
buf.append("<password>").append(getPassword())
.append("</password>");
}
if (getHistory() != null) {
buf.append(getHistory().toXML());
}
buf.append("</").append(getElementName()).append(">");
return buf.toString();
}
}