|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EmailTokenManager
Manages email tokens. Email tokens are set in emails sent from forums so that user authentication can be performed on reply emails. Implementors of this interface handle the token creation and encoding, parsing, and lookup of parsed user data.
Method Summary | |
---|---|
java.lang.String |
getMessageToken(long userID,
long messageID)
Uses the supplied user id and message id to build a token string which can be used to identify and authenticate that user and message. |
java.util.regex.Pattern |
getTokenPattern()
Returns a Pattern which matches any email token generated
by this EmailTokenManager instance. |
long[] |
getUserAndMessageID(java.lang.String messageToken)
Uses the supplied token string to lookup a user id and forums message id. |
long |
getUserID(java.lang.String messageToken)
Returns just the user id as found in the supplied token string. |
Methods inherited from interface com.jivesoftware.base.JiveManager |
---|
destroy, initialize |
Method Detail |
---|
java.lang.String getMessageToken(long userID, long messageID) throws EmailMonitorException
userID
- the user id to encode.messageID
- the message id to encode.
EmailMonitorException
- if an attempt to create a new token fails.long[] getUserAndMessageID(java.lang.String messageToken) throws EmailMonitorException
messageToken
- the token containing encoded data.
EmailMonitorException
- if an the token does not correspond to an existing user or message id or if the token
has expirec.long getUserID(java.lang.String messageToken)
messageToken
- the token string to search for a user id.
java.util.regex.Pattern getTokenPattern()
Pattern
which matches any email token generated
by this EmailTokenManager instance.
Pattern
which matches any email token generated
by this EmailTokenManager instance.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |