org.apache.james.mailbox.store

Class SimpleMailboxSession

java.lang.Object

org.apache.james.mailbox.store.SimpleMailboxSession

All Implemented Interfaces:

MailboxSession, MailboxSession.User

public class SimpleMailboxSession
extends Object
implements MailboxSession, MailboxSession.User

Describes a mailbox session.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.MailboxSession

MailboxSession.SessionType, MailboxSession.User

Field Summary

Fields inherited from interface org.apache.james.mailbox.MailboxSession

SYSTEM_SESSION_ID

Constructor Summary

Constructors

Constructor and Description
SimpleMailboxSession(long sessionId, String userName, String password, org.slf4j.Logger log, List<Locale> localePreferences, char pathSeparator, MailboxSession.SessionType type)
SimpleMailboxSession(long sessionId, String userName, String password, org.slf4j.Logger log, List<Locale> localePreferences, List<String> sharedSpaces, String otherUsersSpace, char pathSeparator, MailboxSession.SessionType type)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this session.
Map<Object,Object>	getAttributes() Return the stored attributes for this MailboxSession.
List<Locale>	getLocalePreferences() Gets acceptable localisation for this user in preference order. When localising a phrase, each Locale should be tried in order until an appropriate translation is obtained.
org.slf4j.Logger	getLog() Gets the logger for this session context.
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.
String	getPassword() Return the Password for the logged in user
char	getPathDelimiter() Return server side, folder path separator
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.
long	getSessionId() Gets the session ID.
Collection<String>	getSharedSpaces() Iterates the RFC 2342 Shared Namespaces available for the current session.
MailboxSession.SessionType	getType() Return if the MailboxSession is of type MailboxSession.SessionType.User or MailboxSession.SessionType.System
MailboxSession.User	getUser() Gets the user executing this session.
String	getUserName() Gets the name of the user executing this session.
boolean	isOpen() Is this session open?
String	toString() Renders suitably for logging.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleMailboxSession

public SimpleMailboxSession(long sessionId,
                    String userName,
                    String password,
                    org.slf4j.Logger log,
                    List<Locale> localePreferences,
                    char pathSeparator,
                    MailboxSession.SessionType type)

SimpleMailboxSession

public SimpleMailboxSession(long sessionId,
                    String userName,
                    String password,
                    org.slf4j.Logger log,
                    List<Locale> localePreferences,
                    List<String> sharedSpaces,
                    String otherUsersSpace,
                    char pathSeparator,
                    MailboxSession.SessionType type)

Method Detail

getLog

public org.slf4j.Logger getLog()

Description copied from interface: MailboxSession

Gets the logger for this session context.

Specified by:

getLog in interface MailboxSession

Returns:

not null

See Also:

MailboxSession.getLog()

close

public void close()

Description copied from interface: MailboxSession

Closes this session.

Specified by:

close in interface MailboxSession

See Also:

MailboxSession.close()

getSessionId

public long getSessionId()

Description copied from interface: MailboxSession

Gets the session ID.

Specified by:

getSessionId in interface MailboxSession

Returns:

session id

See Also:

MailboxSession.getSessionId()

isOpen

public boolean isOpen()

Description copied from interface: MailboxSession

Is this session open?

Specified by:

isOpen in interface MailboxSession

Returns:

true if the session is open, false otherwise

See Also:

MailboxSession.isOpen()

toString

public String toString()

Renders suitably for logging.

Overrides:

toString in class Object

Returns:

a String representation of this object.

getUser

public MailboxSession.User getUser()

Gets the user executing this session.

Specified by:

getUser in interface MailboxSession

Returns:

not null

getUserName

public String getUserName()

Gets the name of the user executing this session.

Specified by:

getUserName in interface MailboxSession.User

Returns:

not null

getOtherUsersSpace

public String getOtherUsersSpace()

Description copied from interface: MailboxSession

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.

Specified by:

getOtherUsersSpace in interface MailboxSession

Returns:

Other Users Namespace or null when there is non available

See Also:

MailboxSession.getOtherUsersSpace()

getPersonalSpace

public String getPersonalSpace()

Description copied from interface: MailboxSession

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.

Specified by:

getPersonalSpace in interface MailboxSession

Returns:

Personal Namespace, not null

See Also:

MailboxSession.getPersonalSpace()

getSharedSpaces

public Collection<String> getSharedSpaces()

Description copied from interface: MailboxSession

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

Specified by:

getSharedSpaces in interface MailboxSession

Returns:

not null though possibly empty

See Also:

MailboxSession.getSharedSpaces()

getLocalePreferences

public List<Locale> getLocalePreferences()

Description copied from interface: MailboxSession.User

Gets acceptable localisation for this user in preference order.
When localising a phrase, each Locale should be tried in order until an appropriate translation is obtained.

Specified by:

getLocalePreferences in interface MailboxSession.User

Returns:

not null, when empty the default local should be used

See Also:

MailboxSession.User.getLocalePreferences()

getAttributes

public Map<Object,Object> getAttributes()

Description copied from interface: MailboxSession

Return the stored attributes for this MailboxSession.

Specified by:

getAttributes in interface MailboxSession

Returns:

attributes

See Also:

MailboxSession.getAttributes()

getPassword

public String getPassword()

Description copied from interface: MailboxSession.User

Return the Password for the logged in user

Specified by:

getPassword in interface MailboxSession.User

Returns:

password

See Also:

MailboxSession.User.getPassword()

getPathDelimiter

public char getPathDelimiter()

Description copied from interface: MailboxSession

Return server side, folder path separator

Specified by:

getPathDelimiter in interface MailboxSession

Returns:

path separator

See Also:

MailboxSession.getPathDelimiter()

getType

public MailboxSession.SessionType getType()

Description copied from interface: MailboxSession

Return if the MailboxSession is of type MailboxSession.SessionType.User or MailboxSession.SessionType.System

Specified by:

getType in interface MailboxSession

Returns:

type

See Also:

MailboxSession.getType()