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