X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fkotlin%2Fnet%2Fpterodactylus%2Fsone%2Ffreenet%2Fwot%2FWebOfTrustConnector.kt;fp=src%2Fmain%2Fkotlin%2Fnet%2Fpterodactylus%2Fsone%2Ffreenet%2Fwot%2FWebOfTrustConnector.kt;h=8488f16a6f23aa55ee7925c4e5940c45c816f856;hp=0000000000000000000000000000000000000000;hb=d50730f6a330439e0e7ef97ca9329dffe72d5640;hpb=97fe04482ebb8a08e43294acde041c2975cbd8ee

diff --git a/src/main/kotlin/net/pterodactylus/sone/freenet/wot/WebOfTrustConnector.kt b/src/main/kotlin/net/pterodactylus/sone/freenet/wot/WebOfTrustConnector.kt
new file mode 100644
index 0000000..8488f16
--- /dev/null
+++ b/src/main/kotlin/net/pterodactylus/sone/freenet/wot/WebOfTrustConnector.kt
@@ -0,0 +1,121 @@
+package net.pterodactylus.sone.freenet.wot
+
+import net.pterodactylus.sone.freenet.plugin.*
+
+/**
+ * Connector for the web of trust plugin.
+ */
+interface WebOfTrustConnector {
+
+	/**
+	 * Loads all own identities from the Web of Trust plugin.
+	 *
+	 * @return All own identity
+	 * @throws WebOfTrustException if the own identities can not be loaded
+	 */
+	@Throws(WebOfTrustException::class)
+	fun loadAllOwnIdentities(): Set<OwnIdentity>
+
+	/**
+	 * Loads all identities that the given identities trusts with a score of
+	 * more than 0 and the (optional) given context.
+	 *
+	 * @param ownIdentity The own identity
+	 * @param context The context to filter, or `null`
+	 * @return All trusted identities
+	 * @throws PluginException if an error occured talking to the Web of Trust plugin
+	 */
+	@Throws(PluginException::class)
+	fun loadTrustedIdentities(ownIdentity: OwnIdentity, context: String? = null): Set<Identity>
+
+	/**
+	 * Adds the given context to the given identity.
+	 *
+	 * @param ownIdentity The identity to add the context to
+	 * @param context The context to add
+	 * @throws PluginException if an error occured talking to the Web of Trust plugin
+	 */
+	@Throws(PluginException::class)
+	fun addContext(ownIdentity: OwnIdentity, context: String)
+
+	/**
+	 * Removes the given context from the given identity.
+	 *
+	 * @param ownIdentity The identity to remove the context from
+	 * @param context The context to remove
+	 * @throws PluginException if an error occured talking to the Web of Trust plugin
+	 */
+	@Throws(PluginException::class)
+	fun removeContext(ownIdentity: OwnIdentity, context: String)
+
+	/**
+	 * Sets the property with the given name to the given value.
+	 *
+	 * @param ownIdentity The identity to set the property on
+	 * @param name The name of the property to set
+	 * @param value The value to set
+	 * @throws PluginException if an error occured talking to the Web of Trust plugin
+	 */
+	@Throws(PluginException::class)
+	fun setProperty(ownIdentity: OwnIdentity, name: String, value: String)
+
+	/**
+	 * Removes the property with the given name.
+	 *
+	 * @param ownIdentity The identity to remove the property from
+	 * @param name The name of the property to remove
+	 * @throws PluginException if an error occured talking to the Web of Trust plugin
+	 */
+	@Throws(PluginException::class)
+	fun removeProperty(ownIdentity: OwnIdentity, name: String)
+
+	/**
+	 * Returns the trust for the given identity assigned to it by the given own
+	 * identity.
+	 *
+	 * @param ownIdentity The own identity
+	 * @param identity The identity to get the trust for
+	 * @return The trust for the given identity
+	 * @throws PluginException if an error occured talking to the Web of Trust plugin
+	 */
+	@Throws(PluginException::class)
+	fun getTrust(ownIdentity: OwnIdentity, identity: Identity): Trust
+
+	/**
+	 * Sets the trust for the given identity.
+	 *
+	 * @param ownIdentity The trusting identity
+	 * @param identity The trusted identity
+	 * @param trust The amount of trust (-100 thru 100)
+	 * @param comment The comment or explanation of the trust value
+	 * @throws PluginException if an error occured talking to the Web of Trust plugin
+	 */
+	@Throws(PluginException::class)
+	fun setTrust(ownIdentity: OwnIdentity, identity: Identity, trust: Int, comment: String)
+
+	/**
+	 * Removes any trust assignment of the given own identity for the given
+	 * identity.
+	 *
+	 * @param ownIdentity The own identity
+	 * @param identity The identity to remove all trust for
+	 * @throws WebOfTrustException if an error occurs
+	 */
+	@Throws(WebOfTrustException::class)
+	fun removeTrust(ownIdentity: OwnIdentity, identity: Identity)
+
+	/**
+	 * Pings the Web of Trust plugin. If the plugin can not be reached, a
+	 * [PluginException] is thrown.
+	 *
+	 * @throws PluginException if the plugin is not loaded
+	 */
+	@Throws(PluginException::class)
+	fun ping()
+
+	/**
+	 * Stops the web of trust connector.
+	 */
+	fun stop() = Unit
+
+}