org.torproject.metrics.bot

Class Configuration

java.lang.Object

org.torproject.metrics.bot.Configuration

public class Configuration
extends java.lang.Object

metrics-bot's configuration is loaded from an XML file in the home directory of the user running metrics-bot. It is expected that metrics-bot will run using a dedicated user and so keeping the home directory tidy with custom paths is not a concern. The path to the configuration file is hardcoded as: ~/.metrics-bot.xml

The XML file contains credentials for the various accounts that are connected to metrics-bot, so you should probably chmod it and make sure that it's kept away from evil.

An example XML file looks like:

 <metrics-bot>
 <twitter>
  <account name="@TorAtlas" network="true"
    relay="true">
   <consumerkey>xxxxxxxxx</consumerkey>
   <consumersecret>xxxxxxxxxx</consumersecret>
   <token>xxxxxxxxxxx</token>
   <tokensecret>xxxxxxxxxxxx</tokensecret>
  </account>
 </twitter>
 <mastodon>
  <account name="@metrics-bot@botsin.space"
    network="true" relay="true">
   <instancehost>botsin.space</instancehost>
   <token>xxxxxxxxxxxx</token>
  </account>
 </mastodon>
 <irc>
  <nick>metrics-bot</nick>
  <password>xxxxxxxxx</password>
  <channel name="#tor-test" alert="true" />
 </irc>
 </metrics-bot>
 

Author:

Iain R. Learmonth <irl@torproject.org>

Constructor Summary

Constructors

Constructor and Description
Configuration() Create a new configuration object.

Method Summary

Modifier and Type	Method and Description
java.util.List<IrcChannelConfiguration>	getIrcChannels() Returns a list of IRC channel configurations that could be used to instantiate IRC channel objects.
java.lang.String	getIrcNick()
java.lang.String	getIrcNickServPassword()
java.util.List<MastodonAccountConfiguration>	getMastodonAccounts() Returns a list of Mastodon account configurations that could be used to instantiate Mastodon account objects.
static Configuration	getSingleton()
java.util.List<TwitterAccountConfiguration>	getTwitterAccounts() Returns a list of Twitter account configurations that could be used to instantiate Twitter account objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Configuration

public Configuration()
              throws java.io.IOException,
                     org.apache.commons.configuration.ConfigurationException

Create a new configuration object. The path for the configuration file is hardcoded to ~/.metrics-bot.xml. It is expected that this constructor will only ever be called at runtime by the getSingleton() static method.

Throws:

java.io.IOException - if there are errors reading the XML configuration from disk

org.apache.commons.configuration.ConfigurationException - if there are errors parsing the XML configuration

Method Detail

getSingleton

public static Configuration getSingleton()

getTwitterAccounts

public java.util.List<TwitterAccountConfiguration> getTwitterAccounts()

Returns a list of Twitter account configurations that could be used to instantiate Twitter account objects. Both the authentication and status types are included from the XML configuration.

getMastodonAccounts

public java.util.List<MastodonAccountConfiguration> getMastodonAccounts()

Returns a list of Mastodon account configurations that could be used to instantiate Mastodon account objects. Both the authentication and status types are included from the XML configuration.

getIrcNick

public java.lang.String getIrcNick()

getIrcNickServPassword

public java.lang.String getIrcNickServPassword()

getIrcChannels

public java.util.List<IrcChannelConfiguration> getIrcChannels()

Returns a list of IRC channel configurations that could be used to instantiate IRC channel objects. Both the authentication and status types are included from the XML configuration.