KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > clif > protocol > http > lib > HttpUserSessionAttribute


1 /*
2 * CLIF is a Load Injection Framework
3 * Copyright (C) 2003 France Telecom R&D
4 * Copyright (C) 2003 INRIA
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * CLIF $Name: $
21 *
22 * Contact: clif@objectweb.org
23 *
24 * @authors: Julien Buret
25 * @authors: Nicolas Droze
26 */
27
28 package org.objectweb.clif.protocol.http.lib;
29
30 import org.objectweb.fractal.api.control.AttributeController;
31
32 /**
33  * Configuration parameters
34  *
35  * followRedirect: httpClient Configuration
36  * connectionKeepAlive: httpClient Configuration
37  *
38  * retrieveImage: Retrieve image of a page
39  * retrieveApplet: Retrieve Applet of a page
40  *
41  * saveHeader: Save Header of a response in the ActionReport
42  * saveBody: Save the resultPage in the actionReport
43  * saveImage: Save image and applet in the actionReport (avoid this)
44  *
45  */
46 public interface HttpUserSessionAttribute extends AttributeController {
47
48     /**
49      * Return true if the redirection mode is set for this session.
50      * @return
51      */
52     boolean getFollowRedirect();
53     /**
54      * HTTP Client configuration to set the redirection mode.
55      * @param followRedirect
56      */
57     void setFollowRedirect(boolean followRedirect);
58
59     /**
60      * Return true if the connection keep alive mode is set for this session.
61      * @return
62      */
63     boolean getConnectionKeepAlive();
64     /**
65      * HTTP Client configuration to sets the connection keep alive mode.
66      * @param connectionKeepAlive
67      */
68     void setConnectionKeepAlive(boolean connectionKeepAlive);
69
70     /**
71      * Return true if the configuration is set to retrieve all images.
72      * @return
73      */
74     boolean getRetrieveImage();
75     /**
76      * Sets a boolean to retrieve all images from a page.
77      * @param retrieveImage
78      */
79     void setRetrieveImage(boolean retrieveImage);
80
81     /**
82      * Return true if the configuration is set to retrieve all applets.
83      * @return
84      */
85     boolean getRetrieveApplet();
86     /**
87      * Sets a boolean to retrieve all applets from a page.
88      * @param retrieveApplet
89      */
90     void setRetrieveApplet(boolean retrieveApplet);
91
92     /**
93      * Return true if the session is configured to save the headers in the reports.
94      * @return
95      */
96     boolean getSaveHeader();
97     /**
98      * Configure this session to save HTTP header in the reports.
99      * @param saveHeader
100      */
101     void setSaveHeader(boolean saveHeader);
102
103     /**
104      * Return true if the session is configured to save the body in the reports.
105      * @return
106      */
107     boolean getSaveBody();
108     /**
109      * Configure this session to save HTTP body in the reports.
110      * @param saveBody
111      */
112     void setSaveBody(boolean saveBody);
113
114     /**
115      * Return true if the session is configured to save the images in the reports.
116      * @return
117      */
118     boolean getSaveImage();
119     /**
120      * Configure this session to save the images in the reports.
121      * @param saveImage
122      */
123     void setSaveImage(boolean saveImage);
124 }
125
Popular Tags