Spec-Zone .ru
спецификации, руководства, описания, API


javax.mail
Хранилище класса

java.lang.Object
  расширенный javax.mail.Service
      расширенный javax.mail.Store

public abstract class Store
расширяет Службу

Абстрактный class, который моделирует банк сообщений и его протокол доступа для хранения и получения сообщений. Подклассы обеспечивают фактические реализации.

Отметьте это Store расширяется Service class, который обеспечивает много общепринятых методик для того, чтобы они назвали хранилища, соединяясь с хранилищами, и слушая события соединения.

Автор:
Джон Мани, Билл Шеннон
См. Также:
Service, ConnectionEvent, StoreEvent

Полевая Сводка
 
Поля, наследованные от class javax.mail. Служба
debug, session, url
 
Сводка конструктора
protected Store(Session session, URLName urlname)
          Конструктор.
 
Сводка метода
 void addFolderListener(FolderListener l)
          Добавьте слушателя для событий Folder на любом объекте Папки, полученном из этого Хранилища.
 void addStoreListener(StoreListener l)
          Добавьте слушателя для StoreEvents на этом Хранилище.
abstract  Folder getDefaultFolder()
          Возвращает объект Папки, который представляет 'корень' пространства имен по умолчанию, представленного пользователю Хранилищем.
abstract  Folder getFolder(java.lang.String name)
          Возвратите соответствие объекта Папки имени.
abstract  Folder getFolder(URLName url)
          Возвратите закрытый объект Папки, соответствуя данному URLName.
 Папка[] getPersonalNamespaces()
          Возвратите ряд папок, представляющих персональные пространства имен для текущего пользователя.
 Папка[] getSharedNamespaces()
          Возвратите ряд папок, представляющих совместно используемые пространства имен.
 Папка[] getUserNamespaces(java.lang.String user)
          Возвратите ряд папок, представляющих пространства имен для user.
protected  void notifyFolderListeners(int type, Folder folder)
          Уведомьте весь FolderListeners.
protected  void notifyFolderRenamedListeners(Folder oldF, Folder newF)
          Уведомьте весь FolderListeners о переименовании папки.
protected  void notifyStoreListeners(int type, java.lang.String message)
          Уведомьте весь StoreListeners.
 void removeFolderListener(FolderListener l)
          Удалите слушателя для событий Folder.
 void removeStoreListener(StoreListener l)
          Удалите слушателя для событий Store.
 
Методы, наследованные от class javax.mail. Служба
addConnectionListener, close, connect, connect, connect, connect, finalize, getURLName, isConnected, notifyConnectionListeners, protocolConnect, queueEvent, removeConnectionListener, setConnected, setURLName, toString
 
Методы, наследованные от class java.lang. Объект
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Деталь конструктора

Хранилище

protected Store(Session session,
                URLName urlname)
Конструктор.

Параметры:
session - Объект сеанса для этого Хранилища.
urlname - URLName возражают, чтобы использоваться для этого Хранилища
Деталь метода

getDefaultFolder

public abstract Folder getDefaultFolder()
                                 throws MessagingException
Возвращает объект Папки, который представляет 'корень' пространства имен по умолчанию, представленного пользователю Хранилищем.

Возвраты:
корневая папка
Броски:
IllegalStateException - если это Хранилище не соединяется.
MessagingException

getFolder

public abstract Folder getFolder(java.lang.String name)
                          throws MessagingException
Возвратите соответствие объекта Папки имени. Отметьте, что объект Папки возвращается, даже если именованная папка физически не существует на Хранилище. exists() метод на объекте папки указывает, существует ли эта папка действительно.

Объекты папки не кэшируются Хранилищем, таким образом вызывая этот метод на то же самое имя многократно возвратит это много отличных объектов Папки.

Параметры:
name - Имя Папки. В некоторых Хранилищах имя может быть абсолютным путем, если оно запускается с разделителя иерархии. Еще это интерпретируется относительно 'корня' этого пространства имен.
Возвраты:
Объект папки
Броски:
IllegalStateException - если это Хранилище не соединяется.
MessagingException
См. Также:
Folder#exists, Folder#create

getFolder

public abstract Folder getFolder(URLName url)
                          throws MessagingException
Возвратите закрытый объект Папки, соответствуя данному URLName. Хранилище, определенное в данном URLName, должно обратиться к этому, Хранят объект.

Реализации этого метода могут получить имя фактической папки, используя getFile() метод на URLName, и использование, которые называют, чтобы создать папку.

Параметры:
url - URLName, который обозначает папку
Возвраты:
Объект папки
Броски:
IllegalStateException - если это Хранилище не соединяется.
MessagingException
См. Также:
URLName

getPersonalNamespaces

public Folder[] getPersonalNamespaces()
                               throws MessagingException
Возвратите ряд папок, представляющих персональные пространства имен для текущего пользователя. Персональное пространство имен является рядом имен, который рассматривают в пределах персонального контекста аутентифицируемого пользователя. Как правило, только у аутентифицируемого пользователя есть доступ к почтовым папкам в их персональном пространстве имен. Если ЯЩИК ДЛЯ ПРИЕМА СООБЩЕНИЙ существует для пользователя, это должно появиться в пределах персонального пространства имен пользователя. В типичном случае должно быть только одно персональное пространство имен для каждого пользователя в каждом Хранилище.

Эта реализация возвращает массив с единственной записью, содержащей возвращаемое значение getDefaultFolder метод. Подклассы должны переопределить этот метод, чтобы возвратить соответствующую информацию.

Возвраты:
массив объектов Папки
Броски:
IllegalStateException - если это Хранилище не соединяется.
MessagingException
С тех пор:
JavaMail 1.2

getUserNamespaces

public Folder[] getUserNamespaces(java.lang.String user)
                           throws MessagingException
Возвратите ряд папок, представляющих пространства имен для user. Возвращенные пространства имен представляют персональные пространства имен для пользователя. К почтовым папкам доступа в пространстве имен другого пользователя в настоящий момент аутентифицируемому пользователю нужно явно предоставить права доступа. Например, менеджеру свойственно предоставить их правам доступа секретаря к их почтовым папкам.

Эта реализация возвращает пустой массив. Подклассы должны переопределить этот метод, чтобы возвратить соответствующую информацию.

Возвраты:
массив объектов Папки
Броски:
IllegalStateException - если это Хранилище не соединяется.
MessagingException
С тех пор:
JavaMail 1.2

getSharedNamespaces

public Folder[] getSharedNamespaces()
                             throws MessagingException
Возвратите ряд папок, представляющих совместно используемые пространства имен. Совместно используемое пространство имен является пространством имен, которое состоит из почтовых папок, которые предназначаются, чтобы быть совместно использованными среди пользователей и не существуют в пределах персонального пространства имен пользователя.

Эта реализация возвращает пустой массив. Подклассы должны переопределить этот метод, чтобы возвратить соответствующую информацию.

Возвраты:
массив объектов Папки
Броски:
IllegalStateException - если это Хранилище не соединяется.
MessagingException
С тех пор:
JavaMail 1.2

addStoreListener

public void addStoreListener(StoreListener l)
Добавьте слушателя для StoreEvents на этом Хранилище.

Реализация по умолчанию, обеспеченная здесь, добавляет этого слушателя внутреннего списка StoreListeners.

Параметры:
l - события Listener for Store
См. Также:
StoreEvent

removeStoreListener

public void removeStoreListener(StoreListener l)
Удалите слушателя для событий Store.

Реализация по умолчанию, обеспеченная здесь, удаляет этого слушателя из внутреннего списка StoreListeners.

Параметры:
l - слушатель
См. Также:
addStoreListener(javax.mail.event.StoreListener)

notifyStoreListeners

protected void notifyStoreListeners(int type,
                                    java.lang.String message)
Уведомьте весь StoreListeners. Реализации хранилища, как ожидают, будут использовать этот метод, чтобы широковещательно передать StoreEvents.

Обеспеченная реализация по умолчанию ставит событие в очередь в очередь внутреннего события. Поток диспетчера события исключает события из очереди от очереди и диспетчеризирует их зарегистрированному StoreListeners. Отметьте, что диспетчеризация события происходит в отдельном потоке, таким образом избегая потенциальных проблем мертвой блокировки.


addFolderListener

public void addFolderListener(FolderListener l)
Добавьте слушателя для событий Folder на любом объекте Папки, полученном из этого Хранилища. FolderEvents поставляют FolderListeners на Папке, на которую влияют, так же как в FolderListeners на содержании Хранилища.

Реализация по умолчанию, обеспеченная здесь, добавляет этого слушателя внутреннего списка FolderListeners.

Параметры:
l - события Listener for Folder
См. Также:
FolderEvent

removeFolderListener

public void removeFolderListener(FolderListener l)
Удалите слушателя для событий Folder.

Реализация по умолчанию, обеспеченная здесь, удаляет этого слушателя из внутреннего списка FolderListeners.

Параметры:
l - слушатель
См. Также:
addFolderListener(javax.mail.event.FolderListener)

notifyFolderListeners

protected void notifyFolderListeners(int type,
                                     Folder folder)
Уведомьте весь FolderListeners. Реализации хранилища, как ожидают, будут использовать этот метод, чтобы широковещательно передать события Folder.

Обеспеченная реализация по умолчанию ставит событие в очередь в очередь внутреннего события. Поток диспетчера события исключает события из очереди от очереди и диспетчеризирует их зарегистрированному FolderListeners. Отметьте, что диспетчеризация события происходит в отдельном потоке, таким образом избегая потенциальных проблем мертвой блокировки.

Параметры:
type - тип FolderEvent
folder - Папка, на которую влияют,
См. Также:
notifyFolderRenamedListeners(javax.mail.Folder, javax.mail.Folder)

notifyFolderRenamedListeners

protected void notifyFolderRenamedListeners(Folder oldF,
                                            Folder newF)
Уведомьте весь FolderListeners о переименовании папки. Реализации хранилища, как ожидают, будут использовать этот метод, чтобы широковещательно передать события Folder, указывающие на переименование папок.

Обеспеченная реализация по умолчанию ставит событие в очередь в очередь внутреннего события. Поток диспетчера события исключает события из очереди от очереди и диспетчеризирует их зарегистрированному FolderListeners. Отметьте, что диспетчеризация события происходит в отдельном потоке, таким образом избегая потенциальных проблем мертвой блокировки.

Параметры:
oldF - переименовываемая папка
newF - папка, представляющая новое имя.
С тех пор:
JavaMail 1.1


Представьте ошибку или функцию

Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается срокам действия лицензии.

Сгенерированный на 10-February-2011 12:41

free hit counter