StoragePayload.java

package io.bitsquare.p2p.storage.payload;

import io.bitsquare.p2p.NodeAddress;
import io.bitsquare.p2p.storage.storageentry.ProtectedStorageEntry;

import java.security.PublicKey;

/**
 * Messages which support ownership protection (using signatures) and a time to live
 * <p>
 * Implementations:
 * io.bitsquare.alert.Alert
 * io.bitsquare.arbitration.Arbitrator
 * io.bitsquare.trade.offer.Offer
 */
public interface StoragePayload extends ExpirablePayload {
    /**
     * Used for check if the add or remove operation is permitted.
     * Only data owner can add or remove the data.
     * OwnerPubKey has to be equal to the ownerPubKey of the ProtectedData
     *
     * @return The public key of the data owner.
     * @see ProtectedStorageEntry#ownerPubKey
     * @see io.bitsquare.p2p.storage.P2PDataStorage#add(ProtectedStorageEntry, NodeAddress)
     * @see io.bitsquare.p2p.storage.P2PDataStorage#remove(ProtectedStorageEntry, NodeAddress)
     */
    PublicKey getOwnerPubKey();
}