pgoldstein 2002/09/23 10:36:34
Modified: src/java/org/apache/james/userrepository
DefaultJamesUser.java
www/javadocs/org/apache/james/userrepository
DefaultJamesUser.html
Log:
Fixed spacing, added comments.
Revision Changes Path
1.5 +73 -13
jakarta-james/src/java/org/apache/james/userrepository/DefaultJamesUser.java
Index: DefaultJamesUser.java
===================================================================
RCS file:
/home/cvs/jakarta-james/src/java/org/apache/james/userrepository/DefaultJamesUser.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DefaultJamesUser.java 14 Sep 2002 09:00:58 -0000 1.4
+++ DefaultJamesUser.java 23 Sep 2002 17:36:34 -0000 1.5
@@ -23,13 +23,29 @@
extends DefaultUser
implements JamesUser, Initializable {
+ /**
+ * Whether forwarding is enabled for this user.
+ */
private boolean forwarding;
+
+ /**
+ * The mail address to which this user's email is forwarded.
+ */
private MailAddress forwardingDestination;
+
+ /**
+ * Is this user an alias for another username on the system.
+ */
private boolean aliasing;
+
+
+ /**
+ * The user name that this user name is aliasing.
+ */
private String alias;
public DefaultJamesUser(String name, String alg) {
- super(name, alg);
+ super(name, alg);
}
public DefaultJamesUser(String name, String passwordHash, String hashAlg) {
@@ -51,40 +67,84 @@
alias = "";
}
+ /**
+ * Set whether mail to this user is to be forwarded to another
+ * email address
+ *
+ * @param forward whether mail is forwarded
+ */
public void setForwarding(boolean forward) {
- forwarding = forward;
+ forwarding = forward;
}
+ /**
+ * Get whether mail to this user is to be forwarded to another
+ * email address.
+ *
+ * @return forward whether mail is forwarded
+ */
public boolean getForwarding() {
- return forwarding;
+ return forwarding;
}
+ /**
+ * Set the destination address to which mail to this user
+ * will be forwarded.
+ *
+ * @param address the forward-to address
+ */
public boolean setForwardingDestination(MailAddress address) {
- /* Some verification would be good */
- forwardingDestination = address;
- return true;
+ /* TODO: Some verification would be good */
+ forwardingDestination = address;
+ return true;
}
+ /**
+ * Get the destination address to which mail to this user
+ * will be forwarded.
+ *
+ * @return the forward-to address
+ */
public MailAddress getForwardingDestination() {
- return forwardingDestination;
+ return forwardingDestination;
}
+ /**
+ * Set whether this user id is an alias.
+ *
+ * @param alias whether this id is an alias
+ */
public void setAliasing(boolean alias) {
aliasing = alias;
}
+ /**
+ * Get whether this user id is an alias.
+ *
+ * @return whether this id is an alias
+ */
public boolean getAliasing() {
- return aliasing;
+ return aliasing;
}
+ /**
+ * Set the user id for which this id is an alias.
+ *
+ * @param address the user id for which this id is an alias
+ */
public boolean setAlias(String address) {
- /* Some verification would be good */
- alias = address;
- return true;
+ /* TODO: Some verification would be good */
+ alias = address;
+ return true;
}
+ /**
+ * Get the user id for which this id is an alias.
+ *
+ * @return the user id for which this id is an alias
+ */
public String getAlias() {
- return alias;
+ return alias;
}
}
1.7 +1 -1
jakarta-james/www/javadocs/org/apache/james/userrepository/DefaultJamesUser.html
Index: DefaultJamesUser.html
===================================================================
RCS file:
/home/cvs/jakarta-james/www/javadocs/org/apache/james/userrepository/DefaultJamesUser.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- DefaultJamesUser.html 14 Sep 2002 09:11:12 -0000 1.6
+++ DefaultJamesUser.html 23 Sep 2002 17:36:34 -0000 1.7
@@ -2,7 +2,7 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sat Sep 14 02:01:45 PDT 2002 -->
+<!-- Generated by javadoc on Mon Sep 16 17:52:30 PDT 2002 -->
<TITLE>
DefaultJamesUser (James API)
</TITLE>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>