DiscoverInfo.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.smackx.disco.packet;
- import java.util.ArrayList;
- import java.util.Collections;
- import java.util.HashSet;
- import java.util.LinkedList;
- import java.util.List;
- import java.util.Set;
- import org.jivesoftware.smack.XMPPConnection;
- import org.jivesoftware.smack.packet.IQ;
- import org.jivesoftware.smack.packet.IqData;
- import org.jivesoftware.smack.util.EqualsUtil;
- import org.jivesoftware.smack.util.HashCode;
- import org.jivesoftware.smack.util.StringUtils;
- import org.jivesoftware.smack.util.XmlStringBuilder;
- import org.jxmpp.util.XmppStringUtils;
- /**
- * A DiscoverInfo IQ packet, which is used by XMPP clients to request and receive information
- * to/from other XMPP entities.<p>
- *
- * The received information may contain one or more identities of the requested XMPP entity, and
- * a list of supported features by the requested XMPP entity.
- *
- * @author Gaston Dombiak
- */
- public class DiscoverInfo extends IQ implements DiscoverInfoView {
- public static final String ELEMENT = QUERY_ELEMENT;
- public static final String NAMESPACE = "http://jabber.org/protocol/disco#info";
- private final List<Feature> features = new ArrayList<>();
- private final Set<Feature> featuresSet = new HashSet<>();
- private final List<Identity> identities = new ArrayList<>();
- private final Set<String> identitiesSet = new HashSet<>();
- private String node;
- private boolean containsDuplicateFeatures;
- DiscoverInfo(DiscoverInfoBuilder builder, boolean validate) {
- super(builder, ELEMENT, NAMESPACE);
- features.addAll(builder.getFeatures());
- identities.addAll(builder.getIdentities());
- node = builder.getNode();
- for (Feature feature : features) {
- boolean featureIsNew = featuresSet.add(feature);
- if (!featureIsNew) {
- containsDuplicateFeatures = true;
- }
- }
- for (Identity identity : identities) {
- identitiesSet.add(identity.getKey());
- }
- if (!validate) {
- return;
- }
- if (containsDuplicateFeatures) {
- throw new IllegalArgumentException("The disco#info request contains duplicate features.");
- }
- }
- /**
- * Copy constructor.
- *
- * @param d TODO javadoc me please
- */
- public DiscoverInfo(DiscoverInfo d) {
- super(d);
- // Set node
- node = d.getNode();
- // Copy features
- features.addAll(d.features);
- featuresSet.addAll(d.featuresSet);
- // Copy identities
- identities.addAll(d.identities);
- identitiesSet.addAll(d.identitiesSet);
- }
- @Override
- public List<Feature> getFeatures() {
- return Collections.unmodifiableList(features);
- }
- @Override
- public List<Identity> getIdentities() {
- return Collections.unmodifiableList(identities);
- }
- /**
- * Returns true if this DiscoverInfo contains at least one Identity of the given category and type.
- *
- * @param category the category to look for.
- * @param type the type to look for.
- * @return true if this DiscoverInfo contains a Identity of the given category and type.
- */
- public boolean hasIdentity(String category, String type) {
- String key = XmppStringUtils.generateKey(category, type);
- return identitiesSet.contains(key);
- }
- /**
- * Returns all Identities of the given category and type of this DiscoverInfo.
- *
- * @param category category the category to look for.
- * @param type type the type to look for.
- * @return a list of Identities with the given category and type.
- */
- public List<Identity> getIdentities(String category, String type) {
- List<Identity> res = new ArrayList<>(identities.size());
- for (Identity identity : identities) {
- if (identity.getCategory().equals(category) && identity.getType().equals(type)) {
- res.add(identity);
- }
- }
- return res;
- }
- @Override
- public String getNode() {
- return node;
- }
- /**
- * Returns true if the specified feature is part of the discovered information.
- *
- * @param feature the feature to check
- * @return true if the requests feature has been discovered
- */
- public boolean containsFeature(CharSequence feature) {
- return features.contains(new Feature(feature));
- }
- public static boolean nullSafeContainsFeature(DiscoverInfo discoverInfo, CharSequence feature) {
- if (discoverInfo == null) {
- return false;
- }
- return discoverInfo.containsFeature(feature);
- }
- @Override
- protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
- xml.optAttribute("node", getNode());
- xml.rightAngleBracket();
- for (Identity identity : identities) {
- xml.append(identity.toXML());
- }
- for (Feature feature : features) {
- xml.append(feature.toXML());
- }
- return xml;
- }
- /**
- * Test if a DiscoverInfo response contains duplicate identities.
- *
- * @return true if duplicate identities where found, otherwise false
- */
- public boolean containsDuplicateIdentities() {
- List<Identity> checkedIdentities = new LinkedList<>();
- for (Identity i : identities) {
- for (Identity i2 : checkedIdentities) {
- if (i.equals(i2))
- return true;
- }
- checkedIdentities.add(i);
- }
- return false;
- }
- /**
- * Test if a DiscoverInfo response contains duplicate features.
- *
- * @return true if duplicate identities where found, otherwise false
- */
- public boolean containsDuplicateFeatures() {
- return containsDuplicateFeatures;
- }
- public DiscoverInfoBuilder asBuilder(String stanzaId) {
- return new DiscoverInfoBuilder(this, stanzaId);
- }
- public static DiscoverInfoBuilder builder(XMPPConnection connection) {
- return new DiscoverInfoBuilder(connection);
- }
- public static DiscoverInfoBuilder builder(IqData iqData) {
- return new DiscoverInfoBuilder(iqData);
- }
- public static DiscoverInfoBuilder builder(String stanzaId) {
- return new DiscoverInfoBuilder(stanzaId);
- }
- /**
- * Represents the identity of a given XMPP entity. An entity may have many identities but all
- * the identities SHOULD have the same name.<p>
- *
- * Refer to <a href="https://xmpp.org/registrar/disco-categories.html">XMPP Registry for Service Discovery Identities</a>
- * in order to get the official registry of values for the <i>category</i> and <i>type</i>
- * attributes.
- *
- */
- public static final class Identity implements Comparable<Identity> {
- private final String category;
- private final String type;
- private final String key;
- private final String name;
- private final String lang; // 'xml:lang;
- /**
- * Creates a new identity for an XMPP entity.
- *
- * @param category the entity's category (required as per XEP-30).
- * @param type the entity's type (required as per XEP-30).
- */
- public Identity(String category, String type) {
- this(category, type, null, null);
- }
- /**
- * Creates a new identity for an XMPP entity.
- * 'category' and 'type' are required by
- * <a href="http://xmpp.org/extensions/xep-0030.html#schemas">XEP-30 XML Schemas</a>
- *
- * @param category the entity's category (required as per XEP-30).
- * @param name the entity's name.
- * @param type the entity's type (required as per XEP-30).
- */
- public Identity(String category, String name, String type) {
- this(category, type, name, null);
- }
- /**
- * Creates a new identity for an XMPP entity.
- * 'category' and 'type' are required by
- * <a href="http://xmpp.org/extensions/xep-0030.html#schemas">XEP-30 XML Schemas</a>
- *
- * @param category the entity's category (required as per XEP-30).
- * @param type the entity's type (required as per XEP-30).
- * @param name the entity's name.
- * @param lang the entity's lang.
- */
- public Identity(String category, String type, String name, String lang) {
- this.category = StringUtils.requireNotNullNorEmpty(category, "category cannot be null");
- this.type = StringUtils.requireNotNullNorEmpty(type, "type cannot be null");
- this.key = XmppStringUtils.generateKey(category, type);
- this.name = name;
- this.lang = lang;
- }
- /**
- * Returns the entity's category. To get the official registry of values for the
- * 'category' attribute refer to <a href="https://xmpp.org/registrar/disco-categories.html">XMPP Registry for Service Discovery Identities</a>.
- *
- * @return the entity's category.
- */
- public String getCategory() {
- return category;
- }
- /**
- * Returns the identity's name.
- *
- * @return the identity's name.
- */
- public String getName() {
- return name;
- }
- /**
- * Returns the entity's type. To get the official registry of values for the
- * 'type' attribute refer to <a href="https://xmpp.org/registrar/disco-categories.html">XMPP Registry for Service Discovery Identities</a>.
- *
- * @return the entity's type.
- */
- public String getType() {
- return type;
- }
- /**
- * Returns the identities natural language if one is set.
- *
- * @return the value of xml:lang of this Identity
- */
- public String getLanguage() {
- return lang;
- }
- private String getKey() {
- return key;
- }
- /**
- * Returns true if this identity is of the given category and type.
- *
- * @param category the category.
- * @param type the type.
- * @return true if this identity is of the given category and type.
- */
- public boolean isOfCategoryAndType(String category, String type) {
- return this.category.equals(category) && this.type.equals(type);
- }
- public XmlStringBuilder toXML() {
- XmlStringBuilder xml = new XmlStringBuilder();
- xml.halfOpenElement("identity");
- xml.xmllangAttribute(lang);
- xml.attribute("category", category);
- xml.optAttribute("name", name);
- xml.optAttribute("type", type);
- xml.closeEmptyElement();
- return xml;
- }
- /**
- * Check equality for Identity for category, type, lang and name
- * in that order as defined by
- * <a href="http://xmpp.org/extensions/xep-0115.html#ver-proc">XEP-0015 5.4 Processing Method (Step 3.3)</a>.
- *
- */
- @Override
- public boolean equals(Object obj) {
- return EqualsUtil.equals(this, obj, (e, o) -> {
- e.append(key, o.key)
- .append(lang, o.lang)
- .append(name, o.name);
- });
- }
- private final HashCode.Cache hashCodeCache = new HashCode.Cache();
- @Override
- public int hashCode() {
- return hashCodeCache.getHashCode(c ->
- c.append(key)
- .append(lang)
- .append(name)
- );
- }
- /**
- * Compares this identity with another one. The comparison order is: Category, Type, Lang.
- * If all three are identical the other Identity is considered equal. Name is not used for
- * comparison, as defined by XEP-0115
- *
- * @param other TODO javadoc me please
- * @return a negative integer, zero, or a positive integer as this object is less than,
- * equal to, or greater than the specified object.
- */
- @Override
- public int compareTo(DiscoverInfo.Identity other) {
- String otherLang = other.lang == null ? "" : other.lang;
- String thisLang = lang == null ? "" : lang;
- // This can be removed once the deprecated constructor is removed.
- String otherType = other.type == null ? "" : other.type;
- String thisType = type == null ? "" : type;
- if (category.equals(other.category)) {
- if (thisType.equals(otherType)) {
- if (thisLang.equals(otherLang)) {
- // Don't compare on name, XEP-30 says that name SHOULD
- // be equals for all identities of an entity
- return 0;
- } else {
- return thisLang.compareTo(otherLang);
- }
- } else {
- return thisType.compareTo(otherType);
- }
- } else {
- return category.compareTo(other.category);
- }
- }
- @Override
- public String toString() {
- return toXML().toString();
- }
- }
- /**
- * Represents the features offered by the item. This information helps the requester to determine
- * what actions are possible with regard to this item (registration, search, join, etc.)
- * as well as specific feature types of interest, if any (e.g., for the purpose of feature
- * negotiation).
- */
- public static final class Feature {
- private final String variable;
- public Feature(Feature feature) {
- this.variable = feature.variable;
- }
- public Feature(CharSequence variable) {
- this(variable.toString());
- }
- /**
- * Creates a new feature offered by an XMPP entity or item.
- *
- * @param variable the feature's variable.
- */
- public Feature(String variable) {
- this.variable = StringUtils.requireNotNullNorEmpty(variable, "variable cannot be null");
- }
- /**
- * Returns the feature's variable.
- *
- * @return the feature's variable.
- */
- public String getVar() {
- return variable;
- }
- public XmlStringBuilder toXML() {
- XmlStringBuilder xml = new XmlStringBuilder();
- xml.halfOpenElement("feature");
- xml.attribute("var", variable);
- xml.closeEmptyElement();
- return xml;
- }
- @Override
- public boolean equals(Object obj) {
- return EqualsUtil.equals(this, obj, (e, o) -> {
- e.append(variable, o.variable);
- });
- }
- @Override
- public int hashCode() {
- return variable.hashCode();
- }
- @Override
- public String toString() {
- return toXML().toString();
- }
- }
- }