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