Author: eric
Date: Mon Apr 18 03:37:54 2011
New Revision: 1094221
URL: http://svn.apache.org/viewvc?rev=1094221&view=rev
Log:
Update documentation with last rrt change in JAMES-1226 (JAMES-1219)
Modified:
james/server/trunk/src/site/xdoc/manage-recipientrewrite.xml
Modified: james/server/trunk/src/site/xdoc/manage-recipientrewrite.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/manage-recipientrewrite.xml?rev=1094221&r1=1094220&r2=1094221&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/manage-recipientrewrite.xml (original)
+++ james/server/trunk/src/site/xdoc/manage-recipientrewrite.xml Mon Apr 18
03:37:54 2011
@@ -39,35 +39,46 @@
/**
* Add regex mapping
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
- * @param regex the regex.
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
+ * @param regex
+ * the regex.
*/
void addRegexMapping(String user, String domain, String regex) throws
Exception;
/**
* Remove regex mapping
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
- * @param regex the regex.
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
+ * @param regex
+ * the regex.
*/
void removeRegexMapping(String user, String domain, String regex) throws
Exception;
/***
* Add address mapping
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
- * @param address the address.
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
+ * @param address
+ * the address.
*/
void addAddressMapping(String user, String domain, String address) throws
Exception;
/**
* Remove address mapping
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
* @param address
*/
void removeAddressMapping(String user, String domain, String address)
throws Exception;
@@ -75,8 +86,10 @@
/**
* Add error mapping
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
* @param error
*/
void addErrorMapping(String user, String domain, String error) throws
Exception;
@@ -84,19 +97,46 @@
/**
* Remove error mapping
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
* @param error
* @return true if successfully
*/
void removeErrorMapping(String user, String domain, String error) throws
Exception;
/**
+ * Add domain mapping
+ *
+ * @param domain
+ * the domain. Null if no domain should be used
+ * @param targetDomain
+ * the target domain for the mapping
+ * @return true if successfully
+ */
+ void addDomainMapping(String domain, String targetDomain) throws Exception;
+
+ /**
+ * Remove domain mapping
+ *
+ * @param domain
+ * the domain. Null if no domain should be used
+ * @param targetDomain
+ * the target domain for the mapping
+ *
+ * @return true if successfully
+ */
+ void removeDomainMapping(String domain, String targetDomain) throws
Exception;
+
+ /**
* Return the explicit mapping stored for the given user and domain. Return
* null if no mapping was found
*
- * @param user the username
- * @param domain the domain
+ * @param user
+ * the username
+ * @param domain
+ * the domain
* @return the collection which holds the mappings.
*/
Collection<String> getUserDomainMappings(String user, String domain)
throws Exception;
@@ -105,9 +145,12 @@
* Try to identify the right method based on the prefix of the mapping and
* add it.
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
- * @param mapping the mapping.
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
+ * @param mapping
+ * the mapping.
*/
void addMapping(String user, String domain, String mapping) throws
Exception;
@@ -115,9 +158,12 @@
* Try to identify the right method based on the prefix of the mapping and
* remove it.
*
- * @param user the username. Null if no username should be used
- * @param domain the domain. Null if no domain should be used
- * @param mapping the mapping.
+ * @param user
+ * the username. Null if no username should be used
+ * @param domain
+ * the domain. Null if no domain should be used
+ * @param mapping
+ * the mapping.
*/
void removeMapping(String user, String domain, String mapping) throws
Exception;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
