001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.resiliency.spi.agent;
016    
017    import com.liferay.portal.kernel.resiliency.PortalResiliencyException;
018    import com.liferay.portal.kernel.resiliency.spi.SPI;
019    
020    import java.io.IOException;
021    
022    import javax.servlet.http.HttpServletRequest;
023    import javax.servlet.http.HttpServletResponse;
024    
025    /**
026     * @author Shuyang Zhou
027     */
028    public interface SPIAgent {
029    
030            public void destroy();
031    
032            public void init(SPI spi) throws PortalResiliencyException;
033    
034            public HttpServletRequest prepareRequest(HttpServletRequest request)
035                    throws IOException;
036    
037            public HttpServletResponse prepareResponse(
038                    HttpServletRequest request, HttpServletResponse response);
039    
040            public void service(
041                            HttpServletRequest request, HttpServletResponse response)
042                    throws PortalResiliencyException;
043    
044            public void transferResponse(
045                            HttpServletRequest request, HttpServletResponse response,
046                            Exception e)
047                    throws IOException;
048    
049            public enum Lifecycle {
050    
051                    ACTION("0"), EVENT("1"), RENDER("2"), RESOURCE("3");
052    
053                    public String getValue() {
054                            return _value;
055                    }
056    
057                    private Lifecycle(String value) {
058                            _value = value;
059                    }
060    
061                    private String _value;
062    
063            }
064    
065    }