org.apache.james.cli.probe.impl

Class JmxServerProbe

java.lang.Object

org.apache.james.cli.probe.impl.JmxServerProbe

All Implemented Interfaces:

ServerProbe

public class JmxServerProbe
extends Object
implements ServerProbe

Constructor Summary

Constructors

Constructor and Description
JmxServerProbe(String host) Creates a NodeProbe using the specified JMX host and default port.
JmxServerProbe(String host, int port) Creates a ServerProbe using the specified JMX host and port.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAddressMapping(String user, String domain, String toAddress) Add address mapping.
void	addDomain(String domain) Add domain to the service.
void	addRegexMapping(String user, String domain, String regex) Remove regex mapping.
void	addUser(String userName, String password) Add a user to this mail server.
String[]	listDomains() Get a list of domains for the service.
Map<String,Collection<String>>	listMappings() Get a Map which holds all mappings.
Collection<String>	listUserDomainMappings(String user, String domain) Return the explicit mapping stored for the given user and domain.
String[]	listUsers() Get a List the names of all users.
void	removeAddressMapping(String user, String domain, String fromAddress) Remove address mapping.
void	removeDomain(String domain) Remove domain from the service
void	removeRegexMapping(String user, String domain, String regex) Remove regex mapping.
void	removeUser(String username) Delete a user from this mail server.
void	setPassword(String userName, String password) Set a user's password.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmxServerProbe

public JmxServerProbe(String host,
              int port)
               throws IOException,
                      InterruptedException

Creates a ServerProbe using the specified JMX host and port.

Parameters:

host - hostname or IP address of the JMX agent

port - TCP port of the remote JMX agent

Throws:

IOException - on connection failures

InterruptedException

JmxServerProbe

public JmxServerProbe(String host)
               throws IOException,
                      InterruptedException

Creates a NodeProbe using the specified JMX host and default port.

Parameters:

host - hostname or IP address of the JMX agent

Throws:

IOException - on connection failures

InterruptedException

Method Detail

addUser

public void addUser(String userName,
           String password)
             throws Exception

Description copied from interface: ServerProbe

Add a user to this mail server.

Specified by:

addUser in interface ServerProbe

Parameters:

userName - The name of the user being added.

password - The password of the user being added.

Throws:

Exception

See Also:

ServerProbe.addUser(java.lang.String, java.lang.String)

removeUser

public void removeUser(String username)
                throws Exception

Description copied from interface: ServerProbe

Delete a user from this mail server.

Specified by:

removeUser in interface ServerProbe

Parameters:

username - The name of the user being deleted.

Throws:

Exception

See Also:

ServerProbe.removeUser(java.lang.String)

listUsers

public String[] listUsers()
                   throws Exception

Description copied from interface: ServerProbe

Get a List the names of all users.

Specified by:

listUsers in interface ServerProbe

Returns:

a List of all user names.

Throws:

Exception

See Also:

ServerProbe.listUsers()

setPassword

public void setPassword(String userName,
               String password)
                 throws Exception

Description copied from interface: ServerProbe

Set a user's password.

Specified by:

setPassword in interface ServerProbe

Parameters:

userName - The name of the user whose password will be changed.

password - The new password.

Throws:

Exception

See Also:

ServerProbe.setPassword(java.lang.String, java.lang.String)

addDomain

public void addDomain(String domain)
               throws Exception

Description copied from interface: ServerProbe

Add domain to the service.

Specified by:

addDomain in interface ServerProbe

Parameters:

domain - The domain to add.

Throws:

Exception

See Also:

ServerProbe.addDomain(java.lang.String)

removeDomain

public void removeDomain(String domain)
                  throws Exception

Description copied from interface: ServerProbe

Remove domain from the service

Specified by:

removeDomain in interface ServerProbe

Parameters:

domain - The domain to remove.

Throws:

Exception

See Also:

ServerProbe.removeDomain(java.lang.String)

listDomains

public String[] listDomains()
                     throws Exception

Description copied from interface: ServerProbe

Get a list of domains for the service.

Specified by:

listDomains in interface ServerProbe

Returns:

domains an array of domains, or null if no domains exist.

Throws:

Exception

See Also:

ServerProbe.listDomains()

listMappings

public Map<String,Collection<String>> listMappings()
                                            throws Exception

Description copied from interface: ServerProbe

Get a Map which holds all mappings. The key is the user@domain and the value is a Collection which holds all mappings.

Specified by:

listMappings in interface ServerProbe

Returns:

a Map which holds all mappings.

Throws:

Exception

See Also:

ServerProbe.listMappings()

addAddressMapping

public void addAddressMapping(String user,
                     String domain,
                     String toAddress)
                       throws Exception

Description copied from interface: ServerProbe

Add address mapping.

Specified by:

addAddressMapping in interface ServerProbe

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used.

toAddress - The address.

Throws:

Exception

See Also:

ServerProbe.addAddressMapping(java.lang.String, java.lang.String, java.lang.String)

removeAddressMapping

public void removeAddressMapping(String user,
                        String domain,
                        String fromAddress)
                          throws Exception

Description copied from interface: ServerProbe

Remove address mapping.

Specified by:

removeAddressMapping in interface ServerProbe

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used

fromAddress - The address.

Throws:

Exception

See Also:

ServerProbe.removeAddressMapping(java.lang.String, java.lang.String, java.lang.String)

listUserDomainMappings

public Collection<String> listUserDomainMappings(String user,
                                        String domain)
                                          throws Exception

Description copied from interface: ServerProbe

Return the explicit mapping stored for the given user and domain. Return null if no mapping was found

Specified by:

listUserDomainMappings in interface ServerProbe

Parameters:

user - The username.

domain - The domain.

Returns:

the collection which holds the mappings, or null if no mapping is found.

Throws:

Exception

See Also:

ServerProbe.listUserDomainMappings(java.lang.String, java.lang.String)

addRegexMapping

public void addRegexMapping(String user,
                   String domain,
                   String regex)
                     throws Exception

Description copied from interface: ServerProbe

Remove regex mapping.

Specified by:

addRegexMapping in interface ServerProbe

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used.

regex - The regex.

Throws:

Exception

See Also:

ServerProbe.addRegexMapping(java.lang.String, java.lang.String, java.lang.String)

removeRegexMapping

public void removeRegexMapping(String user,
                      String domain,
                      String regex)
                        throws Exception

Description copied from interface: ServerProbe

Remove regex mapping.

Specified by:

removeRegexMapping in interface ServerProbe

Parameters:

user - The username, or null if no username should be used.

domain - The domain, or null if no domain should be used.

regex - The regex.

Throws:

Exception

See Also:

ServerProbe.removeRegexMapping(java.lang.String, java.lang.String, java.lang.String)