001/**
002 *
003 * Copyright 2014 Vyacheslav Blinov
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 */
017package org.jivesoftware.smackx.amp;
018
019import org.jivesoftware.smack.SmackException.NoResponseException;
020import org.jivesoftware.smack.SmackException.NotConnectedException;
021import org.jivesoftware.smack.XMPPConnection;
022import org.jivesoftware.smack.XMPPException.XMPPErrorException;
023
024import org.jivesoftware.smackx.amp.packet.AMPExtension;
025
026public class AMPDeliverCondition implements AMPExtension.Condition {
027
028    public static final String NAME = "deliver";
029
030    /**
031     * Check if server supports deliver condition.
032     * @param connection Smack connection instance
033     * @return true if deliver condition is supported.
034     * @throws XMPPErrorException if there was an XMPP error returned.
035     * @throws NoResponseException if there was no response from the remote entity.
036     * @throws NotConnectedException if the XMPP connection is not connected.
037     * @throws InterruptedException if the calling thread was interrupted.
038     */
039    public static boolean isSupported(XMPPConnection connection) throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
040        return AMPManager.isConditionSupported(connection, NAME);
041    }
042
043    private final Value value;
044
045    /**
046     * Create new amp deliver condition with value set to one of defined by XEP-0079.
047     * See http://xmpp.org/extensions/xep-0079.html#conditions-def-deliver
048     * @param value AMPDeliveryCondition.Value instance that will be used as value parameter. Can't be null.
049     */
050    public AMPDeliverCondition(Value value) {
051        if (value == null)
052            throw new NullPointerException("Can't create AMPDeliverCondition with null value");
053        this.value = value;
054    }
055
056    @Override
057    public String getName() {
058        return NAME;
059    }
060
061    @Override
062    public String getValue() {
063        return value.toString();
064    }
065
066    /**
067     * Value for amp deliver condition as defined by XEP-0079.
068     * See http://xmpp.org/extensions/xep-0079.html#conditions-def-deliver
069     */
070    public enum Value {
071        /**
072         * The message would be immediately delivered to the intended recipient or routed to the next hop.
073         */
074        direct,
075        /**
076         * The message would be forwarded to another XMPP address or account.
077         */
078        forward,
079        /**
080         * The message would be sent through a gateway to an address or account on a non-XMPP system.
081         */
082        gateway,
083        /**
084         * The message would not be delivered at all (e.g., because the intended recipient is offline and message storage is not enabled).
085         */
086        none,
087        /**
088         * The message would be stored offline for later delivery to the intended recipient.
089         */
090        stored
091    }
092}