Initial import of JDBC Data Connector code from Dave Dearmon (after some small format...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / provider / JDBCAttributeExtractor.java
1 /*
2  * Copyright (c) 2003 National Research Council of Canada
3  *
4  * Permission is hereby granted, free of charge, to any person 
5  * obtaining a copy of this software and associated documentation 
6  * files (the "Software"), to deal in the Software without 
7  * restriction, including without limitation the rights to use, 
8  * copy, modify, merge, publish, distribute, sublicense, and/or 
9  * sell copies of the Software, and to permit persons to whom the 
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be 
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 
17  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
19  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
20  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  */
25
26 package edu.internet2.middleware.shibboleth.aa.attrresolv.provider;
27
28 import java.sql.ResultSet;
29
30 import javax.naming.directory.BasicAttributes;
31
32 /*
33  * Built at the Canada Institute for Scientific and Technical Information (CISTI 
34  * <ahref="http://www.cisti-icist.nrc-cnrc.gc.ca/">http://www.cisti-icist.nrc-cnrc.gc.ca/</a>, 
35  * the National Research Council Canada 
36  * (NRC <a href="http://www.nrc-cnrc.gc.ca/">http://www.nrc-cnrc.gc.ca/</a>)
37  * by David Dearman, COOP student from Dalhousie University,
38  * under the direction of Glen Newton, Head research (IT)
39  * <ahref="mailto:glen.newton@nrc-cnrc.gc.ca">glen.newton@nrc-cnrc.gc.ca</a>. 
40  */
41
42 /**
43  * Definition for the JDBC attribute extractor. 
44  * 
45  * @author David Dearman (dearman@cs.dal.ca)
46  * @version 1.0 July 24, 2003
47  *
48  */
49
50 public interface JDBCAttributeExtractor {
51
52         /**
53          * Method of extracting the attributes from the supplied result set.
54          *
55          * @param ResultSet The result set from the query which contains the attributes
56          * @return BasicAttributes as objects containing all the attributes
57          * @throws JDBCAttributeExtractorException If there is a complication in retrieving the attributes
58          */
59         public BasicAttributes extractAttributes(ResultSet rs) throws JDBCAttributeExtractorException;
60
61 }