← Back to branch summary

~krause/owl-dicml/trunk

« back to all changes in this revision

Viewing changes to gidooXMLDB/lib/Derby_10.4/jdbc4/org/apache/derby/authentication/UserAuthenticator.html

  • Committer: tho.krause
  • Date: 2009-09-13 12:19:17 UTC
  • Revision ID: vcs-imports@canonical.com-20090913121917-ng9ur6t34u7903z9
-see previous commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
gidooXMLDB/lib/Derby_10.4/jdbc4/org/apache/derby/authentication/UserAuthenticator.html
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_01-dp) on Tue Aug 26 06:30:04 PDT 2008 -->
6
 
<TITLE>
7
 
UserAuthenticator (Apache Derby 10.4 API Documentation)
8
 
</TITLE>
9
 
 
10
 
<META NAME="date" CONTENT="2008-08-26">
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="UserAuthenticator (Apache Derby 10.4 API Documentation)";
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>&nbsp;</TD>
41
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47
 
  </TR>
48
 
</TABLE>
49
 
</TD>
50
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51
 
Apache Derby 10.4</EM>
52
 
</TD>
53
 
</TR>
54
 
 
55
 
<TR>
56
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57
 
&nbsp;PREV CLASS&nbsp;
58
 
&nbsp;NEXT CLASS</FONT></TD>
59
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60
 
  <A HREF="../../../../index.html?org/apache/derby/authentication/UserAuthenticator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61
 
&nbsp;<A HREF="UserAuthenticator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62
 
&nbsp;<SCRIPT type="text/javascript">
63
 
  <!--
64
 
  if(window==top) {
65
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66
 
  }
67
 
  //-->
68
 
</SCRIPT>
69
 
<NOSCRIPT>
70
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
71
 
</NOSCRIPT>
72
 
 
73
 
 
74
 
</FONT></TD>
75
 
</TR>
76
 
<TR>
77
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81
 
</TR>
82
 
</TABLE>
83
 
<A NAME="skip-navbar_top"></A>
84
 
<!-- ========= END OF TOP NAVBAR ========= -->
85
 
 
86
 
<HR>
87
 
<!-- ======== START OF CLASS DATA ======== -->
88
 
<H2>
89
 
<FONT SIZE="-1">
90
 
org.apache.derby.authentication</FONT>
91
 
<BR>
92
 
Interface UserAuthenticator</H2>
93
 
<HR>
94
 
<DL>
95
 
<DT><PRE>public interface <B>UserAuthenticator</B></DL>
96
 
</PRE>
97
 
 
98
 
<P>
99
 
The UserAuthenticator interface provides operations to authenticate
100
 
 a user's credentials in order to successfully connect to a database.
101
 
 
102
 
 Any user authentication schemes could be implemented using this interface
103
 
 and registered at start-up time.
104
 
 <p>
105
 
 If an application requires its own authentication scheme, then it can
106
 
 implement this interface and register as the authentication scheme
107
 
 that Derby should call upon connection requests to the system.
108
 
   See the dcoumentation for the property <I>derby.authentication.provider</I>
109
 
 <p>
110
 
 A typical example would be to implement user authentication using
111
 
 LDAP, Sun NIS+, or even Windows User Domain, using this interface.
112
 
 <p>
113
 
 <i>Note</i>: Additional connection attributes can be specified on the 
114
 
 database connection URL and/or Properties object on jdbc connection. Values
115
 
 for these attributes can be retrieved at runtime by the (specialized)
116
 
 authentication scheme to further help user authentication, if one needs
117
 
 additional info other than user, password, and database name.
118
 
<P>
119
 
 
120
 
<P>
121
 
<HR>
122
 
 
123
 
<P>
124
 
 
125
 
<!-- ========== METHOD SUMMARY =========== -->
126
 
 
127
 
<A NAME="method_summary"><!-- --></A>
128
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
130
 
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
131
 
<B>Method Summary</B></FONT></TH>
132
 
</TR>
133
 
<TR BGCOLOR="white" CLASS="TableRowColor">
134
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135
 
<CODE>&nbsp;boolean</CODE></FONT></TD>
136
 
<TD><CODE><B><A HREF="../../../../org/apache/derby/authentication/UserAuthenticator.html#authenticateUser(java.lang.String, java.lang.String, java.lang.String, java.util.Properties)">authenticateUser</A></B>(java.lang.String&nbsp;userName,
137
 
                 java.lang.String&nbsp;userPassword,
138
 
                 java.lang.String&nbsp;databaseName,
139
 
                 java.util.Properties&nbsp;info)</CODE>
140
 
 
141
 
<BR>
142
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Authenticate a user's credentials.</TD>
143
 
</TR>
144
 
</TABLE>
145
 
&nbsp;
146
 
<P>
147
 
 
148
 
<!-- ============ METHOD DETAIL ========== -->
149
 
 
150
 
<A NAME="method_detail"><!-- --></A>
151
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153
 
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
154
 
<B>Method Detail</B></FONT></TH>
155
 
</TR>
156
 
</TABLE>
157
 
 
158
 
<A NAME="authenticateUser(java.lang.String, java.lang.String, java.lang.String, java.util.Properties)"><!-- --></A><H3>
159
 
authenticateUser</H3>
160
 
<PRE>
161
 
boolean <B>authenticateUser</B>(java.lang.String&nbsp;userName,
162
 
                         java.lang.String&nbsp;userPassword,
163
 
                         java.lang.String&nbsp;databaseName,
164
 
                         java.util.Properties&nbsp;info)
165
 
                         throws java.sql.SQLException</PRE>
166
 
<DL>
167
 
<DD>Authenticate a user's credentials.
168
 
 <BR>
169
 
 E.g. if connection url is 
170
 
 <code>jdbc:derby:testdb;user=Fred;password=ScT7dmM2</code>
171
 
 then the userName will be Fred and within the Derby user authorization 
172
 
 system, Fred becomes a case-insensitive authorization identifier and 
173
 
 is known as FRED
174
 
<BR>
175
 
 if connection url is 
176
 
 <code>jdbc:derby:testdb;user="Fred";password=ScT7dmM2</code>
177
 
 then the userName will be "Fred" and within the Derby user authorization
178
 
 system, Fred becomes a case-sensitive authorization identifier and is
179
 
 known as Fred
180
 
 <BR>
181
 
<P>
182
 
<DD><DL>
183
 
<DT><B>Parameters:</B><DD><CODE>userName</CODE> - The user's name for the connection request. May be 
184
 
                      null.  The user name is passed in as is from the 
185
 
                      connection request.
186
 
                      Derby will pass in the user name that is set on
187
 
                      connection request as is, without changing the 
188
 
                      casing and without removing the delimiter quotes 
189
 
                      if any.<DD><CODE>userPassword</CODE> - The user's password for the connection request. 
190
 
                      May be null.<DD><CODE>databaseName</CODE> - The database that the user wants to connect to.
191
 
                                                Will be null if this is system level authentication.<DD><CODE>info</CODE> - A Properties object that contains additional 
192
 
                      connection information, that can help to 
193
 
                      authenticate the user. It has properties of the 
194
 
                      'info' object passed as part of 
195
 
                      DriverManager.getConnection() call and any 
196
 
                      attributes set on the JDBC URL.
197
 
<DT><B>Returns:</B><DD>false if the connection request should be denied, true if the 
198
 
          connection request should proceed.  If false is returned the 
199
 
          connection attempt will receive a SQLException with SQL State 
200
 
          08004.
201
 
<DT><B>Throws:</B>
202
 
<DD><CODE>java.sql.SQLException</CODE> - An exception processing the request, 
203
 
            connection request will be denied.  The SQL exception will 
204
 
            be returned to the connection attempt.</DL>
205
 
</DD>
206
 
</DL>
207
 
<!-- ========= END OF CLASS DATA ========= -->
208
 
<HR>
209
 
 
210
 
 
211
 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
212
 
<A NAME="navbar_bottom"><!-- --></A>
213
 
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
214
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
215
 
<TR>
216
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
217
 
<A NAME="navbar_bottom_firstrow"><!-- --></A>
218
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
219
 
  <TR ALIGN="center" VALIGN="top">
220
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
221
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
222
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
223
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
224
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
225
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
226
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
227
 
  </TR>
228
 
</TABLE>
229
 
</TD>
230
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
231
 
Built on Tue 2008-08-26 06:30:01-0700, from revision 689064</EM>
232
 
</TD>
233
 
</TR>
234
 
 
235
 
<TR>
236
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
237
 
&nbsp;PREV CLASS&nbsp;
238
 
&nbsp;NEXT CLASS</FONT></TD>
239
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
240
 
  <A HREF="../../../../index.html?org/apache/derby/authentication/UserAuthenticator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
241
 
&nbsp;<A HREF="UserAuthenticator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
242
 
&nbsp;<SCRIPT type="text/javascript">
243
 
  <!--
244
 
  if(window==top) {
245
 
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
246
 
  }
247
 
  //-->
248
 
</SCRIPT>
249
 
<NOSCRIPT>
250
 
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
251
 
</NOSCRIPT>
252
 
 
253
 
 
254
 
</FONT></TD>
255
 
</TR>
256
 
<TR>
257
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
258
 
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
259
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
260
 
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
261
 
</TR>
262
 
</TABLE>
263
 
<A NAME="skip-navbar_bottom"></A>
264
 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
265
 
 
266
 
<HR>
267
 
Apache Derby 10.4 API Documentation  -  <i>Copyright &copy; 2004,2008 The Apache Software Foundation. All Rights Reserved.</i>
268
 
</BODY>
269
 
</HTML>