1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
---|
2 | <!--NewPage--> |
---|
3 | <HTML> |
---|
4 | <HEAD> |
---|
5 | <!-- Generated by javadoc (build 1.6.0_07) on Tue Sep 01 20:56:55 UTC 2009 --> |
---|
6 | <TITLE> |
---|
7 | UnixUserGroupInformation (Hadoop 0.20.1 API) |
---|
8 | </TITLE> |
---|
9 | |
---|
10 | <META NAME="date" CONTENT="2009-09-01"> |
---|
11 | |
---|
12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
---|
13 | |
---|
14 | <SCRIPT type="text/javascript"> |
---|
15 | function windowTitle() |
---|
16 | { |
---|
17 | if (location.href.indexOf('is-external=true') == -1) { |
---|
18 | parent.document.title="UnixUserGroupInformation (Hadoop 0.20.1 API)"; |
---|
19 | } |
---|
20 | } |
---|
21 | </SCRIPT> |
---|
22 | <NOSCRIPT> |
---|
23 | </NOSCRIPT> |
---|
24 | |
---|
25 | </HEAD> |
---|
26 | |
---|
27 | <BODY BGCOLOR="white" onload="windowTitle();"> |
---|
28 | <HR> |
---|
29 | |
---|
30 | |
---|
31 | <!-- ========= START OF TOP NAVBAR ======= --> |
---|
32 | <A NAME="navbar_top"><!-- --></A> |
---|
33 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
---|
34 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
35 | <TR> |
---|
36 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
37 | <A NAME="navbar_top_firstrow"><!-- --></A> |
---|
38 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
39 | <TR ALIGN="center" VALIGN="top"> |
---|
40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
42 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/UnixUserGroupInformation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
48 | </TR> |
---|
49 | </TABLE> |
---|
50 | </TD> |
---|
51 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
52 | </EM> |
---|
53 | </TD> |
---|
54 | </TR> |
---|
55 | |
---|
56 | <TR> |
---|
57 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
58 | <A HREF="../../../../org/apache/hadoop/security/SecurityUtil.AccessControlList.html" title="class in org.apache.hadoop.security"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../org/apache/hadoop/security/User.html" title="class in org.apache.hadoop.security"><B>NEXT CLASS</B></A></FONT></TD> |
---|
60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
61 | <A HREF="../../../../index.html?org/apache/hadoop/security/UnixUserGroupInformation.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="UnixUserGroupInformation.html" target="_top"><B>NO FRAMES</B></A> |
---|
63 | <SCRIPT type="text/javascript"> |
---|
64 | <!-- |
---|
65 | if(window==top) { |
---|
66 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
67 | } |
---|
68 | //--> |
---|
69 | </SCRIPT> |
---|
70 | <NOSCRIPT> |
---|
71 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
72 | </NOSCRIPT> |
---|
73 | |
---|
74 | |
---|
75 | </FONT></TD> |
---|
76 | </TR> |
---|
77 | <TR> |
---|
78 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
79 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
82 | </TR> |
---|
83 | </TABLE> |
---|
84 | <A NAME="skip-navbar_top"></A> |
---|
85 | <!-- ========= END OF TOP NAVBAR ========= --> |
---|
86 | |
---|
87 | <HR> |
---|
88 | <!-- ======== START OF CLASS DATA ======== --> |
---|
89 | <H2> |
---|
90 | <FONT SIZE="-1"> |
---|
91 | org.apache.hadoop.security</FONT> |
---|
92 | <BR> |
---|
93 | Class UnixUserGroupInformation</H2> |
---|
94 | <PRE> |
---|
95 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
---|
96 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">org.apache.hadoop.security.UserGroupInformation</A> |
---|
97 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.security.UnixUserGroupInformation</B> |
---|
98 | </PRE> |
---|
99 | <DL> |
---|
100 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A>, <A HREF="../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A></DD> |
---|
101 | </DL> |
---|
102 | <HR> |
---|
103 | <DL> |
---|
104 | <DT><PRE>public class <B>UnixUserGroupInformation</B><DT>extends <A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">UserGroupInformation</A></DL> |
---|
105 | </PRE> |
---|
106 | |
---|
107 | <P> |
---|
108 | An implementation of UserGroupInformation in the Unix system |
---|
109 | <P> |
---|
110 | |
---|
111 | <P> |
---|
112 | <HR> |
---|
113 | |
---|
114 | <P> |
---|
115 | <!-- =========== FIELD SUMMARY =========== --> |
---|
116 | |
---|
117 | <A NAME="field_summary"><!-- --></A> |
---|
118 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
119 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
120 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
121 | <B>Field Summary</B></FONT></TH> |
---|
122 | </TR> |
---|
123 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
124 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
125 | <CODE>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
126 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#DEFAULT_GROUP">DEFAULT_GROUP</A></B></CODE> |
---|
127 | |
---|
128 | <BR> |
---|
129 | </TD> |
---|
130 | </TR> |
---|
131 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
132 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
133 | <CODE>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
134 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#DEFAULT_USERNAME">DEFAULT_USERNAME</A></B></CODE> |
---|
135 | |
---|
136 | <BR> |
---|
137 | </TD> |
---|
138 | </TR> |
---|
139 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
140 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
141 | <CODE>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
142 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#UGI_PROPERTY_NAME">UGI_PROPERTY_NAME</A></B></CODE> |
---|
143 | |
---|
144 | <BR> |
---|
145 | </TD> |
---|
146 | </TR> |
---|
147 | </TABLE> |
---|
148 | <A NAME="fields_inherited_from_class_org.apache.hadoop.security.UserGroupInformation"><!-- --></A> |
---|
149 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
150 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
151 | <TH ALIGN="left"><B>Fields inherited from class org.apache.hadoop.security.<A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">UserGroupInformation</A></B></TH> |
---|
152 | </TR> |
---|
153 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
154 | <TD><CODE><A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html#LOG">LOG</A></CODE></TD> |
---|
155 | </TR> |
---|
156 | </TABLE> |
---|
157 | |
---|
158 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
159 | |
---|
160 | <A NAME="constructor_summary"><!-- --></A> |
---|
161 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
162 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
163 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
164 | <B>Constructor Summary</B></FONT></TH> |
---|
165 | </TR> |
---|
166 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
167 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#UnixUserGroupInformation()">UnixUserGroupInformation</A></B>()</CODE> |
---|
168 | |
---|
169 | <BR> |
---|
170 | Default constructor</TD> |
---|
171 | </TR> |
---|
172 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
173 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#UnixUserGroupInformation(java.lang.String[])">UnixUserGroupInformation</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] ugi)</CODE> |
---|
174 | |
---|
175 | <BR> |
---|
176 | Constructor with parameter user/group names</TD> |
---|
177 | </TR> |
---|
178 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
179 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#UnixUserGroupInformation(java.lang.String, java.lang.String[])">UnixUserGroupInformation</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> userName, |
---|
180 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] groupNames)</CODE> |
---|
181 | |
---|
182 | <BR> |
---|
183 | Constructor with parameters user name and its group names.</TD> |
---|
184 | </TR> |
---|
185 | </TABLE> |
---|
186 | |
---|
187 | <!-- ========== METHOD SUMMARY =========== --> |
---|
188 | |
---|
189 | <A NAME="method_summary"><!-- --></A> |
---|
190 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
191 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
192 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
193 | <B>Method Summary</B></FONT></TH> |
---|
194 | </TR> |
---|
195 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
196 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
197 | <CODE>static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A></CODE></FONT></TD> |
---|
198 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#createImmutable(java.lang.String[])">createImmutable</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] ugi)</CODE> |
---|
199 | |
---|
200 | <BR> |
---|
201 | Create an immutable <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security"><CODE>UnixUserGroupInformation</CODE></A> object.</TD> |
---|
202 | </TR> |
---|
203 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
204 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
205 | <CODE> boolean</CODE></FONT></TD> |
---|
206 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE> |
---|
207 | |
---|
208 | <BR> |
---|
209 | Decide if two UGIs are the same</TD> |
---|
210 | </TR> |
---|
211 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
212 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
213 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
---|
214 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#getGroupNames()">getGroupNames</A></B>()</CODE> |
---|
215 | |
---|
216 | <BR> |
---|
217 | Return an array of group names</TD> |
---|
218 | </TR> |
---|
219 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
220 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
221 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
222 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#getName()">getName</A></B>()</CODE> |
---|
223 | |
---|
224 | <BR> |
---|
225 | </TD> |
---|
226 | </TR> |
---|
227 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
228 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
229 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
230 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#getUserName()">getUserName</A></B>()</CODE> |
---|
231 | |
---|
232 | <BR> |
---|
233 | Return the user's name</TD> |
---|
234 | </TR> |
---|
235 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
236 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
237 | <CODE> int</CODE></FONT></TD> |
---|
238 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#hashCode()">hashCode</A></B>()</CODE> |
---|
239 | |
---|
240 | <BR> |
---|
241 | Returns a hash code for this UGI.</TD> |
---|
242 | </TR> |
---|
243 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
244 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
245 | <CODE>static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A></CODE></FONT></TD> |
---|
246 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#login()">login</A></B>()</CODE> |
---|
247 | |
---|
248 | <BR> |
---|
249 | Get current user's name and the names of all its groups from Unix.</TD> |
---|
250 | </TR> |
---|
251 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
252 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
253 | <CODE>static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A></CODE></FONT></TD> |
---|
254 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#login(org.apache.hadoop.conf.Configuration)">login</A></B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf)</CODE> |
---|
255 | |
---|
256 | <BR> |
---|
257 | Equivalent to login(conf, false).</TD> |
---|
258 | </TR> |
---|
259 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
260 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
261 | <CODE>static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A></CODE></FONT></TD> |
---|
262 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#login(org.apache.hadoop.conf.Configuration, boolean)">login</A></B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf, |
---|
263 | boolean save)</CODE> |
---|
264 | |
---|
265 | <BR> |
---|
266 | Get a user's name & its group names from the given configuration; |
---|
267 | If it is not defined in the configuration, get the current user's |
---|
268 | information from Unix.</TD> |
---|
269 | </TR> |
---|
270 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
271 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
272 | <CODE> void</CODE></FONT></TD> |
---|
273 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#readFields(java.io.DataInput)">readFields</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A> in)</CODE> |
---|
274 | |
---|
275 | <BR> |
---|
276 | Deserialize this object |
---|
277 | First check if this is a UGI in the string format.</TD> |
---|
278 | </TR> |
---|
279 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
280 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
281 | <CODE>static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A></CODE></FONT></TD> |
---|
282 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#readFromConf(org.apache.hadoop.conf.Configuration, java.lang.String)">readFromConf</A></B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf, |
---|
283 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> attr)</CODE> |
---|
284 | |
---|
285 | <BR> |
---|
286 | Read a UGI from the given <code>conf</code> |
---|
287 | |
---|
288 | The object is expected to store with the property name <code>attr</code> |
---|
289 | as a comma separated string that starts |
---|
290 | with the user name followed by group names.</TD> |
---|
291 | </TR> |
---|
292 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
293 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
294 | <CODE>static void</CODE></FONT></TD> |
---|
295 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#saveToConf(org.apache.hadoop.conf.Configuration, java.lang.String, org.apache.hadoop.security.UnixUserGroupInformation)">saveToConf</A></B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf, |
---|
296 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> attr, |
---|
297 | <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A> ugi)</CODE> |
---|
298 | |
---|
299 | <BR> |
---|
300 | Store the given <code>ugi</code> as a comma separated string in |
---|
301 | <code>conf</code> as a property <code>attr</code> |
---|
302 | |
---|
303 | The String starts with the user name followed by the default group names, |
---|
304 | and other group names.</TD> |
---|
305 | </TR> |
---|
306 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
307 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
308 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
309 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#toString()">toString</A></B>()</CODE> |
---|
310 | |
---|
311 | <BR> |
---|
312 | Convert this object to a string</TD> |
---|
313 | </TR> |
---|
314 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
315 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
316 | <CODE> void</CODE></FONT></TD> |
---|
317 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#write(java.io.DataOutput)">write</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A> out)</CODE> |
---|
318 | |
---|
319 | <BR> |
---|
320 | Serialize this object |
---|
321 | First write a string marking that this is a UGI in the string format, |
---|
322 | then write this object's serialized form to the given data output</TD> |
---|
323 | </TR> |
---|
324 | </TABLE> |
---|
325 | <A NAME="methods_inherited_from_class_org.apache.hadoop.security.UserGroupInformation"><!-- --></A> |
---|
326 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
327 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
328 | <TH ALIGN="left"><B>Methods inherited from class org.apache.hadoop.security.<A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">UserGroupInformation</A></B></TH> |
---|
329 | </TR> |
---|
330 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
331 | <TD><CODE><A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html#getCurrentUGI()">getCurrentUGI</A>, <A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html#readFrom(org.apache.hadoop.conf.Configuration)">readFrom</A>, <A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html#setCurrentUGI(org.apache.hadoop.security.UserGroupInformation)">setCurrentUGI</A>, <A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html#setCurrentUser(org.apache.hadoop.security.UserGroupInformation)">setCurrentUser</A></CODE></TD> |
---|
332 | </TR> |
---|
333 | </TABLE> |
---|
334 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
335 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
336 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
337 | <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
---|
338 | </TR> |
---|
339 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
340 | <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
---|
341 | </TR> |
---|
342 | </TABLE> |
---|
343 | |
---|
344 | <P> |
---|
345 | |
---|
346 | <!-- ============ FIELD DETAIL =========== --> |
---|
347 | |
---|
348 | <A NAME="field_detail"><!-- --></A> |
---|
349 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
350 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
351 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
352 | <B>Field Detail</B></FONT></TH> |
---|
353 | </TR> |
---|
354 | </TABLE> |
---|
355 | |
---|
356 | <A NAME="DEFAULT_USERNAME"><!-- --></A><H3> |
---|
357 | DEFAULT_USERNAME</H3> |
---|
358 | <PRE> |
---|
359 | public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>DEFAULT_USERNAME</B></PRE> |
---|
360 | <DL> |
---|
361 | <DL> |
---|
362 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.hadoop.security.UnixUserGroupInformation.DEFAULT_USERNAME">Constant Field Values</A></DL> |
---|
363 | </DL> |
---|
364 | <HR> |
---|
365 | |
---|
366 | <A NAME="DEFAULT_GROUP"><!-- --></A><H3> |
---|
367 | DEFAULT_GROUP</H3> |
---|
368 | <PRE> |
---|
369 | public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>DEFAULT_GROUP</B></PRE> |
---|
370 | <DL> |
---|
371 | <DL> |
---|
372 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.hadoop.security.UnixUserGroupInformation.DEFAULT_GROUP">Constant Field Values</A></DL> |
---|
373 | </DL> |
---|
374 | <HR> |
---|
375 | |
---|
376 | <A NAME="UGI_PROPERTY_NAME"><!-- --></A><H3> |
---|
377 | UGI_PROPERTY_NAME</H3> |
---|
378 | <PRE> |
---|
379 | public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>UGI_PROPERTY_NAME</B></PRE> |
---|
380 | <DL> |
---|
381 | <DL> |
---|
382 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.hadoop.security.UnixUserGroupInformation.UGI_PROPERTY_NAME">Constant Field Values</A></DL> |
---|
383 | </DL> |
---|
384 | |
---|
385 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
386 | |
---|
387 | <A NAME="constructor_detail"><!-- --></A> |
---|
388 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
389 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
390 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
391 | <B>Constructor Detail</B></FONT></TH> |
---|
392 | </TR> |
---|
393 | </TABLE> |
---|
394 | |
---|
395 | <A NAME="UnixUserGroupInformation()"><!-- --></A><H3> |
---|
396 | UnixUserGroupInformation</H3> |
---|
397 | <PRE> |
---|
398 | public <B>UnixUserGroupInformation</B>()</PRE> |
---|
399 | <DL> |
---|
400 | <DD>Default constructor |
---|
401 | <P> |
---|
402 | </DL> |
---|
403 | <HR> |
---|
404 | |
---|
405 | <A NAME="UnixUserGroupInformation(java.lang.String, java.lang.String[])"><!-- --></A><H3> |
---|
406 | UnixUserGroupInformation</H3> |
---|
407 | <PRE> |
---|
408 | public <B>UnixUserGroupInformation</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> userName, |
---|
409 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] groupNames)</PRE> |
---|
410 | <DL> |
---|
411 | <DD>Constructor with parameters user name and its group names. |
---|
412 | The first entry in the groups list is the default group. |
---|
413 | <P> |
---|
414 | <DL> |
---|
415 | <DT><B>Parameters:</B><DD><CODE>userName</CODE> - a user's name<DD><CODE>groupNames</CODE> - groups list, first of which is the default group |
---|
416 | <DT><B>Throws:</B> |
---|
417 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any argument is null</DL> |
---|
418 | </DL> |
---|
419 | <HR> |
---|
420 | |
---|
421 | <A NAME="UnixUserGroupInformation(java.lang.String[])"><!-- --></A><H3> |
---|
422 | UnixUserGroupInformation</H3> |
---|
423 | <PRE> |
---|
424 | public <B>UnixUserGroupInformation</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] ugi)</PRE> |
---|
425 | <DL> |
---|
426 | <DD>Constructor with parameter user/group names |
---|
427 | <P> |
---|
428 | <DL> |
---|
429 | <DT><B>Parameters:</B><DD><CODE>ugi</CODE> - an array containing user/group names, the first |
---|
430 | element of which is the user name, the second of |
---|
431 | which is the default group name. |
---|
432 | <DT><B>Throws:</B> |
---|
433 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the array size is less than 2 |
---|
434 | or any element is null.</DL> |
---|
435 | </DL> |
---|
436 | |
---|
437 | <!-- ============ METHOD DETAIL ========== --> |
---|
438 | |
---|
439 | <A NAME="method_detail"><!-- --></A> |
---|
440 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
441 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
442 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
443 | <B>Method Detail</B></FONT></TH> |
---|
444 | </TR> |
---|
445 | </TABLE> |
---|
446 | |
---|
447 | <A NAME="createImmutable(java.lang.String[])"><!-- --></A><H3> |
---|
448 | createImmutable</H3> |
---|
449 | <PRE> |
---|
450 | public static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A> <B>createImmutable</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] ugi)</PRE> |
---|
451 | <DL> |
---|
452 | <DD>Create an immutable <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security"><CODE>UnixUserGroupInformation</CODE></A> object. |
---|
453 | <P> |
---|
454 | <DD><DL> |
---|
455 | </DL> |
---|
456 | </DD> |
---|
457 | </DL> |
---|
458 | <HR> |
---|
459 | |
---|
460 | <A NAME="getGroupNames()"><!-- --></A><H3> |
---|
461 | getGroupNames</H3> |
---|
462 | <PRE> |
---|
463 | public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>getGroupNames</B>()</PRE> |
---|
464 | <DL> |
---|
465 | <DD>Return an array of group names |
---|
466 | <P> |
---|
467 | <DD><DL> |
---|
468 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html#getGroupNames()">getGroupNames</A></CODE> in class <CODE><A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">UserGroupInformation</A></CODE></DL> |
---|
469 | </DD> |
---|
470 | <DD><DL> |
---|
471 | |
---|
472 | <DT><B>Returns:</B><DD>an array of group names</DL> |
---|
473 | </DD> |
---|
474 | </DL> |
---|
475 | <HR> |
---|
476 | |
---|
477 | <A NAME="getUserName()"><!-- --></A><H3> |
---|
478 | getUserName</H3> |
---|
479 | <PRE> |
---|
480 | public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getUserName</B>()</PRE> |
---|
481 | <DL> |
---|
482 | <DD>Return the user's name |
---|
483 | <P> |
---|
484 | <DD><DL> |
---|
485 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html#getUserName()">getUserName</A></CODE> in class <CODE><A HREF="../../../../org/apache/hadoop/security/UserGroupInformation.html" title="class in org.apache.hadoop.security">UserGroupInformation</A></CODE></DL> |
---|
486 | </DD> |
---|
487 | <DD><DL> |
---|
488 | |
---|
489 | <DT><B>Returns:</B><DD>the user's name</DL> |
---|
490 | </DD> |
---|
491 | </DL> |
---|
492 | <HR> |
---|
493 | |
---|
494 | <A NAME="readFields(java.io.DataInput)"><!-- --></A><H3> |
---|
495 | readFields</H3> |
---|
496 | <PRE> |
---|
497 | public void <B>readFields</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</A> in) |
---|
498 | throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
499 | <DL> |
---|
500 | <DD>Deserialize this object |
---|
501 | First check if this is a UGI in the string format. |
---|
502 | If no, throw an IOException; otherwise |
---|
503 | set this object's fields by reading them from the given data input |
---|
504 | <P> |
---|
505 | <DD><DL> |
---|
506 | <DT><B>Parameters:</B><DD><CODE>in</CODE> - input stream |
---|
507 | <DT><B>Throws:</B> |
---|
508 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - is thrown if encounter any error when reading</DL> |
---|
509 | </DD> |
---|
510 | </DL> |
---|
511 | <HR> |
---|
512 | |
---|
513 | <A NAME="write(java.io.DataOutput)"><!-- --></A><H3> |
---|
514 | write</H3> |
---|
515 | <PRE> |
---|
516 | public void <B>write</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</A> out) |
---|
517 | throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
518 | <DL> |
---|
519 | <DD>Serialize this object |
---|
520 | First write a string marking that this is a UGI in the string format, |
---|
521 | then write this object's serialized form to the given data output |
---|
522 | <P> |
---|
523 | <DD><DL> |
---|
524 | <DT><B>Parameters:</B><DD><CODE>out</CODE> - output stream |
---|
525 | <DT><B>Throws:</B> |
---|
526 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - if encounter any error during writing</DL> |
---|
527 | </DD> |
---|
528 | </DL> |
---|
529 | <HR> |
---|
530 | |
---|
531 | <A NAME="saveToConf(org.apache.hadoop.conf.Configuration, java.lang.String, org.apache.hadoop.security.UnixUserGroupInformation)"><!-- --></A><H3> |
---|
532 | saveToConf</H3> |
---|
533 | <PRE> |
---|
534 | public static void <B>saveToConf</B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf, |
---|
535 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> attr, |
---|
536 | <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A> ugi)</PRE> |
---|
537 | <DL> |
---|
538 | <DD>Store the given <code>ugi</code> as a comma separated string in |
---|
539 | <code>conf</code> as a property <code>attr</code> |
---|
540 | |
---|
541 | The String starts with the user name followed by the default group names, |
---|
542 | and other group names. |
---|
543 | <P> |
---|
544 | <DD><DL> |
---|
545 | <DT><B>Parameters:</B><DD><CODE>conf</CODE> - configuration<DD><CODE>attr</CODE> - property name<DD><CODE>ugi</CODE> - a UnixUserGroupInformation</DL> |
---|
546 | </DD> |
---|
547 | </DL> |
---|
548 | <HR> |
---|
549 | |
---|
550 | <A NAME="readFromConf(org.apache.hadoop.conf.Configuration, java.lang.String)"><!-- --></A><H3> |
---|
551 | readFromConf</H3> |
---|
552 | <PRE> |
---|
553 | public static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A> <B>readFromConf</B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf, |
---|
554 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> attr) |
---|
555 | throws <A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></PRE> |
---|
556 | <DL> |
---|
557 | <DD>Read a UGI from the given <code>conf</code> |
---|
558 | |
---|
559 | The object is expected to store with the property name <code>attr</code> |
---|
560 | as a comma separated string that starts |
---|
561 | with the user name followed by group names. |
---|
562 | If the property name is not defined, return null. |
---|
563 | It's assumed that there is only one UGI per user. If this user already |
---|
564 | has a UGI in the ugi map, return the ugi in the map. |
---|
565 | Otherwise, construct a UGI from the configuration, store it in the |
---|
566 | ugi map and return it. |
---|
567 | <P> |
---|
568 | <DD><DL> |
---|
569 | <DT><B>Parameters:</B><DD><CODE>conf</CODE> - configuration<DD><CODE>attr</CODE> - property name |
---|
570 | <DT><B>Returns:</B><DD>a UnixUGI |
---|
571 | <DT><B>Throws:</B> |
---|
572 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></CODE> - if the stored string is ill-formatted.</DL> |
---|
573 | </DD> |
---|
574 | </DL> |
---|
575 | <HR> |
---|
576 | |
---|
577 | <A NAME="login()"><!-- --></A><H3> |
---|
578 | login</H3> |
---|
579 | <PRE> |
---|
580 | public static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A> <B>login</B>() |
---|
581 | throws <A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></PRE> |
---|
582 | <DL> |
---|
583 | <DD>Get current user's name and the names of all its groups from Unix. |
---|
584 | It's assumed that there is only one UGI per user. If this user already |
---|
585 | has a UGI in the ugi map, return the ugi in the map. |
---|
586 | Otherwise get the current user's information from Unix, store it |
---|
587 | in the map, and return it. |
---|
588 | |
---|
589 | If the current user's UNIX username or groups are configured in such a way |
---|
590 | to throw an Exception, for example if the user uses LDAP, then this method |
---|
591 | will use a the <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#DEFAULT_USERNAME"><CODE>DEFAULT_USERNAME</CODE></A> and <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html#DEFAULT_GROUP"><CODE>DEFAULT_GROUP</CODE></A> |
---|
592 | constants. |
---|
593 | <P> |
---|
594 | <DD><DL> |
---|
595 | |
---|
596 | <DT><B>Throws:</B> |
---|
597 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></CODE></DL> |
---|
598 | </DD> |
---|
599 | </DL> |
---|
600 | <HR> |
---|
601 | |
---|
602 | <A NAME="login(org.apache.hadoop.conf.Configuration)"><!-- --></A><H3> |
---|
603 | login</H3> |
---|
604 | <PRE> |
---|
605 | public static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A> <B>login</B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf) |
---|
606 | throws <A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></PRE> |
---|
607 | <DL> |
---|
608 | <DD>Equivalent to login(conf, false). |
---|
609 | <P> |
---|
610 | <DD><DL> |
---|
611 | |
---|
612 | <DT><B>Throws:</B> |
---|
613 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></CODE></DL> |
---|
614 | </DD> |
---|
615 | </DL> |
---|
616 | <HR> |
---|
617 | |
---|
618 | <A NAME="login(org.apache.hadoop.conf.Configuration, boolean)"><!-- --></A><H3> |
---|
619 | login</H3> |
---|
620 | <PRE> |
---|
621 | public static <A HREF="../../../../org/apache/hadoop/security/UnixUserGroupInformation.html" title="class in org.apache.hadoop.security">UnixUserGroupInformation</A> <B>login</B>(<A HREF="../../../../org/apache/hadoop/conf/Configuration.html" title="class in org.apache.hadoop.conf">Configuration</A> conf, |
---|
622 | boolean save) |
---|
623 | throws <A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></PRE> |
---|
624 | <DL> |
---|
625 | <DD>Get a user's name & its group names from the given configuration; |
---|
626 | If it is not defined in the configuration, get the current user's |
---|
627 | information from Unix. |
---|
628 | If the user has a UGI in the ugi map, return the one in |
---|
629 | the UGI map. |
---|
630 | <P> |
---|
631 | <DD><DL> |
---|
632 | <DT><B>Parameters:</B><DD><CODE>conf</CODE> - either a job configuration or client's configuration<DD><CODE>save</CODE> - saving it to conf? |
---|
633 | <DT><B>Returns:</B><DD>UnixUserGroupInformation a user/group information |
---|
634 | <DT><B>Throws:</B> |
---|
635 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/security/auth/login/LoginException.html?is-external=true" title="class or interface in javax.security.auth.login">LoginException</A></CODE> - if not able to get the user/group information</DL> |
---|
636 | </DD> |
---|
637 | </DL> |
---|
638 | <HR> |
---|
639 | |
---|
640 | <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
---|
641 | equals</H3> |
---|
642 | <PRE> |
---|
643 | public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE> |
---|
644 | <DL> |
---|
645 | <DD>Decide if two UGIs are the same |
---|
646 | <P> |
---|
647 | <DD><DL> |
---|
648 | <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/Principal.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.security">equals</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> |
---|
649 | </DD> |
---|
650 | <DD><DL> |
---|
651 | <DT><B>Parameters:</B><DD><CODE>other</CODE> - other object |
---|
652 | <DT><B>Returns:</B><DD>true if they are the same; false otherwise.</DL> |
---|
653 | </DD> |
---|
654 | </DL> |
---|
655 | <HR> |
---|
656 | |
---|
657 | <A NAME="hashCode()"><!-- --></A><H3> |
---|
658 | hashCode</H3> |
---|
659 | <PRE> |
---|
660 | public int <B>hashCode</B>()</PRE> |
---|
661 | <DL> |
---|
662 | <DD>Returns a hash code for this UGI. |
---|
663 | The hash code for a UGI is the hash code of its user name string. |
---|
664 | <P> |
---|
665 | <DD><DL> |
---|
666 | <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/Principal.html?is-external=true#hashCode()" title="class or interface in java.security">hashCode</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> |
---|
667 | </DD> |
---|
668 | <DD><DL> |
---|
669 | |
---|
670 | <DT><B>Returns:</B><DD>a hash code value for this UGI.</DL> |
---|
671 | </DD> |
---|
672 | </DL> |
---|
673 | <HR> |
---|
674 | |
---|
675 | <A NAME="toString()"><!-- --></A><H3> |
---|
676 | toString</H3> |
---|
677 | <PRE> |
---|
678 | public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> |
---|
679 | <DL> |
---|
680 | <DD>Convert this object to a string |
---|
681 | <P> |
---|
682 | <DD><DL> |
---|
683 | <DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/Principal.html?is-external=true#toString()" title="class or interface in java.security">toString</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> |
---|
684 | </DD> |
---|
685 | <DD><DL> |
---|
686 | |
---|
687 | <DT><B>Returns:</B><DD>a comma separated string containing the user name and group names</DL> |
---|
688 | </DD> |
---|
689 | </DL> |
---|
690 | <HR> |
---|
691 | |
---|
692 | <A NAME="getName()"><!-- --></A><H3> |
---|
693 | getName</H3> |
---|
694 | <PRE> |
---|
695 | public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE> |
---|
696 | <DL> |
---|
697 | <DD><DL> |
---|
698 | </DL> |
---|
699 | </DD> |
---|
700 | </DL> |
---|
701 | <!-- ========= END OF CLASS DATA ========= --> |
---|
702 | <HR> |
---|
703 | |
---|
704 | |
---|
705 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
706 | <A NAME="navbar_bottom"><!-- --></A> |
---|
707 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
708 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
709 | <TR> |
---|
710 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
711 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
712 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
713 | <TR ALIGN="center" VALIGN="top"> |
---|
714 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
715 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
716 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
717 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/UnixUserGroupInformation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
718 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
719 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
720 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
721 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
722 | </TR> |
---|
723 | </TABLE> |
---|
724 | </TD> |
---|
725 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
726 | </EM> |
---|
727 | </TD> |
---|
728 | </TR> |
---|
729 | |
---|
730 | <TR> |
---|
731 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
732 | <A HREF="../../../../org/apache/hadoop/security/SecurityUtil.AccessControlList.html" title="class in org.apache.hadoop.security"><B>PREV CLASS</B></A> |
---|
733 | <A HREF="../../../../org/apache/hadoop/security/User.html" title="class in org.apache.hadoop.security"><B>NEXT CLASS</B></A></FONT></TD> |
---|
734 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
735 | <A HREF="../../../../index.html?org/apache/hadoop/security/UnixUserGroupInformation.html" target="_top"><B>FRAMES</B></A> |
---|
736 | <A HREF="UnixUserGroupInformation.html" target="_top"><B>NO FRAMES</B></A> |
---|
737 | <SCRIPT type="text/javascript"> |
---|
738 | <!-- |
---|
739 | if(window==top) { |
---|
740 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
741 | } |
---|
742 | //--> |
---|
743 | </SCRIPT> |
---|
744 | <NOSCRIPT> |
---|
745 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
746 | </NOSCRIPT> |
---|
747 | |
---|
748 | |
---|
749 | </FONT></TD> |
---|
750 | </TR> |
---|
751 | <TR> |
---|
752 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
753 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
754 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
755 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
756 | </TR> |
---|
757 | </TABLE> |
---|
758 | <A NAME="skip-navbar_bottom"></A> |
---|
759 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
760 | |
---|
761 | <HR> |
---|
762 | Copyright © 2009 The Apache Software Foundation |
---|
763 | </BODY> |
---|
764 | </HTML> |
---|