| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Session session = …;
String session = …;
Store store = session.getStore(session);
Based on 60 examples
public abstract class Store extends Service
An abstract class that models a message store and its access protocol, for storing and retrieving messages. Subclasses provide actual implementations.
Note that Store
extends the Service
class, which provides many common methods for naming stores,
connecting to stores, and listening to connection events.
Field Summary |
---|
Fields inherited from class javax.mail.Service |
---|
debug, session, url |
Constructor Summary | |
---|---|
protected |
Constructor. |
Method Summary | |
---|---|
void |
Add a listener for Folder events on any Folder object obtained from this Store. |
void |
Add a listener for StoreEvents on this Store. |
abstract Folder |
Returns a Folder object that represents the 'root' of the default namespace presented to the user by the Store. |
abstract Folder |
Return the Folder object corresponding to the given name. |
abstract Folder |
Return a closed Folder object, corresponding to the given URLName. |
Folder[] |
Return a set of folders representing the personal namespaces for the current user. |
Folder[] |
Return a set of folders representing the shared namespaces. |
Folder[] |
getUserNamespaces(String user) Return a set of folders representing the namespaces for user .
|
protected void |
notifyFolderListeners(int type, Folder folder) Notify all FolderListeners. |
protected void |
notifyFolderRenamedListeners(Folder oldF, Folder newF) Notify all FolderListeners about the renaming of a folder. |
protected void |
notifyStoreListeners(int type, String message) Notify all StoreListeners. |
void |
Remove a listener for Folder events. |
void |
Remove a listener for Store events. |
Methods inherited from class javax.mail.Service |
---|
addConnectionListener, close, connect, connect, connect, connect, finalize, getURLName, isConnected, notifyConnectionListeners, protocolConnect, queueEvent, removeConnectionListener, setConnected, setURLName, toString |
Constructor Detail |
---|
protected Store(Session session, URLName urlname)
session
- Session object for this Store.urlname
- URLName object to be used for this StoreMethod Detail |
---|
public synchronized void addFolderListener(FolderListener l)
The default implementation provided here adds this listener to an internal list of FolderListeners.
l
- the Listener for Folder eventspublic synchronized void addStoreListener(StoreListener l)
The default implementation provided here adds this listener to an internal list of StoreListeners.
l
- the Listener for Store eventspublic abstract Folder getDefaultFolder() throws MessagingException
MessagingException
public abstract Folder getFolder(String name) throws MessagingException
exists()
method on the folder object indicates whether this folder really
exists. Folder objects are not cached by the Store, so invoking this method on the same name multiple times will return that many distinct Folder objects.
name
- The name of the Folder. In some Stores, name can
be an absolute path if it starts with the
hierarchy delimiter. Else it is interpreted
relative to the 'root' of this namespace.MessagingException
public abstract Folder getFolder(URLName url) throws MessagingException
Implementations of this method may obtain the name of the
actual folder using the getFile()
method on
URLName, and use that name to create the folder.
url
- URLName that denotes a folderMessagingException
public Folder[] getPersonalNamespaces() throws MessagingException
This implementation returns an array with a single entry containing
the return value of the getDefaultFolder
method.
Subclasses should override this method to return appropriate information.
MessagingException
public Folder[] getSharedNamespaces() throws MessagingException
This implementation returns an empty array. Subclasses should override this method to return appropriate information.
MessagingException
public Folder[] getUserNamespaces(String user) throws MessagingException
user
. The namespaces returned represent the
personal namespaces for the user. To access mail folders in the
other user's namespace, the currently authenticated user must be
explicitly granted access rights. For example, it is common for
a manager to grant to their secretary access rights to their
mail folders. This implementation returns an empty array. Subclasses should override this method to return appropriate information.
user
MessagingException
protected void notifyFolderListeners(int type, Folder folder)
The provided default implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered FolderListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.
type
- type of FolderEventfolder
- affected Folderprotected void notifyFolderRenamedListeners(Folder oldF, Folder newF)
The provided default implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered FolderListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.
oldF
- the folder being renamednewF
- the folder representing the new name.protected void notifyStoreListeners(int type, String message)
The provided default implementation queues the event into an internal event queue. An event dispatcher thread dequeues events from the queue and dispatches them to the registered StoreListeners. Note that the event dispatching occurs in a separate thread, thus avoiding potential deadlock problems.
type
message
public synchronized void removeFolderListener(FolderListener l)
The default implementation provided here removes this listener from the internal list of FolderListeners.
l
- the listenerpublic synchronized void removeStoreListener(StoreListener l)
The default implementation provided here removes this listener from the internal list of StoreListeners.
l
- the listener
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |