com.openexchange.mail.attachment

Class AttachmentToken

java.lang.Object

com.openexchange.mail.attachment.AttachmentToken

All Implemented Interfaces:

AttachmentTokenConstants, java.io.Closeable, java.lang.AutoCloseable

public final class AttachmentToken
extends java.lang.Object
implements AttachmentTokenConstants, java.io.Closeable

AttachmentToken

Author:

Thorben Betten

Field Summary

Fields inherited from interface com.openexchange.mail.attachment.AttachmentTokenConstants

CLEANER_FREQUENCY, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AttachmentToken(long ttlMillis) Initializes a new AttachmentToken.

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentToken

public AttachmentToken(long ttlMillis)

Initializes a new AttachmentToken.

Method Detail

setOneTime

public AttachmentToken setOneTime(boolean oneTime)

Sets whether this token is a one-time token.

Parameters:

oneTime - true for one-time token; otherwise false

Returns:

This attachment token with new behavior applied

isOneTime

public boolean isOneTime()

Checks if this token is a one-time token.

Returns:

true for one-time token; otherwise false

isCheckIp

public boolean isCheckIp()

Gets the checkIp

Returns:

The checkIp

setCheckIp

public AttachmentToken setCheckIp(boolean checkIp)

Sets the checkIp

Parameters:

checkIp - The checkIp to set

Returns:

This attachment token with new behavior applied

getJSessionId

public java.lang.String getJSessionId()

Gets the JSESSIONID.

Returns:

The JSESSIONID

setAccessInfo

public AttachmentToken setAccessInfo(int accountId,
                            com.openexchange.session.Session session)

Sets the access information.

Parameters:

accountId - The account identifier

session - The session

Returns:

This token with access information applied

setAttachmentInfo

public AttachmentToken setAttachmentInfo(java.lang.String fullName,
                                java.lang.String mailId,
                                java.lang.String attachmentId)

Sets the attachment information.

Parameters:

mailId - The mail identifier

attachmentId - The attachment identifier

Returns:

This token with access attachment applied

touch

public AttachmentToken touch()

Touches this token.

Returns:

This token with elapse timeout reseted

getId

public java.lang.String getId()

Gets the token identifier.

Returns:

The token identifier

isExpired

public boolean isExpired()

Checks if this token is expired.

Returns:

true if this token is expired; otherwise false

getAttachment

public MailPart getAttachment()
                       throws com.openexchange.exception.OXException

Gets the associated attachment.

Note: After calling this method close() needs to be called!

Returns:

The associated attachment

Throws:

MailException

com.openexchange.exception.OXException

See Also:

#close()}

close

public void close()

Closes associated mail access (if opened)

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

getUserAgent

public java.lang.String getUserAgent()

Gets the user agent identifier.

Returns:

The user agent identifier

getClientIp

public java.lang.String getClientIp()

Gets the client IP address.

Returns:

The client IP address

getClient

public java.lang.String getClient()

Gets the client

Returns:

The client

getSessionId

public java.lang.String getSessionId()

Gets the session identifier

Returns:

The session identifier

getContextId

public int getContextId()

Gets the contextId

Returns:

The contextId

getUserId

public int getUserId()

Gets the userId

Returns:

The userId