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.listener;
018
019import org.jivesoftware.smack.packet.Message;
020import org.jivesoftware.smackx.ox.OpenPgpContact;
021import org.jivesoftware.smackx.ox.element.CryptElement;
022
023import org.pgpainless.decryption_verification.OpenPgpMetadata;
024
025public interface CryptElementReceivedListener {
026
027    /**
028     * A {@link CryptElement} has been received and successfully decrypted.
029     * This listener is intended to be used by implementors of different OX usage profiles.
030     * @param contact sender of the message
031     * @param originalMessage original message which contains the {@link CryptElement}.
032     * @param cryptElement the {@link CryptElement} itself.
033     * @param metadata metadata about the encryption
034     */
035    void cryptElementReceived(OpenPgpContact contact, Message originalMessage, CryptElement cryptElement, OpenPgpMetadata metadata);
036}