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