/*
* File : PluginConfig.java
* Created : 17 nov. 2003
* By : Olivier
*
* Azureus - a Java Bittorrent client
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details ( see the LICENSE file ).
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.gudy.azureus2.plugins;
/**
* @author Olivier
*
*/
import java.io.File;
import java.util.List;
import java.util.Map;
import org.gudy.azureus2.plugins.config.*;
public interface
PluginConfig
{
public static final String CORE_PARAM_INT_MAX_UPLOAD_SPEED_KBYTES_PER_SEC = "Max Upload Speed KBs";
public static final String CORE_PARAM_INT_MAX_UPLOAD_SPEED_SEEDING_KBYTES_PER_SEC = "Max Upload Speed When Only Seeding KBs";
public static final String CORE_PARAM_INT_MAX_DOWNLOAD_SPEED_KBYTES_PER_SEC = "Max Download Speed KBs";
public static final String CORE_PARAM_INT_MAX_CONNECTIONS_PER_TORRENT = "Max Connections Per Torrent";
public static final String CORE_PARAM_INT_MAX_CONNECTIONS_GLOBAL = "Max Connections Global";
public static final String CORE_PARAM_INT_MAX_DOWNLOADS = "Max Downloads";
public static final String CORE_PARAM_INT_MAX_ACTIVE = "Max Active Torrents";
public static final String CORE_PARAM_INT_MAX_ACTIVE_SEEDING = "Max Active Torrents When Only Seeding";
public static final String CORE_PARAM_INT_MAX_UPLOADS = "Max Uploads";
public static final String CORE_PARAM_INT_MAX_UPLOADS_SEEDING = "Max Uploads Seeding";
public static final String CORE_PARAM_BOOLEAN_AUTO_SPEED_ON = "Auto Upload Speed Enabled";
public static final String CORE_PARAM_BOOLEAN_MAX_UPLOAD_SPEED_SEEDING = "Max Upload Speed When Only Seeding Enabled";
public static final String CORE_PARAM_BOOLEAN_MAX_ACTIVE_SEEDING = "Max Active Torrents When Only Seeding Enabled";
public static final String CORE_PARAM_BOOLEAN_SOCKS_PROXY_NO_INWARD_CONNECTION = "SOCKS Proxy No Inward Connection";
public static final String CORE_PARAM_BOOLEAN_NEW_SEEDS_START_AT_TOP = "Newly Seeding Torrents Get First Priority";
/**
* @since 2.3.0.5
*/
public static final String CORE_PARAM_STRING_LOCAL_BIND_IP = "CORE_PARAM_STRING_LOCAL_BIND_IP";
public static final String CORE_PARAM_BOOLEAN_FRIENDLY_HASH_CHECKING = "CORE_PARAM_BOOLEAN_FRIENDLY_HASH_CHECKING";
/**
* Returns the value of a core boolean parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public boolean getBooleanParameter(String key);
/**
* Returns the value of a core boolean parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.0.6.0
*/
public boolean getBooleanParameter(String key, boolean default_value);
/**
* Returns the value of a core byte array parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public byte[] getByteParameter(String key);
/**
* Returns the value of a core byte array parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.1.0.2
*/
public byte[] getByteParameter(String key, byte[] default_value);
/**
* Returns the value of a core float parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 2.1.0.0
*/
public float getFloatParameter(String key);
/**
* Returns the value of a core float parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public float getFloatParameter(String key, float default_value);
/**
* Returns the value of a core int parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public int getIntParameter(String key);
/**
* Returns the value of a core int parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.0.7.0
*/
public int getIntParameter(String key, int default_value);
/**
* Returns the value of a core long parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public long getLongParameter(String key);
/**
* Returns the value of a core long parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public long getLongParameter(String key, long default_value);
/**
* Returns the value of a core string parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public String getStringParameter(String key);
/**
* Returns the value of a core string parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.1.0.0
*/
public String getStringParameter(String key, String default_value);
/**
* Sets the value of a core boolean parameter.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*/
public void setBooleanParameter(String key, boolean value);
/**
* Sets the value of a core byte array parameter.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.7
*/
public void setByteParameter(String key, byte[] value);
/**
* Sets the value of a core float parameter.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.7
*/
public void setFloatParameter(String key, float value);
/**
* Sets the value of a core int parameter.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 2.0.8.0
*/
public void setIntParameter(String key, int value);
/**
* Sets the value of a core long parameter.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.7
*/
public void setLongParameter(String key, long value);
/**
* Sets the value of a core string parameter.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.7
*/
public void setStringParameter(String key, String value);
/**
* Returns the value of a plugin boolean parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public boolean getPluginBooleanParameter(String key);
/**
* Returns the value of a plugin boolean parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public boolean getPluginBooleanParameter(String key, boolean default_value);
/**
* Returns the value of a plugin byte array parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public byte[] getPluginByteParameter(String key);
/**
* Returns the value of a plugin byte array parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.2.0.3
*/
public byte[] getPluginByteParameter(String key, byte[] default_value);
/**
* Returns the value of a plugin float parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public float getPluginFloatParameter(String key);
/**
* Returns the value of a plugin float parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public float getPluginFloatParameter(String key, float default_value);
/**
* Returns the value of a plugin int parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public int getPluginIntParameter(String key);
/**
* Returns the value of a plugin int parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public int getPluginIntParameter(String key, int default_value);
/**
* Returns the value of a plugin list parameter. The contents of the list must conform
* to <i>bencodable</i> rules (e.g. <tt>Map</tt>, <tt>Long</tt>, <tt>byte[]</tt>, <tt>List</tt>)
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.3.0.1
*/
public List getPluginListParameter(String key, List default_value);
/**
* Returns the value of a plugin long parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public long getPluginLongParameter(String key);
/**
* Returns the value of a plugin long parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public long getPluginLongParameter(String key, long default_value);
/**
* Returns the value of a plugin map parameter. The contents of the map must conform
* to <i>bencodable</i> rules (e.g. <tt>Map</tt>, <tt>Long</tt>, <tt>byte[]</tt>, <tt>List</tt>)
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.3.0.1
*/
public Map getPluginMapParameter(String key, Map default_value);
/**
* Returns the value of a plugin string parameter.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public String getPluginStringParameter(String key);
/**
* Returns the value of a plugin string parameter.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 2.0.4.2
*/
public String getPluginStringParameter(String key, String default_value);
/**
* Sets the value of a plugin boolean parameter.
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 2.0.4.2
*/
public void setPluginParameter(String key, boolean value);
/**
* Sets the value of a plugin byte array parameter.
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 2.1.0.2
*/
public void setPluginParameter(String key, byte[] value);
/**
* Sets the value of a plugin float parameter.
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 3.0.0.7
*/
public void setPluginParameter(String key, float value);
/**
* Sets the value of a plugin int parameter.
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 2.0.4.2
*/
public void setPluginParameter(String key, int value);
/**
* Sets the value of a plugin int parameter.
*
* @param key The parameter name.
* @param value The new value for the parameter.
* @param global Whether or not this parameter should be made externally accessible.
*
* @since 2.5.0.1
*/
public void setPluginParameter(String key, int value, boolean global);
/**
* Sets the value of a plugin long parameter.
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 3.0.0.7
*/
public void setPluginParameter(String key, long value);
/**
* Sets the value of a plugin string parameter.
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 2.0.4.2
*/
public void setPluginParameter(String key, String value);
/**
* Sets the value of a plugin list parameter. The contents of the list must conform
* to <i>bencodable</i> rules (e.g. <tt>Map</tt>, <tt>Long</tt>, <tt>byte[]</tt>, <tt>List</tt>)
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 2.3.0.1
*/
public void setPluginListParameter(String key, List value);
/**
* Sets the value of a plugin map parameter. The contents of the map must conform
* to <i>bencodable</i> rules (e.g. <tt>Map</tt>, <tt>Long</tt>, <tt>byte[]</tt>, <tt>List</tt>)
*
* @param key The parameter name.
* @param value The new value for the parameter.
*
* @since 2.3.0.1
*/
public void setPluginMapParameter(String key, Map value);
/**
* Returns the value of a core boolean parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public boolean getUnsafeBooleanParameter(String key);
/**
* Returns the value of a core boolean parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.5
*/
public boolean getUnsafeBooleanParameter(String key, boolean default_value);
/**
* Returns the value of a core byte array parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public byte[] getUnsafeByteParameter(String key);
/**
* Returns the value of a core byte array parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public byte[] getUnsafeByteParameter(String key, byte[] default_value);
/**
* Returns the value of a core float parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public float getUnsafeFloatParameter(String key);
/**
* Returns the value of a core float parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.5
*/
public float getUnsafeFloatParameter(String key, float default_value);
/**
* Returns the value of a core int parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public int getUnsafeIntParameter(String key);
/**
* Returns the value of a core int parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.5
*/
public int getUnsafeIntParameter(String key, int default_value);
/**
* Returns the value of a core long parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public long getUnsafeLongParameter(String key);
/**
* Returns the value of a core long parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.5
*/
public long getUnsafeLongParameter(String key, long default_value);
/**
* Returns the value of a core string parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @return The value of the parameter.
*
* @since 3.0.0.7
*/
public String getUnsafeStringParameter(String key);
/**
* Returns the value of a core string parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name.
* @param default_value The default value to return if one is not defined.
* @return The value of the parameter.
*
* @since 3.0.0.5
*/
public String getUnsafeStringParameter(String key, String default_value);
/**
* Sets the value of a core boolean parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.5
*/
public void setUnsafeBooleanParameter(String key, boolean value);
/**
* Sets the value of a core byte array parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.7
*/
public void setUnsafeByteParameter(String key, byte[] value);
/**
* Sets the value of a core float parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.5
*/
public void setUnsafeFloatParameter(String key, float value);
/**
* Sets the value of a core int parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.5
*/
public void setUnsafeIntParameter(String key, int value);
/**
* Sets the value of a core long parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.5
*/
public void setUnsafeLongParameter(String key, long value);
/**
* Sets the value of a core string parameter. Note: the semantics of this
* method will not be guaranteed - core parameter names may change in the future,
* and this method will not do any parameter name mapping for you, so take care when
* using this method.
*
* @param key The parameter name, which must be one defined from the above core constants.
* @param value The new value for the parameter.
*
* @since 3.0.0.5
*/
public void setUnsafeStringParameter(String key, String value);
/**
* Removes the plugin parameter with the given name.
*
* @param key Name of the parameter.
* @return <tt>true</tt> if the parameter was found and removed.
*/
public boolean removePluginParameter(String key);
/**
* @return the prefix used when storing configuration values in the config file for
* this plugin's config parameters
*
* @since 2.1.0.0
*/
public String
getPluginConfigKeyPrefix();
public ConfigParameter
getParameter(
String key );
public ConfigParameter
getPluginParameter(
String key );
public boolean
isNewInstall();
/**
* Returns a map<String,Object> giving parameter names -> parameter values. Value can be Long or String
* as the type is actually not known by the core (might fix one day). Therefore, float values are actually
* represented by their String format:
*
* boolean - Long 0 or 1
* int - Long.intValue
* float - String value
* String - String
*
* Unsafe methods - existence/semantics of parameters not guaranteed to be maintained across versions
* If something changes and breaks your plugin, don't come complaining to me
* @since 2.5.0.3
*/
public Map
getUnsafeParameterList();
/**
* make sure you save it after making changes!
*
* @since 2.0.8.0
*/
public void
save()
throws PluginException;
/**
* Returns a file that can be used by the plugin to save user-specific state
* This will be "azureus-user-dir"/plugins/<plugin name>/name
* @param name
* @return
*/
public File
getPluginUserFile(
String name );
/**
* Returns true if a core parameter with the given name exists.
* @param key The name of the parameter to check.
* @since 2.5.0.2
*/
public boolean hasParameter(String param_name);
/**
* Returns true if a plugin parameter with the given name exists.
* @param key The name of the parameter to check.
* @since 2.5.0.2
*/
public boolean hasPluginParameter(String param_name);
public void
addListener(
PluginConfigListener l );
/**
* @param _key
*
* @since 2.5.0.1
*/
public void setPluginConfigKeyPrefix(String _key);
}
|
