001/**
002 *
003 * Copyright 2003-2007 Jive Software.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.jivesoftware.smack.packet;
019
020import org.jivesoftware.smack.util.XmlStringBuilder;
021
022/**
023 * IQ stanza(/packet) that will be sent to the server to establish a session.<p>
024 *
025 * If a server supports sessions, it MUST include a <i>session</i> element in the
026 * stream features it advertises to a client after the completion of stream authentication.
027 * Upon being informed that session establishment is required by the server the client MUST
028 * establish a session if it desires to engage in instant messaging and presence functionality.<p>
029 *
030 * For more information refer to the following
031 * <a href=http://www.xmpp.org/specs/rfc3921.html#session>link</a>.
032 *
033 * @author Gaston Dombiak
034 */
035public class Session extends SimpleIQ {
036
037    public static final String ELEMENT = "session";
038    public static final String NAMESPACE = "urn:ietf:params:xml:ns:xmpp-session";
039
040    public Session() {
041        super(ELEMENT, NAMESPACE);
042        setType(IQ.Type.set);
043    }
044
045    public static class Feature implements ExtensionElement {
046
047        public static final String OPTIONAL_ELEMENT = "optional";
048
049        private final boolean optional;
050
051        public Feature(boolean optional) {
052            this.optional = optional;
053        }
054
055        public boolean isOptional() {
056            return optional;
057        }
058
059        @Override
060        public String getElementName() {
061            return ELEMENT;
062        }
063
064        @Override
065        public String getNamespace() {
066            return NAMESPACE;
067        }
068
069        @Override
070        public XmlStringBuilder toXML() {
071            XmlStringBuilder xml = new XmlStringBuilder(this);
072            if (optional) {
073                xml.rightAngleBracket();
074                xml.emptyElement(OPTIONAL_ELEMENT);
075                xml.closeElement(this);
076            } else {
077                xml.closeEmptyElement();
078            }
079            return xml;
080        }
081    }
082}