1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36 package javax.resource.cci;
37
38 import java.util.Map;
39 import java.util.Collection;
40 import javax.resource.ResourceException;
41 import javax.resource.NotSupportedException;
42
43
44 /** The RecordFactory interface is used for creating MappedRecord and
45 * IndexedRecord instances. Note that the RecordFactory is only used
46 * for creation of generic record instances. A CCI implementation
47 * provides an implementation class for the RecordFactory interface.
48 *
49 * @author Rahul Sharma
50 * @since 0.8
51 * @see javax.resource.cci.IndexedRecord
52 * @see javax.resource.cci.MappedRecord
53 **/
54 public interface RecordFactory {
55
56 /** Creates a MappedRecord. The method takes the name of the record
57 * that is to be created by the RecordFactory. The name of the
58 * record acts as a pointer to the meta information (stored in
59 * the metadata repository) for a specific record type.
60 *
61 * @param recordName Name of the Record
62 * @return MappedRecord
63 * @throws ResourceException Failed to create a MappedRecord.
64 * Example error cases are:
65 *
66 * <UL>
67 * <LI> Invalid specification of record name
68 * <LI> Resource adapter internal error
69 * <LI> Failed to access metadata repository
70 * </UL>
71 * @throws NotSupportedException Operation not supported
72 *
73 **/
74 public
75 MappedRecord createMappedRecord(String recordName)
76 throws ResourceException;
77
78 /** Creates a IndexedRecord. The method takes the name of the record
79 * that is to be created by the RecordFactory. The name of the
80 * record acts as a pointer to the meta information (stored in
81 * the metadata repository) for a specific record type.
82 *
83 * @param recordName Name of the Record
84 * @return IndexedRecord
85 * @throws ResourceException Failed to create an IndexedRecord.
86 * Example error cases are:
87 *
88 * <UL>
89 * <LI> Invalid specification of record name
90 * <LI> Resource adapter internal error
91 * <LI> Failed to access metadata repository
92 * </UL>
93 * @throws NotSupportedException Operation not supported
94 **/
95 public
96 IndexedRecord createIndexedRecord(String recordName)
97 throws ResourceException;
98
99 }
100
Save This Page