001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.client;
028    
029    
030    
031    import org.opends.server.admin.IllegalPropertyValueException;
032    import org.opends.server.admin.ManagedObjectDefinition;
033    import org.opends.server.admin.std.server.FileBasedTrustManagerProviderCfg;
034    
035    
036    
037    /**
038     * A client-side interface for reading and modifying File Based Trust
039     * Manager Provider settings.
040     * <p>
041     * The file-based trust manager provider determines whether to trust a
042     * presented certificate based on whether that certificate exists in a
043     * server trust store file.
044     */
045    public interface FileBasedTrustManagerProviderCfgClient extends TrustManagerProviderCfgClient {
046    
047      /**
048       * Get the configuration definition associated with this File Based Trust Manager Provider.
049       *
050       * @return Returns the configuration definition associated with this File Based Trust Manager Provider.
051       */
052      ManagedObjectDefinition<? extends FileBasedTrustManagerProviderCfgClient, ? extends FileBasedTrustManagerProviderCfg> definition();
053    
054    
055    
056      /**
057       * Gets the "java-class" property.
058       * <p>
059       * The fully-qualified name of the Java class that provides the File
060       * Based Trust Manager Provider implementation.
061       *
062       * @return Returns the value of the "java-class" property.
063       */
064      String getJavaClass();
065    
066    
067    
068      /**
069       * Sets the "java-class" property.
070       * <p>
071       * The fully-qualified name of the Java class that provides the File
072       * Based Trust Manager Provider implementation.
073       *
074       * @param value The value of the "java-class" property.
075       * @throws IllegalPropertyValueException
076       *           If the new value is invalid.
077       */
078      void setJavaClass(String value) throws IllegalPropertyValueException;
079    
080    
081    
082      /**
083       * Gets the "trust-store-file" property.
084       * <p>
085       * Specifies the path to the file containing the trust information.
086       * It can be an absolute path or a path that is relative to the
087       * OpenDS Directory Server instance root.
088       * <p>
089       * Changes to this configuration attribute take effect the next time
090       * that the trust manager is accessed.
091       *
092       * @return Returns the value of the "trust-store-file" property.
093       */
094      String getTrustStoreFile();
095    
096    
097    
098      /**
099       * Sets the "trust-store-file" property.
100       * <p>
101       * Specifies the path to the file containing the trust information.
102       * It can be an absolute path or a path that is relative to the
103       * OpenDS Directory Server instance root.
104       * <p>
105       * Changes to this configuration attribute take effect the next time
106       * that the trust manager is accessed.
107       *
108       * @param value The value of the "trust-store-file" property.
109       * @throws IllegalPropertyValueException
110       *           If the new value is invalid.
111       */
112      void setTrustStoreFile(String value) throws IllegalPropertyValueException;
113    
114    
115    
116      /**
117       * Gets the "trust-store-pin" property.
118       * <p>
119       * Specifies the clear-text PIN needed to access the File Based
120       * Trust Manager Provider .
121       *
122       * @return Returns the value of the "trust-store-pin" property.
123       */
124      String getTrustStorePin();
125    
126    
127    
128      /**
129       * Sets the "trust-store-pin" property.
130       * <p>
131       * Specifies the clear-text PIN needed to access the File Based
132       * Trust Manager Provider .
133       *
134       * @param value The value of the "trust-store-pin" property.
135       * @throws IllegalPropertyValueException
136       *           If the new value is invalid.
137       */
138      void setTrustStorePin(String value) throws IllegalPropertyValueException;
139    
140    
141    
142      /**
143       * Gets the "trust-store-pin-environment-variable" property.
144       * <p>
145       * Specifies the name of the environment variable that contains the
146       * clear-text PIN needed to access the File Based Trust Manager
147       * Provider .
148       *
149       * @return Returns the value of the "trust-store-pin-environment-variable" property.
150       */
151      String getTrustStorePinEnvironmentVariable();
152    
153    
154    
155      /**
156       * Sets the "trust-store-pin-environment-variable" property.
157       * <p>
158       * Specifies the name of the environment variable that contains the
159       * clear-text PIN needed to access the File Based Trust Manager
160       * Provider .
161       *
162       * @param value The value of the "trust-store-pin-environment-variable" property.
163       * @throws IllegalPropertyValueException
164       *           If the new value is invalid.
165       */
166      void setTrustStorePinEnvironmentVariable(String value) throws IllegalPropertyValueException;
167    
168    
169    
170      /**
171       * Gets the "trust-store-pin-file" property.
172       * <p>
173       * Specifies the path to the text file whose only contents should be
174       * a single line containing the clear-text PIN needed to access the
175       * File Based Trust Manager Provider .
176       *
177       * @return Returns the value of the "trust-store-pin-file" property.
178       */
179      String getTrustStorePinFile();
180    
181    
182    
183      /**
184       * Sets the "trust-store-pin-file" property.
185       * <p>
186       * Specifies the path to the text file whose only contents should be
187       * a single line containing the clear-text PIN needed to access the
188       * File Based Trust Manager Provider .
189       *
190       * @param value The value of the "trust-store-pin-file" property.
191       * @throws IllegalPropertyValueException
192       *           If the new value is invalid.
193       */
194      void setTrustStorePinFile(String value) throws IllegalPropertyValueException;
195    
196    
197    
198      /**
199       * Gets the "trust-store-pin-property" property.
200       * <p>
201       * Specifies the name of the Java property that contains the
202       * clear-text PIN needed to access the File Based Trust Manager
203       * Provider .
204       *
205       * @return Returns the value of the "trust-store-pin-property" property.
206       */
207      String getTrustStorePinProperty();
208    
209    
210    
211      /**
212       * Sets the "trust-store-pin-property" property.
213       * <p>
214       * Specifies the name of the Java property that contains the
215       * clear-text PIN needed to access the File Based Trust Manager
216       * Provider .
217       *
218       * @param value The value of the "trust-store-pin-property" property.
219       * @throws IllegalPropertyValueException
220       *           If the new value is invalid.
221       */
222      void setTrustStorePinProperty(String value) throws IllegalPropertyValueException;
223    
224    
225    
226      /**
227       * Gets the "trust-store-type" property.
228       * <p>
229       * Specifies the format for the data in the trust store file.
230       * <p>
231       * Valid values always include 'JKS' and 'PKCS12', but different
232       * implementations can allow other values as well. If no value is
233       * provided, then the JVM default value is used. Changes to this
234       * configuration attribute take effect the next time that the trust
235       * manager is accessed.
236       *
237       * @return Returns the value of the "trust-store-type" property.
238       */
239      String getTrustStoreType();
240    
241    
242    
243      /**
244       * Sets the "trust-store-type" property.
245       * <p>
246       * Specifies the format for the data in the trust store file.
247       * <p>
248       * Valid values always include 'JKS' and 'PKCS12', but different
249       * implementations can allow other values as well. If no value is
250       * provided, then the JVM default value is used. Changes to this
251       * configuration attribute take effect the next time that the trust
252       * manager is accessed.
253       *
254       * @param value The value of the "trust-store-type" property.
255       * @throws IllegalPropertyValueException
256       *           If the new value is invalid.
257       */
258      void setTrustStoreType(String value) throws IllegalPropertyValueException;
259    
260    }