KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > deployment > JndiNameEnvironment


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23 package com.sun.enterprise.deployment;
24
25 import java.util.*;
26
27     /**
28     * Objects implementing this interface allow their
29     * environment properties, ejb references and resource
30     * references to be read.
31     *
32     *@author Danny Coward
33     */

34
35 public interface JndiNameEnvironment {
36
37     /**
38      * Return a set of environment properties.
39      *
40      * @return java.util.Set of EnvironmentProperty objects
41      */

42     public Set getEnvironmentProperties();
43
44
45     /**
46      * Return the env-entry with the given name
47      *
48      * @return EnvironmentProperty descriptor
49      */

50     public EnvironmentProperty getEnvironmentPropertyByName(String JavaDoc name);
51     
52     /**
53      * Return a set of ejb reference descriptors.
54      *
55      * @return java.util.Set of EjbReferenceDescriptor objects
56      */

57     public Set getEjbReferenceDescriptors();
58
59 /**
60      * Return a set of service reference descriptors.
61      *
62      * @return java.util.Set of ServiceReferenceDescriptor objects
63      */

64     
65     public Set getServiceReferenceDescriptors();
66     
67      
68     /**
69      * Return the Service reference descriptor corresponding to
70      * the given name.
71      *
72      * @return ServiceReferenceDescriptor object
73      */

74     public ServiceReferenceDescriptor getServiceReferenceByName(String JavaDoc name);
75     
76     /**
77      * Return a set of resource reference descriptors.
78      *
79      * @return java.util.Set of ResourceReferenceDescriptor objects
80      */

81     
82     public Set getResourceReferenceDescriptors();
83     
84      
85     /**
86      * Return a set of JMS destination reference descriptors.
87      *
88      * @return java.util.Set of JmsDestinationReferenceDescriptor objects
89      */

90     
91     public Set getJmsDestinationReferenceDescriptors();
92
93
94     /**
95      * Return the JMS destination reference descriptor corresponding to
96      * the given name.
97      *
98      * @return JmsDestinationReferenceDescriptor object
99      */

100     public JmsDestinationReferenceDescriptor getJmsDestinationReferenceByName(String JavaDoc name);
101
102     /**
103      * Return a set of message destination reference descriptors.
104      *
105      * @return java.util.Set of MessageDestinationReferenceDescriptor objects
106      */

107     
108     public Set getMessageDestinationReferenceDescriptors();
109
110
111     /**
112      * Return the message destination reference descriptor corresponding to
113      * the given name.
114      *
115      * @return MessageDestinationReferenceDescriptor object
116      */

117     public MessageDestinationReferenceDescriptor getMessageDestinationReferenceByName(String JavaDoc name);
118
119     /**
120      * Return a set of post-construct descriptors.
121      *
122      * @return java.util.Set of LifecycleCallbackDescriptor post-construct objects
123      */

124     public Set<LifecycleCallbackDescriptor> getPostConstructDescriptors();
125
126     /**
127      * Return the post-construct descriptor corresponding to
128      * the given name.
129      *
130      * @return LifecycleCallbackDescriptor post-construct object
131      */

132     public LifecycleCallbackDescriptor getPostConstructDescriptorByClass(String JavaDoc className);
133
134     /**
135      * Return a set of pre-destroy descriptors.
136      *
137      * @return java.util.Set of LifecycleCallbackDescriptor pre-destroy objects
138      */

139     public Set<LifecycleCallbackDescriptor> getPreDestroyDescriptors();
140
141     /**
142      * Return the pre-destroy descriptor corresponding to
143      * the given name.
144      *
145      * @return LifecycleCallbackDescriptor pre-destroy object
146      */

147     public LifecycleCallbackDescriptor getPreDestroyDescriptorByClass(String JavaDoc className);
148
149     /**
150      * Return a set of entity manager factory reference descriptors.
151      */

152     public Set<EntityManagerFactoryReferenceDescriptor> getEntityManagerFactoryReferenceDescriptors();
153
154     /**
155      * Return the entity manager factory reference descriptor corresponding to
156      * the given name.
157      */

158     public EntityManagerFactoryReferenceDescriptor getEntityManagerFactoryReferenceByName(String JavaDoc name);
159
160
161     /**
162      * Return a set of entity manager reference descriptors.
163      */

164     public Set<EntityManagerReferenceDescriptor> getEntityManagerReferenceDescriptors();
165
166     /**
167      * Return the entity manager reference descriptor corresponding to
168      * the given name.
169      */

170     public EntityManagerReferenceDescriptor getEntityManagerReferenceByName(String JavaDoc name);
171
172     /**
173      *
174      */

175     public List<InjectionCapable> getInjectableResourcesByClass(String JavaDoc className);
176     public InjectionInfo getInjectionInfoByClass(String JavaDoc className);
177
178 }
179
Popular Tags