public final class AttachmentToken extends java.lang.Object implements AttachmentTokenConstants, java.io.Closeable
CLEANER_FREQUENCY, DEFAULT_TIMEOUT
Constructor and Description |
---|
AttachmentToken(long ttlMillis)
Initializes a new
AttachmentToken . |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes associated mail access (if opened)
|
MailPart |
getAttachment()
Gets the associated attachment.
|
java.lang.String |
getClient()
Gets the client
|
java.lang.String |
getClientIp()
Gets the client IP address.
|
int |
getContextId()
Gets the contextId
|
java.lang.String |
getId()
Gets the token identifier.
|
java.lang.String |
getJSessionId()
Gets the JSESSIONID.
|
java.lang.String |
getSessionId()
Gets the session identifier
|
java.lang.String |
getUserAgent()
Gets the user agent identifier.
|
int |
getUserId()
Gets the userId
|
boolean |
isCheckIp()
Gets the checkIp
|
boolean |
isExpired()
Checks if this token is expired.
|
boolean |
isOneTime()
Checks if this token is a one-time token.
|
AttachmentToken |
setAccessInfo(int accountId,
com.openexchange.session.Session session)
Sets the access information.
|
AttachmentToken |
setAttachmentInfo(java.lang.String fullName,
java.lang.String mailId,
java.lang.String attachmentId)
Sets the attachment information.
|
AttachmentToken |
setCheckIp(boolean checkIp)
Sets the checkIp
|
AttachmentToken |
setOneTime(boolean oneTime)
Sets whether this token is a one-time token.
|
AttachmentToken |
touch()
Touches this token.
|
public AttachmentToken(long ttlMillis)
AttachmentToken
.public AttachmentToken setOneTime(boolean oneTime)
oneTime
- true
for one-time token; otherwise false
public boolean isOneTime()
true
for one-time token; otherwise false
public boolean isCheckIp()
public AttachmentToken setCheckIp(boolean checkIp)
checkIp
- The checkIp to setpublic java.lang.String getJSessionId()
public AttachmentToken setAccessInfo(int accountId, com.openexchange.session.Session session)
accountId
- The account identifiersession
- The sessionpublic AttachmentToken setAttachmentInfo(java.lang.String fullName, java.lang.String mailId, java.lang.String attachmentId)
mailId
- The mail identifierattachmentId
- The attachment identifierpublic AttachmentToken touch()
public java.lang.String getId()
public boolean isExpired()
true
if this token is expired; otherwise false
public MailPart getAttachment() throws com.openexchange.exception.OXException
Note: After calling this method close()
needs to be called!
MailException
com.openexchange.exception.OXException
#close()}
public void close()
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
public java.lang.String getUserAgent()
public java.lang.String getClientIp()
public java.lang.String getClient()
public java.lang.String getSessionId()
public int getContextId()
public int getUserId()