org.apache.james.mpt
Class ScriptedUserAdder

java.lang.Object
  extended by org.apache.james.mpt.ScriptedUserAdder
All Implemented Interfaces:
UserAdder

public class ScriptedUserAdder
extends java.lang.Object
implements UserAdder

Adds a user by executing a script at a port. The user name and password supplied will be substituted for the variables ${user} and ${password}.


Constructor Summary
ScriptedUserAdder(java.lang.String host, int port)
          Constructs an adder without a script.
ScriptedUserAdder(java.lang.String host, int port, Monitor monitor)
          Note that addUser(String, String) will not be available
ScriptedUserAdder(java.lang.String host, int port, java.lang.String script)
           
ScriptedUserAdder(java.lang.String host, int port, java.lang.String script, Monitor monitor)
           
 
Method Summary
 void addUser(java.lang.String user, java.lang.String password)
          Adds a user using the script read from the given input.
 void addUser(java.lang.String user, java.lang.String password, java.io.Reader reader)
          Adds a user using the script read from the given input.
 java.lang.String toString()
          Constructs a String with all attributes in name = value format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScriptedUserAdder

public ScriptedUserAdder(java.lang.String host,
                         int port)
Constructs an adder without a script. Note that addUser(String, String) will not be available

Parameters:
host - connect to this host
port - connect to this port

ScriptedUserAdder

public ScriptedUserAdder(java.lang.String host,
                         int port,
                         java.lang.String script)

ScriptedUserAdder

public ScriptedUserAdder(java.lang.String host,
                         int port,
                         Monitor monitor)
Note that addUser(String, String) will not be available

Parameters:
host - connect to this host
port - connect to this port
monitor - not null

ScriptedUserAdder

public ScriptedUserAdder(java.lang.String host,
                         int port,
                         java.lang.String script,
                         Monitor monitor)
Method Detail

addUser

public void addUser(java.lang.String user,
                    java.lang.String password)
             throws java.lang.Exception
Adds a user using the script read from the given input.

Specified by:
addUser in interface UserAdder
Parameters:
user - user name, not null
password - password to set, not null
Throws:
java.lang.Exception - upon failure
java.lang.NullPointerException - when script has not been set

addUser

public void addUser(java.lang.String user,
                    java.lang.String password,
                    java.io.Reader reader)
             throws java.lang.Exception
Adds a user using the script read from the given input.

Parameters:
user - user name, not null
password - password to set, not null
reader - reader for script, not null
Throws:
java.lang.Exception - upon failure

toString

public java.lang.String toString()
Constructs a String with all attributes in name = value format.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of this object.


Copyright © 2008-2009 The Apache Software Foundation. All Rights Reserved.