bt.metainfo.TorrentSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bt-core Show documentation

BitTorrent Client Library (Core)

There is a newer version: 1.10

package bt.metainfo;

import java.util.Optional;

/**
 * @since 1.3
 */
public interface TorrentSource {

    /**
     * Returns metadata that contains all necessary information to fully re-create the torrent.
     * Usually this means the contents of a .torrent file in BEP-3 format.
     * It's not mandatory for normal Bt operation.
     *
     * @return Torrent metadata
     * @since 1.3
     * @see MetadataService
     */
    Optional getMetadata();

    /**
     * Returns the part of metadata that is shared with other peers per BEP-9.
     * Usually this means the info dictionary.
     *
     * Programmatically created torrents may choose to use their own metadata serialization format,
     * given that the corresponding Bt services (like MetadataService) are adjusted accordingly
     * both for local and remote runtime instances.
     *
     * @return BEP-9 metadata
     * @since 1.3
     * @see MetadataService
     */
    byte[] getExchangedMetadata();

    // TODO: provide BEObjectModels for both types of metadata?
    // but this will effectively restrict possible types of metadata to bencoded form only...
}