001/**
002 *
003 * Copyright 2018 Paul Schaub.
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.ox_im;
018
019import org.jivesoftware.smack.packet.Message;
020
021import org.jivesoftware.smackx.ox.OpenPgpContact;
022import org.jivesoftware.smackx.ox.element.OpenPgpElement;
023import org.jivesoftware.smackx.ox.element.SigncryptElement;
024
025import org.pgpainless.decryption_verification.OpenPgpMetadata;
026
027public interface OxMessageListener {
028
029    /**
030     * This method gets invoked, whenever an OX-IM encrypted message gets received.
031     *
032     * @see <a href="https://xmpp.org/extensions/xep-0374.html">
033     *     XEP-0374: OpenPGP for XMPP: Instant Messaging (OX-IM)</a>
034     *@param contact {@link OpenPgpContact} which sent the message.
035     * @param originalMessage the received message that is carrying the encrypted {@link OpenPgpElement}.
036     * @param decryptedPayload decrypted {@link SigncryptElement} which is carrying the payload.
037     * @param metadata metadata about the encryption and signing
038     */
039    void newIncomingOxMessage(OpenPgpContact contact,
040                              Message originalMessage,
041                              SigncryptElement decryptedPayload,
042                              OpenPgpMetadata metadata);
043}