Spec-Zone .ru
спецификации, руководства, описания, API
|
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
public interface ServletContext
Определяет ряд методов, которые сервлет использует, чтобы связаться с его контейнером сервлета, например, получить тип MIME файла, диспетчеризировать запросы, или записать в файл журнала.
Есть один контекст на "веб-приложение" на виртуальную машину Java. ("Веб-приложение" является набором сервлетов и контента, установленного под определенным подмножеством пространства имен URL сервера такой как /catalog
и возможно установленный через a .war
файл.)
В случае веб-приложения, отмеченного "распределенный" в его дескрипторе развертывания, будет один экземпляр контекста для каждой виртуальной машины. В этой ситуации контекст не может использоваться в качестве расположения, чтобы поделиться глобальной информацией (потому что информация не будет действительно глобальна). Используйте внешний ресурс как база данных вместо этого.
ServletContext
объект содержится в пределах ServletConfig
объект, который веб-сервер обеспечивает сервлет, когда сервлет инициализируется.
Servlet#getServletConfig
, ServletConfig#getServletContext
Полевая Сводка | |
---|---|
static java.lang.String |
ORDERED_LIBS
Имя ServletContext припишите чье значение (типа java.util.List<java.lang.String> ) содержит список имен файлов JAR в WEB-INF/lib упорядоченный их веб-именами фрагмента (с возможными исключениями, если <absolute-ordering> ни с кем <others/> используется), или нуль, если никакое абсолютное или относительное упорядочивание не было определено |
static java.lang.String |
TEMPDIR
Имя атрибута ServletContext, который хранит частный временный каталог (типа java.io.File) обеспеченный контейнером сервлета для ServletContext |
Сводка метода | ||
---|---|---|
FilterRegistration. Динамичный |
addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
Добавляет фильтр с именем и типом class к этому контексту сервлета. |
|
FilterRegistration. Динамичный |
addFilter(java.lang.String filterName, Filter filter)
Регистрирует приведенный пример фильтра в этом ServletContext под данным filterName. |
|
FilterRegistration. Динамичный |
addFilter(java.lang.String filterName, java.lang.String className)
Добавляет фильтр с именем и именем class к этому контексту сервлета. |
|
void |
addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
Добавляет слушатель данного типа class к этому ServletContext. |
|
void |
addListener(java.lang.String className)
Добавляет слушатель с данным именем class к этому ServletContext. |
|
|
addListener(T t)
Добавляет данный слушатель этого ServletContext. |
|
ServletRegistration. Динамичный |
addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
Добавляет сервлет с именем и типом class к этому контексту сервлета. |
|
ServletRegistration. Динамичный |
addServlet(java.lang.String servletName, Servlet servlet)
Регистрирует приведенный пример сервлета в этом ServletContext под данным servletName. |
|
ServletRegistration. Динамичный |
addServlet(java.lang.String servletName, java.lang.String className)
Добавляет сервлет с именем и именем class к этому контексту сервлета. |
|
|
createFilter(java.lang.Class<T> clazz)
Инстанцирует данного Фильтра class. |
|
|
createListener(java.lang.Class<T> clazz)
Инстанцирует данного EventListener class. |
|
|
createServlet(java.lang.Class<T> clazz)
Инстанцирует данного Сервлета class. |
|
void |
declareRoles(java.lang.String... roleNames)
Объявляет ролевые имена, которые тестируются, используя isUserInRole . |
|
java.lang.Object |
getAttribute(java.lang.String name)
Возвращает атрибут контейнера сервлета с именем, или null если нет никакого атрибута тем именем. |
|
java.util.Enumeration<java.lang.String> |
getAttributeNames()
Возвраты Enumeration содержа названия атрибута, доступные в пределах этого ServletContext. |
|
java.lang.ClassLoader |
getClassLoader()
Получает загрузчик class веб-приложения, представленного этим ServletContext. |
|
ServletContext |
getContext(java.lang.String uripath)
Возвраты a ServletContext объект, который соответствует указанному URL на сервере. |
|
java.lang.String |
getContextPath()
Возвращает путь контекста веб-приложения. |
|
java.util.Set<SessionTrackingMode> |
getDefaultSessionTrackingModes()
Получает режимы отслеживания сеанса, которые поддерживаются по умолчанию для этого ServletContext. |
|
int |
getEffectiveMajorVersion()
Получает основную версию спецификации Сервлета, на которой приложение, представленное этим ServletContext, основано. |
|
int |
getEffectiveMinorVersion()
Получает вспомогательную версию спецификации Сервлета, на которой приложение, представленное этим ServletContext, основано. |
|
java.util.Set<SessionTrackingMode> |
getEffectiveSessionTrackingModes()
Получает режимы отслеживания сеанса, которые являются в действительности для этого ServletContext. |
|
FilterRegistration |
getFilterRegistration(java.lang.String filterName)
Получает FilterRegistration, соответствующий фильтру с данным filterName. |
|
java.util.Map<java.lang.String,? extends FilterRegistration> |
getFilterRegistrations()
Становится (возможно пустым) Карта объектов FilterRegistration (включенный именем фильтра) соответствующий всем фильтрам, зарегистрированным в этом ServletContext. |
|
java.lang.String |
getInitParameter(java.lang.String name)
Возвраты a String содержа значение именованного параметра инициализации всего контекста, или null если параметр не существует. |
|
java.util.Enumeration<java.lang.String> |
getInitParameterNames()
Возвращает имена параметров инициализации контекста как Enumeration из String объекты, или пустое Enumeration если у контекста нет никаких параметров инициализации. |
|
JspConfigDescriptor |
getJspConfigDescriptor()
Добирается <jsp-config> связанная конфигурация, которая была агрегирована от web.xml и web-fragment.xml файлы дескриптора веб-приложения представляются этим ServletContext. |
|
int |
getMajorVersion()
Возвращает основную версию API Сервлета, который поддерживает этот контейнер сервлета. |
|
java.lang.String |
getMimeType(java.lang.String file)
Возвращает тип MIME указанного файла, или null если тип MIME не известен. |
|
int |
getMinorVersion()
Возвращает вспомогательную версию API Сервлета, который поддерживает этот контейнер сервлета. |
|
RequestDispatcher |
getNamedDispatcher(java.lang.String name)
Возвраты a RequestDispatcher возразите что действия как обертка для именованного сервлета. |
|
java.lang.String |
getRealPath(java.lang.String path)
Получает реальный путь, соответствующий данному виртуальному пути. |
|
RequestDispatcher |
getRequestDispatcher(java.lang.String path)
Возвраты a RequestDispatcher возразите что действия как обертка для ресурса, расположенного в данном пути. |
|
java.net.URL |
getResource(java.lang.String path)
Возвращает URL ресурсу, который отображается на данный путь. |
|
java.io.InputStream |
getResourceAsStream(java.lang.String path)
Возвращает ресурс, расположенный в именованном пути как InputStream объект. |
|
java.util.Set<java.lang.String> |
getResourcePaths(java.lang.String path)
Возвращает подобное каталогу перечисление всех путей к ресурсам в пределах веб-приложения, самый длинный подпуть которого соответствует предоставленный параметр пути. |
|
java.lang.String |
getServerInfo()
Возвращает имя и версию контейнера сервлета, на котором работает сервлет. |
|
Сервлет |
getServlet(java.lang.String name)
Осуждаемый. С API Сервлета Java 2.1, без прямой замены. Этот метод был первоначально определен, чтобы получить сервлет от a Вместо этого метода, сервлеты могут поделиться информацией, используя |
|
java.lang.String |
getServletContextName()
Возвращает имя этого веб-приложения, соответствующего этому ServletContext как определено в дескрипторе развертывания для этого веб-приложения элементом имени дисплея. |
|
java.util.Enumeration<java.lang.String> |
getServletNames()
Осуждаемый. С API Сервлета Java 2.1, без замены. Этот метод был первоначально определен, чтобы возвратиться |
|
ServletRegistration |
getServletRegistration(java.lang.String servletName)
Получает ServletRegistration, соответствующий сервлету с данным servletName. |
|
java.util.Map<java.lang.String,? extends ServletRegistration> |
getServletRegistrations()
Становится (возможно пустым) Карта объектов ServletRegistration (включенный именем сервлета) соответствующий всем сервлетам, зарегистрированным в этом ServletContext. |
|
java.util.Enumeration<Servlet> |
getServlets()
Осуждаемый. С API Сервлета Java 2.0, без замены. Этот метод был первоначально определен, чтобы возвратиться |
|
SessionCookieConfig |
getSessionCookieConfig()
Добирается SessionCookieConfig объект, через который могут быть сконфигурированы различные свойства cookie отслеживания сеанса, создаваемых от имени этого ServletContext. |
|
void |
log(java.lang.Exception exception, java.lang.String msg)
Осуждаемый. С API Сервлета Java 2.1, использовать log(String message, Throwable throwable) вместо этого. Этот метод был первоначально определен, чтобы записать трассировку стека исключения и объяснительное сообщение об ошибке к файлу журнала сервлета. |
|
void |
log(java.lang.String msg)
Пишут указанное сообщение в файл журнала сервлета, обычно журнал событий. |
|
void |
log(java.lang.String message, java.lang.Throwable throwable)
Пишут объяснительное сообщение и трассировка стека для данного Throwable исключение к файлу журнала сервлета. |
|
void |
removeAttribute(java.lang.String name)
Удаляет атрибут с именем из этого ServletContext. |
|
void |
setAttribute(java.lang.String name, java.lang.Object object)
Связывает объект с данным названием атрибута в этом ServletContext. |
|
boolean |
setInitParameter(java.lang.String name, java.lang.String value)
Устанавливает параметры инициализации контекста с именем и значением на этом ServletContext. |
|
void |
setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
Устанавливает режимы отслеживания сеанса, которые должны вступить в силу для этого ServletContext. |
Полевая Деталь |
---|
static final java.lang.String TEMPDIR
static final java.lang.String ORDERED_LIBS
ServletContext
припишите чье значение (типа java.util.List<java.lang.String>
) содержит список имен файлов JAR в WEB-INF/lib
упорядоченный их веб-именами фрагмента (с возможными исключениями, если <absolute-ordering>
ни с кем <others/>
используется), или нуль, если никакое абсолютное или относительное упорядочивание не было определено
Деталь метода |
---|
java.lang.String getContextPath()
Путь контекста является частью URI запроса, который используется, чтобы выбрать контекст запроса. Путь контекста всегда на первом месте в URI запроса. Путь запускается с символа /, но не заканчивается символом /. Для сервлетов в значении по умолчанию (корень) контекст этот метод возвращается "".
Возможно, что контейнер сервлета может соответствовать контекст больше чем одним путем контекста. В таких случаях HttpServletRequest.getContextPath()
возвратит фактический путь контекста, используемый запросом, и это может отличаться от пути, возвращенного этим методом. Путь контекста, возвращенный этим методом, нужно рассмотреть как главный или привилегированный путь контекста приложения.
HttpServletRequest.getContextPath()
ServletContext getContext(java.lang.String uripath)
ServletContext
объект, который соответствует указанному URL на сервере. Этот метод позволяет сервлетам получать доступ к контексту для различных частей сервера, и как необходимый получать RequestDispatcher
объекты от контекста. Данный путь должен быть, начинаются с /, интерпретируется относительно корня документа сервера и соответствующий против корней контекста других веб-приложений, размещенных на этом контейнере.
В безопасности сознательная среда может возвратиться контейнер сервлета null
для данного URL.
uripath
- a String
определение пути контекста другого веб-приложения в контейнере. ServletContext
объект, который соответствует именованному URL, или нуль, если или ни один не существует или контейнер, хочет ограничить этот доступ.RequestDispatcher
int getMajorVersion()
int getMinorVersion()
int getEffectiveMajorVersion()
Возвращенное значение может отличаться от getMajorVersion()
, который возвращает основную версию спецификации Сервлета, поддерживаемой контейнером Сервлета.
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
int getEffectiveMinorVersion()
Возвращенное значение может отличаться от getMinorVersion()
, который возвращает вспомогательную версию спецификации Сервлета, поддерживаемой контейнером Сервлета.
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
java.lang.String getMimeType(java.lang.String file)
null
если тип MIME не известен. Тип MIME определяется конфигурацией контейнера сервлета, и может быть определен в дескрипторе развертывания веб-приложения. Общие типы MIME включают text/html
и image/gif
.
file
- a String
определение имени файла String
определение типа MIME файлаjava.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
Пути, указывающие на пути подкаталога, заканчиваются /.
Возвращенные пути - все относительно корня веб-приложения, или относительно каталога /META-INF/resources файла JAR в каталоге /WEB-INF/lib веб-приложения, и имеют ведущий /.
Например, для веб-приложения, содержащего:
getResourcePaths("/") возвратил бы {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}, и getResourcePaths("/catalog/") возвратит {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/", "/catalog/moreOffers/"}.
/welcome.html
/catalog/index.html
/catalog/products.html
/catalog/offers/books.html
/catalog/offers/music.html
/customer/login.jsp
/WEB-INF/web.xml
/WEB-INF/classes/com.acme.OrderServlet.class
/WEB-INF/lib/catalog.jar!/META-INF/resources/catalog/moreOffers/books.html
path
- частичный путь, используемый, чтобы соответствовать ресурсы, которые должны запуститься с /
java.net.URL getResource(java.lang.String path) throws java.net.MalformedURLException
Путь должен начаться с / и интерпретируется как относительно текущего корня контекста, или относительно каталога /META-INF/resources файла JAR в каталоге /WEB-INF/lib веб-приложения. Этот метод будет сначала искать корень документа веб-приложения для требуемого ресурса, прежде, чем искать любой из файлов JAR в /WEB-INF/lib. Порядок, в котором ищутся файлы JAR в /WEB-INF/lib, неопределен.
Этот метод позволяет контейнеру сервлета делать ресурс доступным для сервлетов из любого источника. Ресурсы могут быть расположены на локальной файловой системе или удаленной файловой системе в базе данных, или в a .war
файл.
Контейнер сервлета должен реализовать обработчики URL и URLConnection
объекты, которые необходимы, чтобы получить доступ к ресурсу.
Этот метод возвраты null
если никакой ресурс не отображается на путь.
Некоторые контейнеры могут позволить писать в URL, возвращенный этим методом, используя методы URL class.
Контент ресурса возвращается непосредственно, так знать тот запрос a .jsp
страница возвращает исходный код JSP. Используйте a RequestDispatcher
вместо этого включать результаты выполнения.
У этого метода есть различная цель чем java.lang.Class.getResource
, который ищет ресурсы, основанные на загрузчике class. Этот метод не использует загрузчики class.
path
- a String
определение пути к ресурсу null
если нет никакого ресурса в том пути java.net.MalformedURLException
- если путь не дается в корректной формеjava.io.InputStream getResourceAsStream(java.lang.String path)
InputStream
объект. Данные в InputStream
может иметь любой тип или длину. Путь должен быть определен согласно поданным правилам getResource
. Этот метод возвраты null
если никакой ресурс не существует в указанном пути.
Метаинформация, такая как длина контента и тип контента, который доступен через getResource
метод теряется при использовании этого метода.
Контейнер сервлета должен реализовать обработчики URL и URLConnection
возражает необходимый, чтобы получить доступ к ресурсу.
Этот метод отличается от java.lang.Class.getResourceAsStream
, который использует загрузчик class. Этот метод позволяет контейнерам сервлета делать ресурс доступным для сервлета от любого расположения, не используя загрузчик class.
path
- a String
определение пути к ресурсу InputStream
возвращенный к сервлету, или null
если никакой ресурс не существует в указанном путиRequestDispatcher getRequestDispatcher(java.lang.String path)
RequestDispatcher
возразите что действия как обертка для ресурса, расположенного в данном пути. A RequestDispatcher
объект может использоваться, чтобы передать запрос к ресурсу или включать ресурс в ответ. Ресурс может быть динамичным или статичным. Путь должен начаться с / и интерпретируется как относительно текущего корня контекста. Использовать getContext
получить a RequestDispatcher
для ресурсов во внешних контекстах.
Этот метод возвраты null
если ServletContext
не может возвратить a RequestDispatcher
.
path
- a String
определение пути к ресурсу RequestDispatcher
возразите что действия как обертка для ресурса в указанном пути, или null
если ServletContext
не может возвратить a RequestDispatcher
RequestDispatcher
, ServletContext#getContext
RequestDispatcher getNamedDispatcher(java.lang.String name)
RequestDispatcher
возразите что действия как обертка для именованного сервлета. Сервлеты (и страницы JSP также) могут быть именами через администрирование сервера или через дескриптор развертывания веб-приложения. Экземпляр сервлета может определить свое использование имени ServletConfig#getServletName
.
Этот метод возвраты null
если ServletContext
не может возвратить a RequestDispatcher
по любой причине.
name
- a String
определение имени сервлета, чтобы перенестись RequestDispatcher
возразите что действия как обертка для именованного сервлета, или null
если ServletContext
не может возвратить a RequestDispatcher
RequestDispatcher
, ServletContext#getContext
, ServletConfig#getServletName
Servlet getServlet(java.lang.String name) throws ServletException
Этот метод был первоначально определен, чтобы получить сервлет от a ServletContext
. В этой версии всегда возвращается этот метод null
и остается только сохранять совместимость на уровне двоичных кодов. Этот метод будет постоянно удален в будущей версии API Сервлета Java.
Вместо этого метода, сервлеты могут поделиться информацией, используя ServletContext
class и может выполнить совместно использованную бизнес-логику, вызывая методы на общие классы несервлета.
ServletException
java.util.Enumeration<Servlet> getServlets()
Этот метод был первоначально определен, чтобы возвратиться Enumeration
из всех сервлетов, известных этому контексту сервлета. В этой версии этот метод всегда возвращает пустое перечисление и остается только сохранять совместимость на уровне двоичных кодов. Этот метод будет постоянно удален в будущей версии API Сервлета Java.
java.util.Enumeration<java.lang.String> getServletNames()
Этот метод был первоначально определен, чтобы возвратиться Enumeration
из всего сервлета называет известным этому контексту. В этой версии этот метод всегда возвращает пустое Enumeration
и остается только сохранять совместимость на уровне двоичных кодов. Этот метод будет постоянно удален в будущей версии API Сервлета Java.
void log(java.lang.String msg)
msg
- a String
определение сообщения, которое будет записано файлу журналаvoid log(java.lang.Exception exception, java.lang.String msg)
log(String message, Throwable throwable)
вместо этого. Этот метод был первоначально определен, чтобы записать трассировку стека исключения и объяснительное сообщение об ошибке к файлу журнала сервлета.
void log(java.lang.String message, java.lang.Throwable throwable)
Throwable
исключение к файлу журнала сервлета. Имя и тип файла журнала сервлета являются определенными для контейнера сервлета, обычно журнал событий.
message
- a String
это описывает ошибку или исключениеthrowable
- Throwable
ошибка или исключениеjava.lang.String getRealPath(java.lang.String path)
Например, если path будет равен /index.html, то этот метод возвратит абсолютный путь к файлу на файловой системе сервера, на которую запрос формы был бы отображен http://<host>:<port>/<contextPath>/index.html, где <contextPath> соответствует пути контекста этого ServletContext.
Реальный возвращенный путь будет в форме, соответствующей компьютерной и операционной системе, на которой контейнер сервлета работает, включая надлежащие разделители пути.
Ресурсы в каталогах /META-INF/resources файлов JAR, связанных в каталоге /WEB-INF/lib приложения, нужно рассмотреть, только если контейнер распаковал их от их содержания файла JAR, когда путь к распакованному расположению должен быть возвращен.
Этот метод возвраты null
если контейнер сервлета неспособен преобразовать данный виртуальный путь к реальному пути.
path
- виртуальный путь, который будет преобразован в реальный путь java.lang.String getServerInfo()
Форма возвращенной строки является servername/versionnumber. Например, Набор Веб-разработки JavaServer может возвратить строку JavaServer Web Dev Kit/1.0
.
Контейнер сервлета может возвратить другую дополнительную информацию после основной строки в круглых скобках, например, JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)
.
String
содержа, по крайней мере, имя контейнера сервлета и номер версииjava.lang.String getInitParameter(java.lang.String name)
String
содержа значение именованного параметра инициализации всего контекста, или null
если параметр не существует. Этот метод может сделать доступным конфигурационная информация полезный для всего веб-приложения. Например, это может обеспечить адрес электронной почты веб-мастера или имя системы, которая содержит критические данные.
name
- a String
содержа имя параметра, значение которого требуют String
содержа, по крайней мере, имя контейнера сервлета и номер версииServletConfig#getInitParameter
java.util.Enumeration<java.lang.String> getInitParameterNames()
Enumeration
из String
объекты, или пустое Enumeration
если у контекста нет никаких параметров инициализации.
Enumeration
из String
объекты, содержащие имена параметров инициализации контекстаServletConfig#getInitParameter
boolean setInitParameter(java.lang.String name, java.lang.String value)
name
- имя параметра инициализации контекста, чтобы установитьvalue
- значение параметра инициализации контекста, чтобы установить IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
java.lang.Object getAttribute(java.lang.String name)
null
если нет никакого атрибута тем именем. Атрибут позволяет контейнеру сервлета давать дополнительную информацию сервлета, не уже обеспеченную этим интерфейсом. См. свою документацию сервера для информации о ее атрибутах. Список поддерживаемых атрибутов может быть получен, используя getAttributeNames
.
Атрибут возвращается как a java.lang.Object
или некоторый подкласс.
Названия атрибута должны следовать за тем же самым соглашением как имена пакета. Спецификация API Сервлета Java резервирует соответствие имен java.*
, javax.*
, и sun.*
.
name
- a String
определение имени атрибута Object
содержа значение атрибута, или null
если никакой атрибут не существует, соответствуя имяServletContext#getAttributeNames
java.util.Enumeration<java.lang.String> getAttributeNames()
Enumeration
содержа названия атрибута, доступные в пределах этого ServletContext. Используйте getAttribute(java.lang.String)
метод с названием атрибута, чтобы получить значение атрибута.
Enumeration
из названий атрибутаgetAttribute(java.lang.String)
void setAttribute(java.lang.String name, java.lang.Object object)
Если слушатели конфигурируются на ServletContext
контейнер уведомляет их соответственно.
Если нулевое значение передают, эффект является тем же самым как вызовом removeAttribute()
.
Названия атрибута должны следовать за тем же самым соглашением как имена пакета. Спецификация API Сервлета Java резервирует соответствие имен java.*
, javax.*
, и sun.*
.
name
- a String
определение имени атрибутаobject
- Object
представление атрибута, который будет связанvoid removeAttribute(java.lang.String name)
getAttribute(java.lang.String)
получать значение атрибута возвратится null
. Если слушатели конфигурируются на ServletContext
контейнер уведомляет их соответственно.
name
- a String
определение имени атрибута, который будет удаленjava.lang.String getServletContextName()
ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className)
Зарегистрированный сервлет может быть далее сконфигурирован через возвращенный ServletRegistration
объект.
Указанный className будет загружен, используя classloader, связанный с приложением, представленным этим ServletContext.
Если этот ServletContext уже будет содержать предварительный ServletRegistration для сервлета с данным servletName, то он будет завершен (присваивая данный className этому) и возвращен.
Этот метод анализирует class с данным className для ServletSecurity
, MultipartConfig
, javax.annotation.security.RunAs, и аннотации javax.annotation.security.DeclareRoles. Кроме того, этот метод поддерживает инжекцию ресурса, если class с данным className представляет Управляемый Боб. См. платформу EE Java и JSR 299 спецификаций для дополнительных деталей об Управляемых Бобах и инжекции ресурса.
servletName
- имя сервлетаclassName
- полностью определенное имя class сервлета IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
ServletRegistration.Dynamic addServlet(java.lang.String servletName, Servlet servlet)
Зарегистрированный сервлет может быть далее сконфигурирован через возвращенный ServletRegistration
объект.
Если этот ServletContext уже будет содержать предварительный ServletRegistration для сервлета с данным servletName, то он будет завершен (присваивая имя class приведенного примера сервлета к этому) и возвращен.
servletName
- имя сервлетаservlet
- экземпляр сервлета, чтобы зарегистрироваться IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
IllegalArgumentException
- если приведенный пример сервлета реализует SingleThreadModel
ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
Зарегистрированный сервлет может быть далее сконфигурирован через возвращенный ServletRegistration
объект.
Если этот ServletContext уже будет содержать предварительный ServletRegistration для сервлета с данным servletName, то он будет завершен (присваивая имя данного servletClass к этому) и возвращен.
Этот метод анализирует данный servletClass для ServletSecurity
, MultipartConfig
, javax.annotation.security.RunAs, и аннотации javax.annotation.security.DeclareRoles. Кроме того, этот метод поддерживает инжекцию ресурса, если данный servletClass представляет Управляемый Боб. См. платформу EE Java и JSR 299 спецификаций для дополнительных деталей об Управляемых Бобах и инжекции ресурса.
servletName
- имя сервлетаservletClass
- объект class, от которого инстанцируют сервлет IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
<T extends Servlet> T createServlet(java.lang.Class<T> clazz) throws ServletException
Возвращенный экземпляр Сервлета может быть далее настроен прежде, чем он будет зарегистрирован в этом ServletContext через звонок addServlet(String,Servlet)
.
Данный class Сервлета должен определить нулевого конструктора параметра, который используется, чтобы инстанцировать его.
Этот метод анализирует данный clazz для следующих аннотаций: ServletSecurity
, MultipartConfig
, javax.annotation.security.RunAs, и javax.annotation.security.DeclareRoles. Кроме того, этот метод поддерживает инжекцию ресурса, если данный clazz представляет Управляемый Боб. См. платформу EE Java и JSR 299 спецификаций для дополнительных деталей об Управляемых Бобах и инжекции ресурса.
clazz
- Сервлет class, чтобы инстанцировать ServletException
- если данный clazz не в состоянии быть инстанцированным UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
ServletRegistration getServletRegistration(java.lang.String servletName)
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
java.util.Map<java.lang.String,? extends ServletRegistration> getServletRegistrations()
Возвращенная Карта включает объекты ServletRegistration, соответствующие всем объявленным и аннотируемым сервлетам, так же как объектам ServletRegistration, соответствующим всем сервлетам, которые были добавлены через один из методов addServlet.
Если разрешено, любые изменения к возвращенной Карте не должны влиять на этот ServletContext.
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className)
Зарегистрированный фильтр может быть далее сконфигурирован через возвращенный FilterRegistration
объект.
Указанный className будет загружен, используя classloader, связанный с приложением, представленным этим ServletContext.
Если этот ServletContext уже будет содержать предварительный FilterRegistration для фильтра с данным filterName, то он будет завершен (присваивая данный className этому) и возвращен.
Этот метод поддерживает инжекцию ресурса, если class с данным className представляет Управляемый Боб. См. платформу EE Java и JSR 299 спецификаций для дополнительных деталей об Управляемых Бобах и инжекции ресурса.
filterName
- имя фильтраclassName
- полностью определенное имя class фильтра IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
FilterRegistration.Dynamic addFilter(java.lang.String filterName, Filter filter)
Зарегистрированный фильтр может быть далее сконфигурирован через возвращенный FilterRegistration
объект.
Если этот ServletContext уже будет содержать предварительный FilterRegistration для фильтра с данным filterName, то он будет завершен (присваивая имя class приведенного примера фильтра к этому) и возвращен.
filterName
- имя фильтраfilter
- экземпляр фильтра, чтобы зарегистрироваться IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
Зарегистрированный фильтр может быть далее сконфигурирован через возвращенный FilterRegistration
объект.
Если этот ServletContext уже будет содержать предварительный FilterRegistration для фильтра с данным filterName, то он будет завершен (присваивая имя данного filterClass к этому) и возвращен.
Этот метод поддерживает инжекцию ресурса, если данный filterClass представляет Управляемый Боб. См. платформу EE Java и JSR 299 спецификаций для дополнительных деталей об Управляемых Бобах и инжекции ресурса.
filterName
- имя фильтраfilterClass
- объект class, от которого инстанцируют фильтр IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
<T extends Filter> T createFilter(java.lang.Class<T> clazz) throws ServletException
Возвращенный экземпляр Фильтра может быть далее настроен прежде, чем он будет зарегистрирован в этом ServletContext через звонок addFilter(String,Filter)
.
Данный class Фильтра должен определить нулевого конструктора параметра, который используется, чтобы инстанцировать его.
Этот метод поддерживает инжекцию ресурса, если данный clazz представляет Управляемый Боб. См. платформу EE Java и JSR 299 спецификаций для дополнительных деталей об Управляемых Бобах и инжекции ресурса.
clazz
- Фильтр class, чтобы инстанцировать ServletException
- если данный clazz не в состоянии быть инстанцированным UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
FilterRegistration getFilterRegistration(java.lang.String filterName)
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
java.util.Map<java.lang.String,? extends FilterRegistration> getFilterRegistrations()
Возвращенная Карта включает объекты FilterRegistration, соответствующие всем объявленным и аннотируемым фильтрам, так же как объектам FilterRegistration, соответствующим всем фильтрам, которые были добавлены через один из методов addFilter.
Любые изменения к возвращенной Карте не должны влиять на этот ServletContext.
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
SessionCookieConfig getSessionCookieConfig()
SessionCookieConfig
объект, через который могут быть сконфигурированы различные свойства cookie отслеживания сеанса, создаваемых от имени этого ServletContext. Повторные вызовы этого метода возвратят тот же самый экземпляр SessionCookieConfig.
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
void setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
Данный sessionTrackingModes заменяет любые режимы отслеживания сеанса, установленные предыдущим вызовом этого метода на этом ServletContext.
sessionTrackingModes
- набор режимов отслеживания сеанса, чтобы вступить в силу для этого ServletContext
IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
IllegalArgumentException
- если sessionTrackingModes определяет комбинацию SessionTrackingMode.SSL с режимом отслеживания сеанса кроме SessionTrackingMode.SSL, или если sessionTrackingModes определяет режим отслеживания сеанса, который не поддерживается контейнером сервлетаjava.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes()
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
java.util.Set<SessionTrackingMode> getEffectiveSessionTrackingModes()
Режимы отслеживания сеанса в действительности - обеспеченные для setSessionTrackingModes
.
По умолчанию, режимы отслеживания сеанса, возвращенные getDefaultSessionTrackingModes
в действительности.
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
void addListener(java.lang.String className)
class с именем будет загружен, используя classloader, связанный с приложением, представленным этим ServletContext, и должен реализовать один или больше следующих интерфейсов:
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionListener
HttpSessionAttributeListener
Если к этому ServletContext передали ServletContainerInitializer#onStartup
, тогда class с именем может также реализовать ServletContextListener
, в дополнение к упомянутым выше интерфейсам.
Как часть этого вызова метода, контейнер должен загрузить class указанным именем class, чтобы гарантировать, что это реализует один из необходимых интерфейсов.
Если class с именем реализует интерфейс слушателя, порядок вызова которого соответствует порядку объявления (то есть, если это реализует ServletRequestListener
, ServletContextListener
, или HttpSessionListener
), тогда новый слушатель будет добавлен до конца упорядоченного списка слушателей того интерфейса.
Этот метод поддерживает инжекцию ресурса, если class с данным className представляет Управляемый Боб. См. платформу EE Java и JSR 299 спецификаций для дополнительных деталей об Управляемых Бобах и инжекции ресурса.
className
- полностью определенное имя class слушателя IllegalArgumentException
- если class с именем не реализует ни одного из вышеупомянутых интерфейсов, или если это реализует ServletContextListener
и к этому ServletContext не передали ServletContainerInitializer#onStartup
IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
<T extends java.util.EventListener> void addListener(T t)
Данный слушатель должен быть экземпляром один или больше следующих интерфейсов:
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionListener
HttpSessionAttributeListener
Если к этому ServletContext передали ServletContainerInitializer#onStartup
, тогда данный слушатель может также быть экземпляром ServletContextListener
, в дополнение к упомянутым выше интерфейсам.
Если данный слушатель является экземпляром интерфейса слушателя, порядок вызова которого соответствует порядку объявления (то есть, если это - экземпляр ServletRequestListener
, ServletContextListener
, или HttpSessionListener
), тогда слушатель будет добавлен до конца упорядоченного списка слушателей того интерфейса.
t
- слушатель, который будет добавлен IllegalArgumentException
- если данный слушатель не является экземпляром какого-либо из вышеупомянутых интерфейсов, или если это - экземпляр ServletContextListener
и к этому ServletContext не передали ServletContainerInitializer#onStartup
IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
Данный listenerClass должен реализовать один или больше следующих интерфейсов:
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionListener
HttpSessionAttributeListener
Если к этому ServletContext передали ServletContainerInitializer#onStartup
, тогда данный listenerClass может также реализовать ServletContextListener
, в дополнение к упомянутым выше интерфейсам.
Если данный listenerClass implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it implements ServletRequestListener
, ServletContextListener
, или HttpSessionListener
), тогда новый слушатель будет добавлен до конца упорядоченного списка слушателей того интерфейса.
This method supports resource injection if the given listenerClass represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
listenerClass
- слушатель class, который инстанцируют IllegalArgumentException
- if the given listenerClass does not implement any of the above interfaces, or if it implements ServletContextListener
и к этому ServletContext не передали ServletContainerInitializer#onStartup
IllegalStateException
- если этот ServletContext был уже инициализирован UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
<T extends java.util.EventListener> T createListener(java.lang.Class<T> clazz) throws ServletException
Указанный EventListener class должен реализовать по крайней мере один из
, ServletContextListener
, ServletContextAttributeListener
, ServletRequestListener
, ServletRequestAttributeListener
, или HttpSessionListener
интерфейсы. HttpSessionAttributeListener
Возвращенный экземпляр EventListener может быть далее настроен прежде, чем он будет зарегистрирован в этом ServletContext через звонок addListener(EventListener)
.
Данный class EventListener должен определить нулевого конструктора параметра, который используется, чтобы инстанцировать его.
This method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.
clazz
- EventListener class, чтобы инстанцировать ServletException
- if the given clazz fails to be instantiated UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
IllegalArgumentException
- если указанный EventListener class не реализует ни одного из ServletContextListener
, ServletContextAttributeListener
, ServletRequestListener
, ServletRequestAttributeListener
, HttpSessionListener
, или HttpSessionAttributeListener
интерфейсы.JspConfigDescriptor getJspConfigDescriptor()
<jsp-config>
связанная конфигурация, которая была агрегирована от web.xml
и web-fragment.xml
файлы дескриптора веб-приложения представляются этим ServletContext.
<jsp-config>
связанная конфигурация, которая была агрегирована от web.xml
и web-fragment.xml
файлы дескриптора веб-приложения, представленного этим ServletContext, или нулем, если никакая такая конфигурация не существует UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
JspConfigDescriptor
java.lang.ClassLoader getClassLoader()
Если менеджер безопасности существует, и загрузчик class вызывающей стороны не является тем же самым как, или предок требуемого загрузчика class, то менеджер безопасности checkPermission
метод вызывают с a RuntimePermission("getClassLoader")
разрешение, чтобы проверить, должен ли доступ к требуемому загрузчику class быть предоставлен.
UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
SecurityException
- если менеджер безопасности лишает доступа к требуемому загрузчику classvoid declareRoles(java.lang.String... roleNames)
isUserInRole
. Роли, которые неявно объявляются в результате их использования в пределах setServletSecurity
или setRunAsRole
методы ServletRegistration
взаимодействуйте через интерфейс не должен быть объявлен.
roleNames
- роль называет быть объявленным UnsupportedOperationException
- если этот ServletContext передали к ServletContextListener#contextInitialized
метод a ServletContextListener
это ни не было объявлено в web.xml
или web-fragment.xml
, ни аннотируемый WebListener
IllegalArgumentException
- если каким-либо параметром roleNames является нуль или пустая строка IllegalStateException
- если ServletContext был уже инициализирован
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается
Сгенерированный на 10-February-2011 12:41