rocks.xmpp.extensions.caps.model.EntityCapabilities Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmpp-core-common Show documentation

XMPP core functionality (TLS, SASL, resource binding, stanzas, errors) that are common for clients and servers.

There is a newer version: 0.9.1

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 Christian Schudt
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package rocks.xmpp.extensions.caps.model;

import rocks.xmpp.extensions.disco.model.info.InfoNode;
import rocks.xmpp.extensions.hashes.model.Hashed;

import java.util.Set;

/**
 * An interface for different Entity Capabilities implementations as described in the following two specifications.
 * 
 * XEP-0115: Entity Capabilities
 * XEP-0390: Entity Capabilities 2.0
 * 
 *
 * @author Christian Schudt
 */
public interface EntityCapabilities {

    /**
     * Gets the capability hash set.
     *
     * @return The capability hash set.
     */
    Set getCapabilityHashSet();

    /**
     * Creates an UTF-8 encoded verification string from a disco#info query.
     * 
     * The returned byte array is neither hashed nor base64 encoded.
     * It should be used as input for generating the capability hash set.
     *
     * @param infoNode The query.
     * @return The caps string, aka. verification string.
     */
    byte[] createVerificationString(InfoNode infoNode);

    /**
     * Creates the Capability Hash Node.
     * 
     * This node is used to query the generating entity via a Service Discovery Info query (disco#info).
     *
     * @param hashed The pair of hash algorithm and value.
     * @return The node.
     */
    String createCapabilityHashNode(Hashed hashed);
}