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

javax.security.auth.message.config
Класс AuthConfigFactory

java.lang.Object
  javax.security.auth.message.config.AuthConfigFactory

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

Этот class используется, чтобы получить AuthConfigProvider объекты, которые могут использоваться, чтобы получить объекты конфигурации контекста аутентификации, то есть, ClientAuthConfig и ServerAuthConfig объекты.

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

Вызывающие стороны не работают на модулях непосредственно. Вместо этого они полагаются на контекст аутентификации, чтобы управлять вызовом модулей. Вызывающая сторона получает контекст аутентификации, вызывая getAuthContext метод на a ClientAuthConfig или ServerAuthConfig полученный из AuthConfigProvider.

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

1. Фабрика AuthConfigFactory = AuthConfigFactory.getFactory ();
2. Провайдер AuthConfigProvider = factory.getConfigProvider (уровень, appID, слушатель);
3. Конфигурация ClientAuthConfig = provider.getClientAuthConfig (уровень, appID, cbh)
4. Представьте authContextID в виде строки = config.getAuthContextID (messageInfo);
5. Контекст ClientAuthContext = config.getAuthContext (authContextID, предмет, свойства);
6. context.secureRequest (messageInfo, предмет);

Реализация AuthConfigFactory в масштабе всей системы может быть установлена, вызывая setFactory, и полученное использование getFactory.

Каждая реализация этого абстрактного class должна предложить общедоступному, нулевому конструктору параметра. Этот конструктор должен поддерживать конструкцию и регистрацию (включая саморегистрацию) AuthConfigProviders от персистентного декларативного представления. Например, реализация фабрики class могла интерпретировать содержание файла, содержащего последовательность записей конфигурации с одной записью на AuthConfigProvider, и с каждым представлением записи:

• Полностью определенное имя реализации провайдера class (или нуль)
• Список свойств инициализации провайдера (который мог быть пустым),

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

Синтаксис записи должен также предусмотреть дополнительное включение информации, достаточной, чтобы определить RegistrationContext. Эта информация только присутствовала бы, когда фабрика зарегистрирует провайдера. Например, каждая запись могла предусмотреть включение одного или более объектов RegistrationContext следующей формы:

• Имя уровня сообщения (или нуль)
• Идентификатор контекста приложения (или нуль)
• Регистрационное описание (или нуль)

Когда RegistrationContext не включается, фабрика должна сделать его удобным для провайдера, чтобы самозарегистрироваться в фабрике во время конструкции провайдера (см. registerConfigProvider(AuthConfigProvider provider, ...)).

Реализация AuthConfigFactory свободна выбрать, собственный персистентный декларативный синтаксис, пока это соответствует требованиям, определенным этим class.

Версия:

% %I, %G %

См. Также:

ClientAuthContext, ServerAuthContext, ClientAuthConfig, ServerAuthConfig, Properties

Вложенная Сводка Класса

static interface

AuthConfigFactory. RegistrationContext Представляет идентификатор уровня, идентификатор контекста приложения, и компоненты описания регистрации AuthConfigProvider на фабрике.

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

static java.lang.String

DEFAULT_FACTORY_SECURITY_PROPERTY Имя свойства Security, используемого, чтобы определить значение по умолчанию реализация AuthConfigFactory class.

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

AuthConfigFactory()

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

abstract java.lang.String[]	detachListener(RegistrationListener listener, java.lang.String layer, java.lang.String appContext) Разъедините слушателя со всей регистрацией провайдера, уровень которой и значения appContext являются соответствующими соответствующими параметрами этому методу.
abstract AuthConfigProvider	getConfigProvider(java.lang.String layer, java.lang.String appContext, RegistrationListener listener) Получите зарегистрированный AuthConfigProvider от фабрики.
static AuthConfigFactory	getFactory() Получите реализацию AuthConfigFactory в масштабе всей системы.
abstract AuthConfigFactory.RegistrationContext	getRegistrationContext(java.lang.String registrationID) Получите регистрационный контекст для идентифицированной регистрации.
abstract java.lang.String[]	getRegistrationIDs(AuthConfigProvider provider) Получите регистрационные идентификаторы для всей регистрации экземпляра провайдера на фабрике.
abstract void	refresh() Заставьте фабрику повторно обрабатывать свое persisent декларативное представление регистрации провайдера.
abstract java.lang.String	registerConfigProvider(AuthConfigProvider provider, java.lang.String layer, java.lang.String appContext, java.lang.String description) Регистры в пределах фабрики (в памяти), провайдера ServerAuthConfig и/или ClientAuthConfig возражают для уровня сообщения и идентификатора контекста приложения.
abstract java.lang.String	registerConfigProvider(java.lang.String className, java.util.Map properties, java.lang.String layer, java.lang.String appContext, java.lang.String description) Регистры в пределах фабрики и записи в пределах персистентного декларативного представления фабрики регистрации провайдера провайдер ServerAuthConfig и/или ClientAuthConfig возражают для уровня сообщения и идентификатора контекста приложения.
abstract boolean	removeRegistration(java.lang.String registrationID) Удалите идентифицированную регистрацию провайдера из фабрики (и из персистентного декларативного представления регистрации провайдера, если соответствующий), и вызовите любых слушателей, связанных с удаленной регистрацией.
static void	setFactory(AuthConfigFactory factory) Установите реализацию AuthConfigFactory в масштабе всей системы.

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

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

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

DEFAULT_FACTORY_SECURITY_PROPERTY

public static final java.lang.String DEFAULT_FACTORY_SECURITY_PROPERTY

Имя свойства Security, используемого, чтобы определить значение по умолчанию реализация AuthConfigFactory class.

См. Также:

Постоянные Значения полей

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

AuthConfigFactory

public AuthConfigFactory()

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

getFactory

public static AuthConfigFactory getFactory()

Получите реализацию AuthConfigFactory в масштабе всей системы.

Если ненулевой экземпляр фабрики в масштабе всей системы определяется во время вызова, например, с setFactory, это будет возвращено. Иначе, попытка будет предпринята, чтобы создать экземпляр значения по умолчанию реализация AuthConfigFactory class. Полностью определенное имя class реализации фабрики значения по умолчанию class получается из значения authconfigprovider.factory свойства безопасности. Когда экземпляр реализации фабрики значения по умолчанию, class успешно создается этим методом, этот метод, установит это как экземпляр фабрики в масштабе всей системы.

Абсолютный путь файла свойств безопасности Java является JAVA_HOME/lib/security/java.security, где JAVA_HOME ссылается на каталог, где JDK был установлен.

Возвраты:

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

Броски:

AuthException - Если ошибка произошла во время загрузки class, или конструкции значения по умолчанию реализация AuthConfigFactory class.

SecurityException - Если у вызывающей стороны нет разрешения, чтобы получить фабрику, или установить это как экземпляр в масштабе всей системы.

setFactory

public static void setFactory(AuthConfigFactory factory)

Установите реализацию AuthConfigFactory в масштабе всей системы.

Если реализация была установлена ранее, она будет заменена.

Слушатели не уведомляются относительно изменения к зарегистрированной фабрике.

Параметры:

factory - Экземпляр AuthConfigFactory, который может быть нулем.

Броски:

SecurityException - Если у вызывающей стороны нет разрешения, чтобы установить фабрику.

getConfigProvider

public abstract AuthConfigProvider getConfigProvider(java.lang.String layer,
                                                     java.lang.String appContext,
                                                     RegistrationListener listener)

Получите зарегистрированный AuthConfigProvider от фабрики. Получите провайдера объектов ServerAuthConfig и ClientAuthConfig, зарегистрированных для идентифицированного уровня сообщения и контекста приложения.

Все фабрики должны использовать следующие правила приоритета выбрать зарегистрированный AuthConfigProvider, который соответствует уровень и appContext параметры:

• Провайдер, определенно зарегистрированный для значений, которые передают как уровень и appContext параметры, должен быть выбран.
• Если никакой провайдер не будет выбран согласно предыдущему правилу, провайдер, определенно зарегистрированный для значения, которое передают как appContext параметр и для всех (то есть, нуль), то уровни должны быть выбраны.
• Если никакой провайдер не выбирается согласно предыдущим правилам, провайдер, определенно зарегистрированный для значения, которое передают, как параметр уровня и для всех (то есть, нуль) appContexts должен быть выбран.
• Если никакой провайдер не будет выбран согласно предыдущим правилам, провайдер, зарегистрированный для всех (то есть, нуль), то уровни и для всех (то есть, нуль) appContexts должны быть выбраны.
• Если никакой провайдер не будет выбран согласно предыдущим правилам, то фабрика должна завершить свой поиск зарегистрированного провайдера.

Вышеупомянутые правила приоритета применяются эквивалентно к регистрации, создаваемой с нулем или ненулем className параметр.

Параметры:

layer - Строка, идентифицирующая уровень сообщения, для которого должен быть возвращен зарегистрированный AuthConfigProvider. Значение этого параметра может быть нулем.

appContext - Строка, которая идентифицирует контекст обмена сообщениями приложения, для которого должен быть возвращен зарегистрированный AuthConfigProvider. Значение этого параметра может быть нулем.

listener - RegistrationListener, чей notify метод должен быть вызван, если соответствующая регистрация незарегистрирована или заменена. Значение этого параметра может быть нулем.

Возвраты:

Реализация интерфейса AuthConfigProvider, зарегистрированного на фабрике для уровня и appContext, или нуля, если никакой AuthConfigProvider не выбирается. Слушатель параметра присоединяется, даже если возвращаемое значение является нулем.

registerConfigProvider

public abstract java.lang.String registerConfigProvider(java.lang.String className,
                                                        java.util.Map properties,
                                                        java.lang.String layer,
                                                        java.lang.String appContext,
                                                        java.lang.String description)

Регистры в пределах фабрики и записи в пределах персистентного декларативного представления фабрики регистрации провайдера провайдер ServerAuthConfig и/или ClientAuthConfig возражают для уровня сообщения и идентификатора контекста приложения. Этот метод обычно создает экземпляр провайдера прежде, чем зарегистрировать это в фабрике. Фабрики могут расширить или изменить сохраненную регистрацию существующих экземпляров провайдера, если те экземпляры были зарегистрированы в ClassName и параметрах свойств, эквивалентных тем, которых передают в текущем вызове.

Этот метод нанимает двух конструкторов параметра, требуемых поддерживаться каждой реализацией интерфейса AuthConfigProvider, и этот метод должен передать нулевое значение для параметра фабрики конструктора. AuthConfigProviderImpl AuthConfigProviderImpl(Map properties, AuthConfigFactory factory).

Самое большее одна регистрация может существовать в пределах фабрики для данной комбинации уровня сообщения и appContext. Любая существующая ранее регистрация с идентичными значениями для уровня и appContext заменяется последующей регистрацией. Когда замена происходит, регистрационный идентификатор, уровень, и appContext идентификатор остается неизменным, и AuthConfigProvider (со свойствами инициализации) и описание заменяются.

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

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

Параметры:

className - Полностью определенное имя реализации AuthConfigProvider class (или нуль). Вызов этого метода с нулевым значением для этого параметра должен вызвать getConfigProvider возвратить нуль, когда это вызывают с уровнем и значениями appContext, для которых получающаяся регистрация является лучшим соответствием.

properties - Объект Карты, содержащий свойства инициализации, которые передадут к параметру свойств конструктора провайдера. Этим параметром может быть нуль. Когда этим параметром не является нуль, все значения и ключи, происходящие в Карте, должны иметь Строку типа.

layer - Строка, идентифицирующая уровень сообщения, для которого провайдер будет зарегистрирован на фабрике. Нулевое значение можно передать как параметр за этот параметр, когда провайдер регистрируется во всех уровнях.

appContext - Строковое значение, которое может использоваться временем выполнения, чтобы запросить объект конфигурации от этого провайдера. Нулевое значение можно передать как параметр за этот параметр, когда провайдер регистрируется для всех идентификаторов конфигурации (в обозначенных уровнях).

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

Возвраты:

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

Броски:

SecurityException - Если у вызывающей стороны нет разрешения, чтобы зарегистрировать провайдера на фабрике.

AuthException - Если конструкция провайдера (данный ненуль className) или регистрационные сбои.

registerConfigProvider

public abstract java.lang.String registerConfigProvider(AuthConfigProvider provider,
                                                        java.lang.String layer,
                                                        java.lang.String appContext,
                                                        java.lang.String description)

Регистры в пределах фабрики (в памяти), провайдера ServerAuthConfig и/или ClientAuthConfig возражают для уровня сообщения и идентификатора контекста приложения. Этот метод НЕ производит персистентное декларативное представление фабрики регистрации провайдера, и предназначается, чтобы использоваться провайдерами, чтобы выполнить саморегистрацию.

Самое большее одна регистрация может существовать в пределах фабрики для данной комбинации уровня сообщения и appContext. Любая существующая ранее регистрация с идентичными значениями для уровня и appContext заменяется последующей регистрацией. Когда замена происходит, регистрационный идентификатор, уровень, и appContext идентификатор остается неизменным, и AuthConfigProvider (со свойствами инициализации) и описание заменяются.

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

Параметры:

provider - AuthConfigProvider, который будет зарегистрирован на фабрике (или нуль). Вызов этого метода с нулевым значением для этого параметра должен вызвать getConfigProvider возвратить нуль, когда это вызывают с уровнем и значениями appContext, для которых получающаяся регистрация является лучшим соответствием.

layer - Строка, идентифицирующая уровень сообщения, для которого провайдер будет зарегистрирован на фабрике. Нулевое значение можно передать как параметр за этот параметр, когда провайдер регистрируется во всех уровнях.

appContext - Строковое значение, которое может использоваться временем выполнения, чтобы запросить объект конфигурации от этого провайдера. Нулевое значение можно передать как параметр за этот параметр, когда провайдер регистрируется для всех идентификаторов конфигурации (в обозначенных уровнях).

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

Возвраты:

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

Броски:

SecurityException - Если у вызывающей стороны нет разрешения, чтобы зарегистрировать провайдера на фабрике.

AuthException - Если регистрация провайдера перестала работать.

removeRegistration

public abstract boolean removeRegistration(java.lang.String registrationID)

Удалите идентифицированную регистрацию провайдера из фабрики (и из персистентного декларативного представления регистрации провайдера, если соответствующий), и вызовите любых слушателей, связанных с удаленной регистрацией.

Параметры:

registrationID - Строка, которая идентифицирует регистрацию провайдера на фабрике

Возвраты:

Истина, если была регистрация с указанным идентификатором и это было удалено. Возвратите false, если registrationID был недопустим.

Броски:

SecurityException - Если у вызывающей стороны нет разрешения, чтобы незарегистрировать провайдера на фабрике.

detachListener

public abstract java.lang.String[] detachListener(RegistrationListener listener,
                                                  java.lang.String layer,
                                                  java.lang.String appContext)

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

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

Параметры:

listener - RegistrationListener, который будет отсоединен.

layer - Строка, идентифицирующая уровень сообщения или нуль.

appContext - Строковое значение, идентифицирующее приложение contex или нуль.

Возвраты:

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

Броски:

SecurityException - Если у вызывающей стороны нет разрешения, чтобы отсоединить слушателя от фабрики.

getRegistrationIDs

public abstract java.lang.String[] getRegistrationIDs(AuthConfigProvider provider)

Получите регистрационные идентификаторы для всей регистрации экземпляра провайдера на фабрике.

Параметры:

provider - AuthConfigurationProvider, регистрационные идентификаторы которого должны быть возвращены. Этим параметром может быть нуль, когда это указывает, что ID всей активной регистрации в пределах фабрики должны быть возвращены.

Возвраты:

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

getRegistrationContext

public abstract AuthConfigFactory.RegistrationContext getRegistrationContext(java.lang.String registrationID)

Получите регистрационный контекст для идентифицированной регистрации.

Параметры:

registrationID - Строка, которая идентифицирует регистрацию провайдера на фабрике

Возвраты:

RegistrationContext или нуль. Когда Ненулевое значение возвращается, это - копия регистрационного контекста, соответствующего регистрации. Нуль возвращается, когда регистрационный идентификатор не делает correpond к активной регистрации

обновление

public abstract void refresh()

Заставьте фабрику повторно обрабатывать свое persisent декларативное представление регистрации провайдера.

Фабрика должна только заменить существующую регистрацию, когда изменение реализации провайдера class или свойства инициализации произошло.

Броски:

AuthException - Если ошибка произошла во время переинициализации.

SecurityException - Если у вызывающей стороны нет разрешения, чтобы обновить фабрику.