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

javax.servlet
Регистрация интерфейса

Все Известные Подынтерфейсы:

FilterRegistration, FilterRegistration. Динамичный, Регистрация. Динамичный, ServletRegistration, ServletRegistration. Динамичный

public interface Registration

Интерфейс тот, через который a Servlet или Filter может быть далее сконфигурирован.

Регистрационный объект, чей getClassName() нуль возвратов метода считают предварительным. Сервлеты и Фильтры, реализация которых class является контейнерной определенной реализацией, могут быть объявлены без любого servlet-class или элементов filter-class, соответственно, и будут представлены, поскольку предварительная Регистрация возражает. Предварительная регистрация должна быть завершена, вызывая один из методов addServlet ИЛИ addFilter на ServletContext, и передача на имя Сервлета или Фильтра (полученный через getName()) наряду с реализацией Сервлета или Фильтра поддержки имя class, объект Класса, или экземпляр, соответственно. В большинстве случаев предварительная регистрация будет завершена соответствующим, обеспеченным контейнером ServletContainerInitializer.

С тех пор:

Сервлет 3.0

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

static interface

Регистрация. Динамичный Интерфейс тот, через который a Servlet или Filter зарегистрированный через один из методов addServlet ИЛИ addFilter, соответственно, на ServletContext может быть далее сконфигурирован.

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

java.lang.String	getClassName() Получает полностью определенное имя class Сервлета или Фильтра, который представляется этой Регистрацией.
java.lang.String	getInitParameter(java.lang.String name) Получает значение параметра инициализации с именем, которое будет использоваться, чтобы инициализировать Сервлет или Фильтр, представленный этим Регистрационным объектом.
java.util.Map<java.lang.String,java.lang.String>	getInitParameters() Получает неизменное (и возможно пустой) Карта, содержащая в настоящий момент доступные параметры инициализации, которые будут использоваться, чтобы инициализировать Сервлет или Фильтр, представленный этим Регистрационным объектом.
java.lang.String	getName() Получает имя Сервлета или Фильтра, который представляется этой Регистрацией.
boolean	setInitParameter(java.lang.String name, java.lang.String value) Устанавливает параметры инициализации с именем и значением на Сервлете или Фильтре, который представляется этой Регистрацией.
java.util.Set<java.lang.String>	setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters) Устанавливает данные параметры инициализации на Сервлете или Фильтре, который представляется этой Регистрацией.

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

getName

java.lang.String getName()

Получает имя Сервлета или Фильтра, который представляется этой Регистрацией.

Возвраты:

имя Сервлета или Фильтра, который представляется этой Регистрацией

getClassName

java.lang.String getClassName()

Получает полностью определенное имя class Сервлета или Фильтра, который представляется этой Регистрацией.

Возвраты:

полностью определенное имя class Сервлета или Фильтра, который представляется этой Регистрацией, или нулем, если эта Регистрация предварительна

setInitParameter

boolean setInitParameter(java.lang.String name,
                         java.lang.String value)

Устанавливает параметры инициализации с именем и значением на Сервлете или Фильтре, который представляется этой Регистрацией.

Параметры:

name - название параметра инициализации

value - значение параметра инициализации

Возвраты:

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

Броски:

IllegalStateException - если ServletContext, из которого была получена эта Регистрация, был уже инициализирован

IllegalArgumentException - если именем или значением является null

getInitParameter

java.lang.String getInitParameter(java.lang.String name)

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

Параметры:

name - имя параметра инициализации, значение которого требуют

Возвраты:

значение параметра инициализации с именем, или null, если никакой параметр инициализации с именем не существует

setInitParameters

java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)

Устанавливает данные параметры инициализации на Сервлете или Фильтре, который представляется этой Регистрацией.

Данная карта параметров инициализации обрабатывается значением, то есть, для каждого параметра инициализации, содержавшегося в карте, это вызовы метода setInitParameter(String,String). Если тот метод возвратил бы false для какого-либо из параметров инициализации в данной карте, никакие обновления не будут выполняться, и false будет возвращен. Аналогично, если карта будет содержать параметр инициализации с именем null или значением, то никакие обновления не будут выполняться, и IllegalArgumentException будет брошен.

Параметры:

initParameters - параметры инициализации

Возвраты:

(возможно пустой) Набор названий параметра инициализации, которые находятся в конфликте

Броски:

IllegalStateException - если ServletContext, из которого была получена эта Регистрация, был уже инициализирован

IllegalArgumentException - если данная карта содержит параметр инициализации с именем null или значением

getInitParameters

java.util.Map<java.lang.String,java.lang.String> getInitParameters()

Получает неизменное (и возможно пустой) Карта, содержащая в настоящий момент доступные параметры инициализации, которые будут использоваться, чтобы инициализировать Сервлет или Фильтр, представленный этим Регистрационным объектом.

Возвраты:

Карта, содержащая в настоящий момент доступные параметры инициализации, которые будут использоваться, чтобы инициализировать Сервлет или Фильтр, представленный этим Регистрационным объектом