public interface User
A User which is stored, along with his or her
associated Subscription
s, in a UserDatabase
.
Modifier and Type | Method and Description |
---|---|
Subscription |
createSubscription(java.lang.String host)
Create and return a new
Subscription associated with this
User, for the specified host name. |
Subscription |
findSubscription(java.lang.String host)
Find and return the
Subscription associated with the specified
host. |
UserDatabase |
getDatabase()
Return the
UserDatabase with which we are associated. |
java.lang.String |
getFromAddress()
Return the from address.
|
java.lang.String |
getFullName()
Return the full name.
|
java.lang.String |
getPassword()
Return the password.
|
java.lang.String |
getReplyToAddress()
Return the reply-to address.
|
Subscription[] |
getSubscriptions()
Find and return all
Subscription s associated with this user. |
java.lang.String |
getUsername()
Return the username.
|
void |
removeSubscription(Subscription subscription)
Remove the specified
Subscription from being associated
with this User. |
void |
setFromAddress(java.lang.String fromAddress)
Set the from address.
|
void |
setFullName(java.lang.String fullName)
Set the full name.
|
void |
setPassword(java.lang.String password)
Set the password.
|
void |
setReplyToAddress(java.lang.String replyToAddress)
Set the reply-to address.
|
UserDatabase getDatabase()
UserDatabase
with which we are associated.java.lang.String getFromAddress()
void setFromAddress(java.lang.String fromAddress)
fromAddress
- The new from addressjava.lang.String getFullName()
void setFullName(java.lang.String fullName)
fullName
- The new full namejava.lang.String getPassword()
void setPassword(java.lang.String password)
password
- The new passwordjava.lang.String getReplyToAddress()
void setReplyToAddress(java.lang.String replyToAddress)
replyToAddress
- The new reply-to addressSubscription[] getSubscriptions()
Subscription
s associated with this user.
If there are none, a zero-length array is returned.java.lang.String getUsername()
Subscription createSubscription(java.lang.String host)
Subscription
associated with this
User, for the specified host name.host
- Host name for which to create a subscriptionjava.lang.IllegalArgumentException
- if the host name is not unique
for this userSubscription findSubscription(java.lang.String host)
Subscription
associated with the specified
host. If none is found, return null
.host
- Host name to look upvoid removeSubscription(Subscription subscription)
Subscription
from being associated
with this User.subscription
- Subscription to be removedjava.lang.IllegalArgumentException
- if the specified subscription is not
associated with this UserCopyright © 2000–2023 Apache Software Foundation. All rights reserved.