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

javax.mail
Служба класса

java.lang.Object
  javax.mail.Service

Прямые Известные Подклассы:

Хранилище, Транспорт

public abstract class Service
расширяет java.lang. Объект

Абстрактный class, который содержит функциональность, характерную для служб обмена сообщениями, таких как хранилища и транспорты.

Служба обмена сообщениями создается из a Session и называется, используя a URLName. Служба должна быть соединена прежде, чем она сможет использоваться. События соединения отправляются, чтобы отразить его состояние соединения.

Автор:

Кристофер Коттон, Билл Шеннон, Kanwar Oberoi

Полевая Сводка

protected boolean	отладка Флаг отладки для этой службы.
protected Session	сеанс Сеанс, из которого создавалась эта служба.
protected URLName	url URLName из этой службы.

Сводка конструктора

protected

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

Сводка метода

void	addConnectionListener(ConnectionListener l) Добавьте слушателя для событий Connection на этой службе.
void	close() Закройте эту службу и завершите ее соединение.
void	connect() Обобщение соединяет метод, который не берет параметров.
void	connect(java.lang.String host, int port, java.lang.String user, java.lang.String password) Подобный, чтобы соединить (узел, пользователя, пароль) кроме определенного порта может быть определен.
void	connect(java.lang.String user, java.lang.String password) Соединитесь с текущим узлом, используя указанное имя пользователя и пароль.
void	connect(java.lang.String host, java.lang.String user, java.lang.String password) Соединитесь с указанным адресом.
protected void	finalize() Остановите поток диспетчера события, таким образом, очередь может быть собрана "мусор".
URLName	getURLName() Возвратите URLName, представляющий эту службу.
boolean	isConnected() Эта служба в настоящий момент соединяется?
protected void	notifyConnectionListeners(int type) Уведомьте весь ConnectionListeners.
protected boolean	protocolConnect(java.lang.String host, int port, java.lang.String user, java.lang.String password) Реализация службы должна переопределить этот метод, чтобы выполнить фактическую специфичную для протокола попытку подключения.
protected void	queueEvent(MailEvent event, java.util.Vector vector) Добавьте событие и вектор слушателей очереди, чтобы быть поставленными.
void	removeConnectionListener(ConnectionListener l) Удалите слушателя события Connection.
protected void	setConnected(boolean connected) Установите состояние соединения этой службы.
protected void	setURLName(URLName url) Установите URLName, представляющий эту службу.
java.lang.String	toString() Возвратиться getURLName.toString() если у этой службы будет URLName, то иначе она возвратит значение по умолчанию toString.

Методы, наследованные от class java.lang. Объект

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

Полевая Деталь

сеанс

protected Session session

Сеанс, из которого создавалась эта служба.

url

protected URLName url

URLName из этой службы.

отладка

protected boolean debug

Флаг отладки для этой службы. Набор от отладки сеанса отмечает, когда эта служба создается.

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

Служба

protected Service(Session session,
                  URLName urlname)

Конструктор.

Параметры:

session - Объект сеанса для этой службы

urlname - URLName возражают, чтобы использоваться для этой службы

Деталь метода

соединиться

public void connect()
             throws MessagingException

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

Если соединение успешно, "открытое" ConnectionEvent поставляется любому ConnectionListeners на этой службе.

Большинство клиентов должно только вызвать этот метод, чтобы соединиться со службой.

Это - ошибка соединиться с уже соединенной службой.

Реализация, обеспеченная здесь просто, вызывает следующий connect(String, String, String) метод с нулями.

Броски:

AuthenticationFailedException - для отказов аутентификации

MessagingException - для других отказов

IllegalStateException - если служба уже соединяется

См. Также:

ConnectionEvent

соединиться

public void connect(java.lang.String host,
                    java.lang.String user,
                    java.lang.String password)
             throws MessagingException

Соединитесь с указанным адресом. Этот метод обеспечивает простую схему аутентификации, которая требует имени пользователя и пароля.

Если соединение успешно, "открытое" ConnectionEvent поставляется любому ConnectionListeners на этой службе.

Это - ошибка соединиться с уже соединенной службой.

Реализация в Службе class соберет значения по умолчанию для узла, пользователя, и пароля от сеанса, от URLName для этой службы, и от предоставленных параметров и затем вызывают protocolConnect метод. Если protocolConnect возвраты метода false, пользователь будет запрошен любую недостающую информацию и protocolConnect метод вызовут снова. Подкласс должен переопределить protocolConnect метод. Подкласс должен также реализовать getURLName метод, или использование реализация в этом class.

На успешном соединении, setURLName метод вызывают с URLName, который включает информацию, используемую, чтобы сделать соединение, включая пароль.

Если имя пользователя, которое передают в, будет нулем, то значение по умолчанию будет выбрано как описано выше. Если пароль, который передают в, будет нулем, и это - первое успешное соединение с этой службой, то имя пользователя и пароль, собранный от пользователя, будут сохранены как значения по умолчанию для последующих попыток подключения к этой той же самой службе при использовании других экземпляров объекта Службы (информация о соединении обычно всегда сохраняется в пределах определенного экземпляра объекта Службы). Пароль сохраняется, используя метод Session setPasswordAuthentication. Если пароль, который передают в, не является нулем, он не сохраняется, при условии, что приложение управляет паролями явно.

Параметры:

host - узел, чтобы соединиться с

user - имя пользователя

password - пароль этого пользователя

Броски:

AuthenticationFailedException - для отказов аутентификации

MessagingException - для других отказов

IllegalStateException - если служба уже соединяется

См. Также:

ConnectionEvent, Session.setPasswordAuthentication(javax.mail.URLName, javax.mail.PasswordAuthentication)

соединиться

public void connect(java.lang.String user,
                    java.lang.String password)
             throws MessagingException

Соединитесь с текущим узлом, используя указанное имя пользователя и пароль. Этот метод эквивалентен вызову connect(host, user, password) метод с нулем для имени хоста.

Параметры:

user - имя пользователя

password - пароль этого пользователя

Броски:

AuthenticationFailedException - для отказов аутентификации

MessagingException - для других отказов

IllegalStateException - если служба уже соединяется

С тех пор:

JavaMail 1.4

См. Также:

ConnectionEvent, Session.setPasswordAuthentication(javax.mail.URLName, javax.mail.PasswordAuthentication), connect(java.lang.String, java.lang.String, java.lang.String)

соединиться

public void connect(java.lang.String host,
                    int port,
                    java.lang.String user,
                    java.lang.String password)
             throws MessagingException

Подобный, чтобы соединить (узел, пользователя, пароль) кроме определенного порта может быть определен.

Параметры:

host - узел, чтобы соединиться с

port - порт, чтобы соединиться с (-1 означает порт значения по умолчанию),

user - имя пользователя

password - пароль этого пользователя

Броски:

AuthenticationFailedException - для отказов аутентификации

MessagingException - для других отказов

IllegalStateException - если служба уже соединяется

См. Также:

connect(java.lang.String, java.lang.String, java.lang.String), ConnectionEvent

protocolConnect

protected boolean protocolConnect(java.lang.String host,
                                  int port,
                                  java.lang.String user,
                                  java.lang.String password)
                           throws MessagingException

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

protocolConnect метод должен возвратиться false если имя пользователя или пароль требуются для аутентификации, но соответствующий параметр является нулем; connect метод запросит пользователя при необходимости предоставлять недостающую информацию. Этот метод может также возвратиться false если аутентификация перестала работать для предоставленного имени пользователя или пароля. Альтернативно, этот метод может бросить AuthenticationFailedException, когда аутентификация перестала работать. Это исключение может включать Строковое сообщение с большим количеством детали об отказе.

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

Параметры:

host - имя узла, чтобы соединиться с

port - порт, чтобы использовать (-1 средство использует порт значения по умолчанию),

user - имя пользователя, чтобы войти в систему как

password - пароль пользователя

Возвраты:

истина, если соединение, успешное, ложное, если аутентификация перестала работать

Броски:

AuthenticationFailedException - для отказов аутентификации

MessagingException - для отказов неаутентификации

isConnected

public boolean isConnected()

Эта служба в настоящий момент соединяется?

Эта реализация использует частное булево поле, чтобы сохранить состояние соединения. Этот метод возвращает значение того поля.

Подклассы могут хотеть переопределить этот метод, чтобы проверить, что любое соединение с банком сообщений все еще живо.

Возвраты:

истина, если служба соединяется, ложь, если это не соединяется

setConnected

protected void setConnected(boolean connected)

Установите состояние соединения этой службы. Состояние соединения будет автоматически установлено реализацией службы во время connect и close методы. Подклассы должны будут вызвать этот метод, чтобы установить состояние, если служба была автоматически разъединена.

Реализация в этом class просто устанавливает частное поле, возвращенное isConnected метод.

Параметры:

connected - истина, если служба соединяется, ложь, если это не соединяется

близко

public void close()
           throws MessagingException

Закройте эту службу и завершите ее соединение. Близкий ConnectionEvent поставляют любому ConnectionListeners. Любые компоненты Обмена сообщениями (Папки, сообщения, и т.д.) принадлежащий этой службе недопустимы после того, как эта служба закрывается. Отметьте, что служба закрывается, даже если этот метод завершается неправильно, бросая MessagingException.

Эта реализация использование setConnected(false) установить соединенное состояние этой службы в false. Это тогда передастся, близкий ConnectionEvent любому зарегистрировал ConnectionListeners. Подклассы, переопределяющие этот метод, чтобы сделать реализацию определенная уборка, должны вызвать этот метод как последний шаг, чтобы обеспечить уведомление о событии, вероятно включением звонка super.close() в a finally пункт.

Броски:

MessagingException - для ошибок, закрываясь

См. Также:

ConnectionEvent

getURLName

public URLName getURLName()

Возвратите URLName, представляющий эту службу. Возвращенный URLName не включает поле пароля.

Подклассы должны только переопределить этот метод, если их URLName не следует за стандартным форматом.

Реализация в Службе возвраты class (обычно копия) url поле с паролем и информацией о файле, разделенной.

Возвраты:

URLName, представляющий эту службу

См. Также:

URLName

setURLName

protected void setURLName(URLName url)

Установите URLName, представляющий эту службу. Обычно используемый, чтобы обновить url поле после службы успешно соединилось.

Подклассы должны только переопределить этот метод, если их URL не следует за стандартным форматом. В частности подклассы должны переопределить этот метод, если их URL не требует всех возможных полей, поддерживаемых URLName; новое URLName должен быть создан с любыми ненужными удаленными полями.

Реализация в Службе class просто устанавливает url поле.

См. Также:

URLName

addConnectionListener

public void addConnectionListener(ConnectionListener l)

Добавьте слушателя для событий Connection на этой службе.

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

Параметры:

l - события Listener for Connection

См. Также:

ConnectionEvent

removeConnectionListener

public void removeConnectionListener(ConnectionListener l)

Удалите слушателя события Connection.

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

Параметры:

l - слушатель

См. Также:

addConnectionListener(javax.mail.event.ConnectionListener)

notifyConnectionListeners

protected void notifyConnectionListeners(int type)

Уведомьте весь ConnectionListeners. Реализации службы, как ожидают, будут использовать этот метод для событий широковещательной связи.

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

toString

public java.lang.String toString()

Возвратиться getURLName.toString() если у этой службы будет URLName, то иначе она возвратит значение по умолчанию toString.

Переопределения:

toString в class java.lang.Object

queueEvent

protected void queueEvent(MailEvent event,
                          java.util.Vector vector)

Добавьте событие и вектор слушателей очереди, чтобы быть поставленными.

завершить

protected void finalize()
                 throws java.lang.Throwable

Остановите поток диспетчера события, таким образом, очередь может быть собрана "мусор".

Переопределения:

finalize в class java.lang.Object

Броски:

java.lang.Throwable