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