/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * */ package org.apache.ahc; import java.net.URL; import java.util.concurrent.TimeoutException; import org.apache.ahc.auth.AuthChallengeParser; import org.apache.ahc.auth.AuthPolicy; import org.apache.ahc.auth.AuthScheme; import org.apache.ahc.auth.AuthState; import org.apache.ahc.codec.HttpRequestMessage; import org.apache.ahc.codec.HttpResponseMessage; import org.apache.ahc.util.MonitoringEvent; import org.apache.ahc.util.NameValuePair; import org.apache.asyncweb.common.HttpMethod; import org.apache.mina.core.session.IdleStatus; import org.apache.mina.core.service.IoHandlerAdapter; import org.apache.mina.core.session.IoSession; /** * The Class HttpIoHandler. Implements the MINA IoHandler interface as the primary * event processor for the HTTP communication. */ public class HttpIoHandler extends IoHandlerAdapter { /** * The Constant CURRENT_REQUEST. */ public static final String CURRENT_REQUEST = "CURRENT_REQUEST"; /** * The Constant CURRENT_RESPONSE. */ public static final String CURRENT_RESPONSE = "CURRENT_RESPONSE"; /** * The Constant CONNECTION_CLOSE. */ public static final String CONNECTION_CLOSE = "close"; /** * The connection pool used for reusable IoSessions */ private ConnectionPool connectionPool; /** * Set the connection pool that should be used for * connection reuse. * * @param connectionPool The new connection pool. If null, this will disable * future IoSession instance reuse. */ public void setConnectionPool(ConnectionPool connectionPool) { this.connectionPool = connectionPool; } /** * Retrieve the connection pool used for storing * IoSession instances for reuse. * * @return The current connection pool for the client. */ public ConnectionPool getConnectionPool() { return connectionPool; } /** * Stub for handling sessionOpened events. * * @see org.apache.mina.core.IoHandlerAdapter#sessionOpened(org.apache.mina.core.IoSession) */ public void sessionOpened(IoSession ioSession) throws Exception { } /** * Handler for receiving a response from a remote server. * * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server. * @param object the {@link HttpResponseMessage} object * @see org.apache.mina.core.IoHandlerAdapter#messageReceived(org.apache.mina.core.IoSession,java.lang.Object) */ public void messageReceived(IoSession ioSession, Object object) throws Exception { HttpResponseMessage response = (HttpResponseMessage) object; HttpRequestMessage request = (HttpRequestMessage) ioSession.getAttribute(CURRENT_REQUEST); AsyncHttpClient client = (AsyncHttpClient) ioSession.getAttachment(); //Check if we are to handle redirects if ((response.getStatusCode() == 301 || response.getStatusCode() == 302 || response.getStatusCode() == 307) && request.isFollowRedirects()) { // notify any interesting parties that this is starting client.notifyMonitoringListeners(MonitoringEvent.REQUEST_REDIRECTED, request); //Change the request url to the redirect request.setUrl(new URL(response.getLocation())); // if we're redirected via 30x, the request method should be reset to GET if (HttpMethod.GET != request.getRequestMethod()) { request.setRequestMethod(HttpMethod.GET); } // we also need to clear out the parameters request.clearAllParameters(); //Send the redirect client.sendRequest(request); poolSession(ioSession); return; } //Check if we have authentication if (response.getChallenges().size() > 0) { // notify any interesting parties that this is starting client.notifyMonitoringListeners(MonitoringEvent.REQUEST_CHALLENGED, request); for (NameValuePair nvp : response.getChallenges()) { AuthState state = request.getAuthState(); if (state == null) { String id = AuthChallengeParser.extractScheme(nvp.getValue()); AuthScheme authScheme = AuthPolicy.getAuthScheme(id); state = new AuthState(); state.setAuthScheme(authScheme); authScheme.processChallenge(nvp.getValue()); request.setAuthState(state); } } //Authenticate int authCount = request.getAuthCount() + 1; if (authCount <= 3) { poolSession(ioSession); request.setAuthCount(authCount); client.sendRequest(request); return; } } // notify any interesting parties that this is starting client.notifyMonitoringListeners(MonitoringEvent.REQUEST_COMPLETED, request); // complete the future which will also fire the callback ResponseFuture result = request.getResponseFuture(); result.set(response); poolSession(ioSession); } /** * Place the IoSession instance in the pool if the pool is available. * @param session */ private void poolSession(IoSession session) { ConnectionPool pool = getConnectionPool(); if (pool != null) { pool.poolConnection(session); } } /** * Handler for receiving a notification that an Exception occurred in the communication with the server * * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server. * @param throwable the {@link java.lang.Throwable} object representing the exception that occurred * @see org.apache.mina.core.IoHandlerAdapter#exceptionCaught(org.apache.mina.core.IoSession,java.lang.Throwable) */ public void exceptionCaught(IoSession ioSession, Throwable throwable) throws Exception { //Clean up if any in-proccess decoding was occurring ioSession.removeAttribute(CURRENT_RESPONSE); HttpRequestMessage request = (HttpRequestMessage) ioSession.getAttribute(CURRENT_REQUEST); AsyncHttpClient client = (AsyncHttpClient) ioSession.getAttachment(); // notify any interesting parties that this is starting client.notifyMonitoringListeners(MonitoringEvent.REQUEST_FAILED, request); // complete the future which will also fire the callback ResponseFuture result = request.getResponseFuture(); result.setException(throwable); //Exception is bad, so just close it up ioSession.close(); } /** * Handler for notifying that a connection was closed to the remote server. * * @param ioSession the {@link org.apache.mina.core.IoSession} representing the connection to the server. * @see org.apache.mina.core.IoHandlerAdapter#sessionClosed(org.apache.mina.core.IoSession) */ public void sessionClosed(IoSession ioSession) throws Exception { //Clean up if any in-proccess decoding was occurring ioSession.removeAttribute(CURRENT_RESPONSE); // Remove ioSession from connection pool if the conneciton pool is available ConnectionPool connectionPool = getConnectionPool(); if (connectionPool != null) { connectionPool.removeSession(ioSession); } HttpRequestMessage request = (HttpRequestMessage) ioSession.getAttribute(CURRENT_REQUEST); AsyncHttpClient client = (AsyncHttpClient) ioSession.getAttachment(); // notify any interesting parties that this is starting client.notifyMonitoringListeners(MonitoringEvent.CONNECTION_CLOSED_BY_SERVER, request); AsyncHttpClientCallback callback = request.getCallback(); if (callback != null) { callback.onClosed(); } } @Override public void sessionIdle(IoSession session, IdleStatus status) { // complete the future which will also fire the callback HttpRequestMessage request = (HttpRequestMessage)session.getAttribute(CURRENT_REQUEST); // notify any interesting parties that this is starting AsyncHttpClient client = (AsyncHttpClient) session.getAttachment(); client.notifyMonitoringListeners(MonitoringEvent.REQUEST_TIMEOUT, request); ResponseFuture result = request.getResponseFuture(); result.setException(new TimeoutException()); session.close(); } }