org.apache.james.mailbox
Interface MailboxSession

public interface MailboxSession

Mailbox session.

Nested Class Summary

static interface

MailboxSession.User A mailbox user.

Method Summary

void	close() Closes this session.
java.util.Map<java.lang.Object,java.lang.Object>	getAttributes() Return the stored attributes for this MailboxSession.
org.apache.commons.logging.Log	getLog() Gets the logger for this session context.
java.lang.String	getOtherUsersSpace() Gets the RFC 2342 other users namespace for the current session.
java.lang.String	getPersonalSpace() Gets the RFC 2342 personal namespace for the current session.
long	getSessionId() Gets the session ID.
java.util.Collection<java.lang.String>	getSharedSpaces() Iterates the RFC 2342 Shared Namespaces available for the current session.
MailboxSession.User	getUser() Gets the user executing this session.
boolean	isOpen() Is this session open?

Method Detail

getSessionId

long getSessionId()

Gets the session ID.

Returns:

session id

isOpen

boolean isOpen()

Is this session open?

Returns:

true if the session is open, false otherwise

close

void close()

Closes this session.

getLog

org.apache.commons.logging.Log getLog()

Gets the logger for this session context.

Returns:

not null

getUser

MailboxSession.User getUser()

Gets the user executing this session.

Returns:

not null

getPersonalSpace

java.lang.String getPersonalSpace()

Gets the RFC 2342 personal namespace for the current session. Note that though servers may offer multiple personal namespaces, support is not offered through this API. This decision may be revised if reasonable use cases emerge.

Returns:

Personal Namespace, not null

getOtherUsersSpace

java.lang.String getOtherUsersSpace()

Gets the RFC 2342 other users namespace for the current session. Note that though servers may offer multiple other users namespaces, support is not offered through this API. This decision may be revised if reasonable use cases emerge.

Returns:

Other Users Namespace or null when there is non available

getSharedSpaces

java.util.Collection<java.lang.String> getSharedSpaces()

Iterates the RFC 2342 Shared Namespaces available for the current session.

Returns:

not null though possibly empty

getAttributes

java.util.Map<java.lang.Object,java.lang.Object> getAttributes()

Return the stored attributes for this MailboxSession.

Returns:

attributes