2. Вспомогательные классы

Чтобы успешно использовать сервлеты, необходимо ознакомиться с рядом вспомогательных классов. Для начала узнаем, какие методы предлагает интерфейс ServletRequest, передающий сервлету запрос от клиента. Конечно же, запрос поступает не в том виде, в котором он приходит на сервер. Поток данных от клиента сортируется и упаковывается. Далее, вызывая методы интерфейса ServerRequest, можно получать определенный тип данных, посланных клиентом. Так, метод getCharacterEncoding определяет символьную кодировку запроса, а методы getContentType и getProtocol - MIME-тип пришедшего запроса, а также название и версию протокола соответственно. Информацию об имени сервера, принявшего запрос, и порте, на котором запрос был "услышан" сервером, выдают методы getServerName и getServerPort. Интересные данные можно узнать и о клиенте, от имени которого пришел запрос. Его IP-адрес возвращается методом getRemoteAddr, а его имя - методом getRemoteHost.

Если вас интересует прямой доступ к содержимому полученного запроса, самый надежный способ получить его - вызвать метод getInputStream или getReader. Первый возвращает ссылку на объект класса ServletInputStream, а второй - на BufferedReader. После этого можно читать любой байт из полученного запроса, используя технику работы с потоками Java.

Если, обращаясь к серверу, клиент помимо универсального адреса задал параметры, сервлету может понадобиться узнать их значение. Примером может служить электронная анкета, выполненная в виде Web-страницы с формой ввода, значения полей и кнопок которой автоматически преобразуются в параметры URL. Три специальных метода в интерфейсе ServletRequest занимаются разбором параметров и "выдачей на-гора" их значений. Первый из них, getParameter, возвращает значение параметра по его имени или null, если параметра с таким именем нет. Похожий метод, getParameterValues, возвращает массив строк, если задан сложный параметр, скажем, значения полей формы. И еще один метод, getParameterNames, возвращает энумератор, позволяющий узнать имена всех присланных параметров.

В классе HttpServletRequest имеются различные дополнительные методы, обеспечивающие программисту доступ к деталям протокола HTTP. Так, вы можете запросить массив cookies, полученный с запросом, используя метод getCookies. Узнать о методе доступа к ресурсам, на основе которого построен запрос, можно с помощью вызова getMethod. Строку запроса HTTP можно получить методом getQueryString. Даже имя пользователя, выполнившего запрос, не укроется от сервлета, если применить метод getRemoteUser.

Это, разумеется, лишь малая толика тех возможностей, которыми обладают вышеупомянутые классы ServletRequest и HttpServletRequest. Поэтому следует внимательно прочитать документацию по Servlet API.

Генерируемые сервлетами данные пересылаются серверу-контейнеру с помощью объектов, наследующих интерфейс ServletResponse, а сервер, в свою очередь, пересылает ответ клиенту, инициировавшему запрос. У интерфейса ServletResponse всего несколько методов, причем полезными оказываются не все. Чаще всего приходится задавать MIME-тип генерируемых данных методом setContentType и находить ссылки на потоки вывода двумя другими методами: getOutputStream возвращает ссылку на поток ServletOutputStream, а метод getWriter вернет ссылку на поток типа PrintWriter. Вы увидите, как ими пользоваться, когда мы будем рассматривать практический пример.

В классе HttpServletResponse, реализующем интерфейс ServletResponse, обнаруживаются еще несколько полезных методов. Например, вы можете переслать cookie на клиентскую станцию, вызвав метод addCookie. О возникших ошибках сообщается вызовом sendError, которому в качестве параметра передается код ошибки и при необходимости текстовое сообщение. Кроме того, по мере надобности в заголовок ответа можно добавлять параметры, для чего служит метод setDateHeader.

Ранее уже упоминался метод getServletConfig, но не было сказано об объекте ServletConfig, у которого имеются очень полезные методы. Инсталлируя сервлет на сервере, вы можете задавать параметры инициализации, о которых будет сказано в следующей части. Имена этих параметров можно получить через энумератор, возвращаемый методом getInitParameterNames. Значение же конкретного параметра получают вызовом getInitParameter. Также важен метод получения контекста сервлета getServletContext, через обращение к которому можно узнать много полезного о среде, в которой запущен и выполняется сервлет.

Контекст выполнения сервлета интересен тем, что дает примитивные средства для общения с сервером. Скажем, для выполнения задачи требуется узнать MIME-тип того или иного файла. Всегда пожалуйста, вызовите метод getMimeType контекста. Или нужно узнать истинный маршрут файла относительно каталога, в котором сервер хранит документы. Тоже нет проблем, метод getRealPath к вашим услугам. Информация же о самом сервере предоставляется по вызову getServerInfo().

Отдельно стоят метод, загружающий сервлет по имени getServlet, и метод, возвращающий энумератор с именами всех установленных сервлетов getServletNames. Однако не рекомендуется пользоваться ими, так как в будущей версии Java Servlet Development Kit их может уже и не быть.

И напоследок самый важный метод log. С его помощью нужные текстовые данные пишутся в протокол работы сервлетов.