org.jivesoftware.smackx.json.packet.JsonPacketExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smack-experimental Show documentation

Smack experimental extensions. Classes and methods for XEPs that are in status 'experimental' or that should otherwise carefully considered for deployment. The API may change even between patch versions.

There is a newer version: 4.5.0-beta5

Show newest version

/**
 *
 * Copyright © 2014-2020 Florian Schmaus
 *
 * 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.json.packet;

import javax.xml.namespace.QName;

import org.jivesoftware.smack.packet.Stanza;

/**
 * XMPP JSON Containers as defined in XEP-0335.
 *
 * @see XEP-0335: JSON Containers
 */
public class JsonPacketExtension extends AbstractJsonPacketExtension {

    public static final String ELEMENT = "json";
    public static final String NAMESPACE = "urn:xmpp:json:0";
    public static final QName QNAME = new QName(NAMESPACE, ELEMENT);

    public JsonPacketExtension(String json) {
        super(json);
    }

    @Override
    public String getNamespace() {
        return NAMESPACE;
    }

    @Override
    public String getElementName() {
        return ELEMENT;
    }

    /**
     * Retrieve the JSON stanza extension from the packet.
     *
     * @param packet TODO javadoc me please
     * @return the JSON stanza extension or null.
     */
    public static JsonPacketExtension from(Stanza packet) {
        return packet.getExtension(JsonPacketExtension.class);
    }
}