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;
020
021import org.jivesoftware.smackx.ox.OpenPgpContact;
022import org.jivesoftware.smackx.ox.element.SignElement;
023
024import org.pgpainless.decryption_verification.OpenPgpMetadata;
025
026public interface SignElementReceivedListener {
027
028    /**
029     * A {@link SignElement} has been received and successfully been verified.
030     * This listener is intended to be used by implementors of different OX usage profiles.
031     * @param contact sender of the message
032     * @param originalMessage original message containing the {@link SignElement}
033     * @param signElement the {@link SignElement} itself
034     * @param metadata metadata about the signing
035     */
036    void signElementReceived(OpenPgpContact contact, Message originalMessage, SignElement signElement, OpenPgpMetadata metadata);
037
038}