KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > faces > context > ExternalContext


1 /*
2  * Copyright 2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package javax.faces.context;
17
18 import java.util.Iterator JavaDoc;
19 import java.util.Locale JavaDoc;
20 import java.util.Map JavaDoc;
21 import java.util.Set JavaDoc;
22
23 /**
24  * @author Manfred Geiler (latest modification by $Author: mwessendorf $)
25  * @version $Revision: 1.3 $ $Date: 2004/07/01 22:01:13 $
26  */
27 public abstract class ExternalContext
28 {
29     public static final String JavaDoc BASIC_AUTH = "BASIC";
30     public static final String JavaDoc CLIENT_CERT_AUTH = "CLIENT_CERT";
31     public static final String JavaDoc DIGEST_AUTH = "DIGEST";
32     public static final String JavaDoc FORM_AUTH = "FORM";
33
34     public abstract void dispatch(String JavaDoc path)
35             throws java.io.IOException JavaDoc;
36
37     public abstract String JavaDoc encodeActionURL(String JavaDoc url);
38
39     public abstract String JavaDoc encodeNamespace(String JavaDoc name);
40
41     public abstract String JavaDoc encodeResourceURL(String JavaDoc url);
42
43     public abstract Map JavaDoc getApplicationMap();
44
45     public abstract String JavaDoc getAuthType();
46
47     public abstract Object JavaDoc getContext();
48
49     public abstract String JavaDoc getInitParameter(String JavaDoc name);
50
51     public abstract Map JavaDoc getInitParameterMap();
52
53     public abstract String JavaDoc getRemoteUser();
54
55     public abstract Object JavaDoc getRequest();
56
57     public abstract String JavaDoc getRequestContextPath();
58
59     public abstract Map JavaDoc getRequestCookieMap();
60
61     public abstract Map JavaDoc getRequestHeaderMap();
62
63     public abstract Map JavaDoc getRequestHeaderValuesMap();
64
65     public abstract Locale JavaDoc getRequestLocale();
66
67     public abstract Iterator JavaDoc getRequestLocales();
68
69     public abstract Map JavaDoc getRequestMap();
70
71     public abstract Map JavaDoc getRequestParameterMap();
72
73     public abstract Iterator JavaDoc getRequestParameterNames();
74
75     public abstract Map JavaDoc getRequestParameterValuesMap();
76
77     public abstract String JavaDoc getRequestPathInfo();
78
79     public abstract String JavaDoc getRequestServletPath();
80
81     public abstract java.net.URL JavaDoc getResource(String JavaDoc path)
82             throws java.net.MalformedURLException JavaDoc;
83
84     public abstract java.io.InputStream JavaDoc getResourceAsStream(String JavaDoc path);
85
86     public abstract Set JavaDoc getResourcePaths(String JavaDoc path);
87
88     public abstract Object JavaDoc getResponse();
89
90     public abstract Object JavaDoc getSession(boolean create);
91
92     public abstract Map JavaDoc getSessionMap();
93
94     public abstract java.security.Principal JavaDoc getUserPrincipal();
95
96     public abstract boolean isUserInRole(String JavaDoc role);
97
98     public abstract void log(String JavaDoc message);
99
100     public abstract void log(String JavaDoc message,
101                              Throwable JavaDoc exception);
102
103     public abstract void redirect(String JavaDoc url)
104             throws java.io.IOException JavaDoc;
105 }
106
Popular Tags