KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > icesoft > faces > env > CommonEnvironmentRequest


1 /*
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * "The contents of this file are subject to the Mozilla Public License
5  * Version 1.1 (the "License"); you may not use this file except in
6  * compliance with the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
11  * License for the specific language governing rights and limitations under
12  * the License.
13  *
14  * The Original Code is ICEfaces 1.5 open source software code, released
15  * November 5, 2006. The Initial Developer of the Original Code is ICEsoft
16  * Technologies Canada, Corp. Portions created by ICEsoft are Copyright (C)
17  * 2004-2006 ICEsoft Technologies Canada, Corp. All Rights Reserved.
18  *
19  * Contributor(s): _____________________.
20  *
21  * Alternatively, the contents of this file may be used under the terms of
22  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"
23  * License), in which case the provisions of the LGPL License are
24  * applicable instead of those above. If you wish to allow use of your
25  * version of this file only under the terms of the LGPL License and not to
26  * allow others to use your version of this file under the MPL, indicate
27  * your decision by deleting the provisions above and replace them with
28  * the notice and other provisions required by the LGPL License. If you do
29  * not delete the provisions above, a recipient may use your version of
30  * this file under either the MPL or the LGPL License."
31  *
32  */

33
34 package com.icesoft.faces.env;
35
36 import java.security.Principal JavaDoc;
37 import java.util.Enumeration JavaDoc;
38 import java.util.Hashtable JavaDoc;
39 import java.util.Locale JavaDoc;
40 import java.util.Vector JavaDoc;
41
42 /**
43  * This is an abstract class that contains fields and method implementations
44  * that are common to any request type class that is environmentally dependent.
45  * Currently this includes both servlets (ServletEnvironmentRequest) and
46  * portlets (PortletEnvironmentRequest).
47  */

48 public abstract class CommonEnvironmentRequest {
49
50     //Commmon members
51
protected String JavaDoc authType;
52     protected String JavaDoc remoteUser;
53     protected Principal JavaDoc userPrincipal;
54     protected String JavaDoc requestedSessionId;
55     protected boolean isRequestedSessionIdValid;
56     protected String JavaDoc scheme;
57     protected String JavaDoc serverName;
58     protected int serverPort;
59     protected Locale JavaDoc locale;
60     protected boolean isSecure;
61     protected Hashtable JavaDoc attributes;
62     protected Hashtable JavaDoc parameters;
63     protected String JavaDoc contextPath;
64     protected Vector JavaDoc locales;
65
66     /**
67      * Common HttpServletRequest/PortletRequest methods
68      */

69
70     public String JavaDoc getAuthType() {
71         return authType;
72     }
73
74     public String JavaDoc getContextPath() {
75         return contextPath;
76     }
77
78     public String JavaDoc getRemoteUser() {
79         return remoteUser;
80     }
81
82     public abstract boolean isUserInRole(String JavaDoc role);
83
84     public Principal JavaDoc getUserPrincipal() {
85         return userPrincipal;
86     }
87
88     public String JavaDoc getRequestedSessionId() {
89         return requestedSessionId;
90     }
91
92     public boolean isRequestedSessionIdValid() {
93         return isRequestedSessionIdValid;
94     }
95
96     public Object JavaDoc getAttribute(String JavaDoc name) {
97         return attributes.get(name);
98     }
99
100     public Enumeration JavaDoc getAttributeNames() {
101         return attributes.keys();
102     }
103
104     public String JavaDoc getParameter(String JavaDoc name) {
105         Object JavaDoc o = parameters.get(name);
106         if (o instanceof String JavaDoc[]) {
107             return ((String JavaDoc[])o)[0];
108         } else {
109             return (String JavaDoc) o;
110         }
111     }
112
113     public Enumeration JavaDoc getParameterNames() {
114         return parameters.keys();
115     }
116
117     public String JavaDoc[] getParameterValues(String JavaDoc name) {
118         return (String JavaDoc[]) parameters.get(name);
119     }
120
121     public java.util.Map JavaDoc getParameterMap() {
122         return parameters;
123     }
124
125     public String JavaDoc getScheme() {
126         return scheme;
127     }
128
129     public String JavaDoc getServerName() {
130         return serverName;
131     }
132
133     public int getServerPort() {
134         return serverPort;
135     }
136
137     public void setAttribute(String JavaDoc name, Object JavaDoc value) {
138         if (null == value) {
139             attributes.remove(name);
140         } else {
141             attributes.put(name, value);
142         }
143     }
144
145     public void removeAttribute(String JavaDoc name) {
146         attributes.remove(name);
147     }
148
149     public Locale JavaDoc getLocale() {
150         return locale;
151     }
152
153     public Enumeration JavaDoc getLocales() {
154         return locales.elements();
155     }
156
157     public boolean isSecure() {
158         return isSecure;
159     }
160
161 }
162
Popular Tags