001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import org.forgerock.opendj.config.server.ConfigurationChangeListener;
021
022
023
024/**
025 * A server-side interface for querying PKCS11 Key Manager Provider
026 * settings.
027 * <p>
028 * The PKCS11 Key Manager Provider enables the server to access the
029 * private key information through the PKCS11 interface.
030 */
031public interface PKCS11KeyManagerProviderCfg extends KeyManagerProviderCfg {
032
033  /**
034   * Gets the configuration class associated with this PKCS11 Key Manager Provider.
035   *
036   * @return Returns the configuration class associated with this PKCS11 Key Manager Provider.
037   */
038  Class<? extends PKCS11KeyManagerProviderCfg> configurationClass();
039
040
041
042  /**
043   * Register to be notified when this PKCS11 Key Manager Provider is changed.
044   *
045   * @param listener
046   *          The PKCS11 Key Manager Provider configuration change listener.
047   */
048  void addPKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener);
049
050
051
052  /**
053   * Deregister an existing PKCS11 Key Manager Provider configuration change listener.
054   *
055   * @param listener
056   *          The PKCS11 Key Manager Provider configuration change listener.
057   */
058  void removePKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener);
059
060
061
062  /**
063   * Gets the "java-class" property.
064   * <p>
065   * The fully-qualified name of the Java class that provides the
066   * PKCS11 Key Manager Provider implementation.
067   *
068   * @return Returns the value of the "java-class" property.
069   */
070  String getJavaClass();
071
072
073
074  /**
075   * Gets the "key-store-pin" property.
076   * <p>
077   * Specifies the clear-text PIN needed to access the PKCS11 Key
078   * Manager Provider .
079   *
080   * @return Returns the value of the "key-store-pin" property.
081   */
082  String getKeyStorePin();
083
084
085
086  /**
087   * Gets the "key-store-pin-environment-variable" property.
088   * <p>
089   * Specifies the name of the environment variable that contains the
090   * clear-text PIN needed to access the PKCS11 Key Manager Provider .
091   *
092   * @return Returns the value of the "key-store-pin-environment-variable" property.
093   */
094  String getKeyStorePinEnvironmentVariable();
095
096
097
098  /**
099   * Gets the "key-store-pin-file" property.
100   * <p>
101   * Specifies the path to the text file whose only contents should be
102   * a single line containing the clear-text PIN needed to access the
103   * PKCS11 Key Manager Provider .
104   *
105   * @return Returns the value of the "key-store-pin-file" property.
106   */
107  String getKeyStorePinFile();
108
109
110
111  /**
112   * Gets the "key-store-pin-property" property.
113   * <p>
114   * Specifies the name of the Java property that contains the
115   * clear-text PIN needed to access the PKCS11 Key Manager Provider .
116   *
117   * @return Returns the value of the "key-store-pin-property" property.
118   */
119  String getKeyStorePinProperty();
120
121}