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.server;
028    
029    
030    
031    import org.opends.server.admin.server.ConfigurationChangeListener;
032    
033    
034    
035    /**
036     * A server-side interface for querying File Based Trust Manager
037     * Provider settings.
038     * <p>
039     * The file-based trust manager provider determines whether to trust a
040     * presented certificate based on whether that certificate exists in a
041     * server trust store file.
042     */
043    public interface FileBasedTrustManagerProviderCfg extends TrustManagerProviderCfg {
044    
045      /**
046       * Gets the configuration class associated with this File Based Trust Manager Provider.
047       *
048       * @return Returns the configuration class associated with this File Based Trust Manager Provider.
049       */
050      Class<? extends FileBasedTrustManagerProviderCfg> configurationClass();
051    
052    
053    
054      /**
055       * Register to be notified when this File Based Trust Manager Provider is changed.
056       *
057       * @param listener
058       *          The File Based Trust Manager Provider configuration change listener.
059       */
060      void addFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener);
061    
062    
063    
064      /**
065       * Deregister an existing File Based Trust Manager Provider configuration change listener.
066       *
067       * @param listener
068       *          The File Based Trust Manager Provider configuration change listener.
069       */
070      void removeFileBasedChangeListener(ConfigurationChangeListener<FileBasedTrustManagerProviderCfg> listener);
071    
072    
073    
074      /**
075       * Gets the "java-class" property.
076       * <p>
077       * The fully-qualified name of the Java class that provides the File
078       * Based Trust Manager Provider implementation.
079       *
080       * @return Returns the value of the "java-class" property.
081       */
082      String getJavaClass();
083    
084    
085    
086      /**
087       * Gets the "trust-store-file" property.
088       * <p>
089       * Specifies the path to the file containing the trust information.
090       * It can be an absolute path or a path that is relative to the
091       * OpenDS Directory Server instance root.
092       * <p>
093       * Changes to this configuration attribute take effect the next time
094       * that the trust manager is accessed.
095       *
096       * @return Returns the value of the "trust-store-file" property.
097       */
098      String getTrustStoreFile();
099    
100    
101    
102      /**
103       * Gets the "trust-store-pin" property.
104       * <p>
105       * Specifies the clear-text PIN needed to access the File Based
106       * Trust Manager Provider .
107       *
108       * @return Returns the value of the "trust-store-pin" property.
109       */
110      String getTrustStorePin();
111    
112    
113    
114      /**
115       * Gets the "trust-store-pin-environment-variable" property.
116       * <p>
117       * Specifies the name of the environment variable that contains the
118       * clear-text PIN needed to access the File Based Trust Manager
119       * Provider .
120       *
121       * @return Returns the value of the "trust-store-pin-environment-variable" property.
122       */
123      String getTrustStorePinEnvironmentVariable();
124    
125    
126    
127      /**
128       * Gets the "trust-store-pin-file" property.
129       * <p>
130       * Specifies the path to the text file whose only contents should be
131       * a single line containing the clear-text PIN needed to access the
132       * File Based Trust Manager Provider .
133       *
134       * @return Returns the value of the "trust-store-pin-file" property.
135       */
136      String getTrustStorePinFile();
137    
138    
139    
140      /**
141       * Gets the "trust-store-pin-property" property.
142       * <p>
143       * Specifies the name of the Java property that contains the
144       * clear-text PIN needed to access the File Based Trust Manager
145       * Provider .
146       *
147       * @return Returns the value of the "trust-store-pin-property" property.
148       */
149      String getTrustStorePinProperty();
150    
151    
152    
153      /**
154       * Gets the "trust-store-type" property.
155       * <p>
156       * Specifies the format for the data in the trust store file.
157       * <p>
158       * Valid values always include 'JKS' and 'PKCS12', but different
159       * implementations can allow other values as well. If no value is
160       * provided, then the JVM default value is used. Changes to this
161       * configuration attribute take effect the next time that the trust
162       * manager is accessed.
163       *
164       * @return Returns the value of the "trust-store-type" property.
165       */
166      String getTrustStoreType();
167    
168    }