KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > services > config > jndi > JNDILinkNodeConfiguration


1 /*
2  * The contents of this file are subject to the Sapient Public License
3  * Version 1.0 (the "License"); you may not use this file except in compliance
4  * with the License. You may obtain a copy of the License at
5  * http://carbon.sf.net/License.html.
6  *
7  * Software distributed under the License is distributed on an "AS IS" basis,
8  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9  * the specific language governing rights and limitations under the License.
10  *
11  * The Original Code is The Carbon Component Framework.
12  *
13  * The Initial Developer of the Original Code is Sapient Corporation
14  *
15  * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16  */

17
18 package org.sape.carbon.services.config.jndi;
19
20 import org.sape.carbon.core.config.node.link.LinkNodeConfiguration;
21
22 import org.sape.carbon.services.jndi.InitialContextFactory;
23
24 /**
25  * <p>This configuration interface defines properties to that describe how to
26  * connect to a JNDI directory that contains a configuration hierachy.
27  * In the basic case, only InitialContextFactory, ProviderUrl, and
28  * InitialContextName need to be specified. If anonymous access to the
29  * directory is not allowed, SecurityPrincipal and SecurityCredentials must
30  * also be specified. If other JNDI environment properties are required based
31  * on the specific JNDI provider, they can be listed in the Map
32  * EnvironmentProperties.</p>
33  *
34  * <p>For advanced control of the names of JNDI attributes and the meaning
35  * of the values used by the JNDI config service, the values of
36  * NodeTypeAttributeName, FolderNodeTypeAttributeValue,
37  * DocumentNodeTypeAttributeValue, DocumentTypeAttributeName,
38  * LinkDocumentTypeAttributeValue, DocumentDocumentTypeAttributeValue,
39  * DocumentContectAttributeName, NodeNameAttributeName, and
40  * AttributeNameValueSeparator.</p>
41  *
42  * Copyright 2003 Sapient
43  * @since carbon 2.0
44  * @author Douglas Voet, March 2003
45  * @version $Revision: 1.7 $($Author: dvoet $ / $Date: 2003/10/30 19:29:58 $)
46  */

47 public interface JNDILinkNodeConfiguration extends LinkNodeConfiguration {
48     
49     InitialContextFactory getInitialContextFactory();
50     
51     void setInitialContextFactory(InitialContextFactory factory);
52
53     /**
54      * Gets the name of the context that is the target of the link. This
55      * can not be null or empty. An example for an LDAP directory would be
56      * "name=configRoot,dc=sapient,dc=com".
57      *
58      * @return String
59      */

60     String JavaDoc getTargetContextName();
61
62     /**
63      * Sets the name of the context that is the target of the link. This
64      * can not be null or empty. An example for an LDAP directory would be
65      * "name=configRoot,dc=sapient,dc=com".
66      *
67      * @param name
68      */

69     void setTargetContextName(String JavaDoc name);
70
71     /** Default value for the NodeTypeAttributeName property */
72     String JavaDoc NodeTypeAttributeName = "objectClass";
73
74     /**
75      * Gets the name of the attribute that determines if a context is a
76      * Folder or a ConfigurationDocument.
77      * @return String
78      */

79     String JavaDoc getNodeTypeAttributeName();
80
81     /**
82      * Sets NodeTypeAttributeName.
83      * @see #getNodeTypeAttributeName
84      * @param name
85      */

86     void setNodeTypeAttributeName(String JavaDoc name);
87
88     /** Default value for the FolderNodeTypeAttributeValue property */
89     String JavaDoc FolderNodeTypeAttributeValue = "configFolder";
90
91     /**
92      * Gets the value of the attribute named by NodeTypeAttributeName
93      * that denotes that a context represents a Folder.
94      * @return String
95      */

96     String JavaDoc getFolderNodeTypeAttributeValue();
97
98     /**
99      * Sets FolderNodeTypeAttributeValue.
100      * @see #getFolderNodeTypeAttributeValue
101      * @param value
102      */

103     void setFolderNodeTypeAttributeValue(String JavaDoc value);
104
105     /** Default value for the DocumentNodeTypeAttributeValue property */
106     String JavaDoc DocumentNodeTypeAttributeValue = "configDocument";
107
108     /**
109      * Gets the value of the attribute named by NodeTypeAttributeName
110      * that denotes that a context represents a ConfigurationDocument.
111      * @return String
112      */

113     String JavaDoc getDocumentNodeTypeAttributeValue();
114
115     /**
116      * Sets DocumentNodeTypeAttributeValue.
117      * @see #getDocumentNodeTypeAttributeValue
118      * @param value
119      */

120     void setDocumentNodeTypeAttributeValue(String JavaDoc value);
121
122     /** Default value for the DocumentTypeAttributeName property */
123     String JavaDoc DocumentTypeAttributeName = "type";
124
125     /**
126      * Gets the name of the attribute that determines if a document context is a
127      * link or a document.
128      * @return String
129      */

130     String JavaDoc getDocumentTypeAttributeName();
131
132     /**
133      * Sets DocumentTypeAttributeName.
134      * @see #setDocumentTypeAttributeName
135      * @param name
136      */

137     void setDocumentTypeAttributeName(String JavaDoc name);
138
139     /** Default value for the LinkDocumentTypeAttributeValue property */
140     String JavaDoc LinkDocumentTypeAttributeValue = "link";
141
142     /**
143      * Gets the value of the attribute named by DocumentTypeAttributeName
144      * that denotes that a context represents a link.
145      * @return String
146      */

147     String JavaDoc getLinkDocumentTypeAttributeValue();
148
149     /**
150      * Sets LinkDocumentTypeAttributeValue.
151      * @see #setLinkDocumentTypeAttributeValue
152      * @param value
153      */

154     void setLinkDocumentTypeAttributeValue(String JavaDoc value);
155
156     /** Default value for the DocumentDocumentTypeAttributeValue property */
157     String JavaDoc DocumentDocumentTypeAttributeValue = "doc";
158
159     /**
160      * Gets the value of the attribute named by DocumentTypeAttributeName
161      * that denotes that a context represents a document.
162      * @return String
163      */

164     String JavaDoc getDocumentDocumentTypeAttributeValue();
165
166     /**
167      * Sets DocumentDocumentTypeAttributeValue.
168      * @see #setDocumentDocumentTypeAttributeValue
169      * @param value
170      */

171     void setDocumentDocumentTypeAttributeValue(String JavaDoc value);
172
173
174     /** Default value for the DocumentContectAttributeName property */
175     String JavaDoc DocumentContectAttributeName = "content";
176
177     /**
178      * Gets the name of the attribute that holds a document's content.
179      * @return String
180      */

181     String JavaDoc getDocumentContectAttributeName();
182
183     /**
184      * Sets DocumentContectAttributeName.
185      * @see #setDocumentContectAttributeName
186      * @param name
187      */

188     void setDocumentContectAttributeName(String JavaDoc name);
189
190     /** Default value for the NodeNameAttributeName property */
191     String JavaDoc NodeNameAttributeName = "name";
192
193     /**
194      * Gets the name of the attribute that holds the name of the context.
195      * @return String
196      */

197     String JavaDoc getNodeNameAttributeName();
198
199     /**
200      * Sets NodeNameAttributeName.
201      * @see #setNodeNameAttributeName
202      * @param name
203      */

204     void setNodeNameAttributeName(String JavaDoc name);
205
206     /** Default value for the AttributeNameValueSeparator property */
207     String JavaDoc AttributeNameValueSeparator = "=";
208
209     /**
210      * Gets the String that the directory uses to separate attributes
211      * and their values when they are represented as Strings
212      * @return
213      */

214     String JavaDoc getAttributeNameValueSeparator();
215
216     /**
217      * Gets AttributeNameValueSeparator.
218      * @see #getAttributeNameValueSeparator
219      * @param separator
220      */

221     void setAttributeNameValueSeparator(String JavaDoc separator);
222 }
223
Popular Tags