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.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.server.PKCS11KeyManagerProviderCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying PKCS11 Key 028 * Manager Provider settings. 029 * <p> 030 * The PKCS11 Key Manager Provider enables the server to access the 031 * private key information through the PKCS11 interface. 032 */ 033public interface PKCS11KeyManagerProviderCfgClient extends KeyManagerProviderCfgClient { 034 035 /** 036 * Get the configuration definition associated with this PKCS11 Key Manager Provider. 037 * 038 * @return Returns the configuration definition associated with this PKCS11 Key Manager Provider. 039 */ 040 ManagedObjectDefinition<? extends PKCS11KeyManagerProviderCfgClient, ? extends PKCS11KeyManagerProviderCfg> definition(); 041 042 043 044 /** 045 * Gets the "java-class" property. 046 * <p> 047 * The fully-qualified name of the Java class that provides the 048 * PKCS11 Key Manager Provider implementation. 049 * 050 * @return Returns the value of the "java-class" property. 051 */ 052 String getJavaClass(); 053 054 055 056 /** 057 * Sets the "java-class" property. 058 * <p> 059 * The fully-qualified name of the Java class that provides the 060 * PKCS11 Key Manager Provider implementation. 061 * 062 * @param value The value of the "java-class" property. 063 * @throws PropertyException 064 * If the new value is invalid. 065 */ 066 void setJavaClass(String value) throws PropertyException; 067 068 069 070 /** 071 * Gets the "key-store-pin" property. 072 * <p> 073 * Specifies the clear-text PIN needed to access the PKCS11 Key 074 * Manager Provider . 075 * 076 * @return Returns the value of the "key-store-pin" property. 077 */ 078 String getKeyStorePin(); 079 080 081 082 /** 083 * Sets the "key-store-pin" property. 084 * <p> 085 * Specifies the clear-text PIN needed to access the PKCS11 Key 086 * Manager Provider . 087 * 088 * @param value The value of the "key-store-pin" property. 089 * @throws PropertyException 090 * If the new value is invalid. 091 */ 092 void setKeyStorePin(String value) throws PropertyException; 093 094 095 096 /** 097 * Gets the "key-store-pin-environment-variable" property. 098 * <p> 099 * Specifies the name of the environment variable that contains the 100 * clear-text PIN needed to access the PKCS11 Key Manager Provider . 101 * 102 * @return Returns the value of the "key-store-pin-environment-variable" property. 103 */ 104 String getKeyStorePinEnvironmentVariable(); 105 106 107 108 /** 109 * Sets the "key-store-pin-environment-variable" property. 110 * <p> 111 * Specifies the name of the environment variable that contains the 112 * clear-text PIN needed to access the PKCS11 Key Manager Provider . 113 * 114 * @param value The value of the "key-store-pin-environment-variable" property. 115 * @throws PropertyException 116 * If the new value is invalid. 117 */ 118 void setKeyStorePinEnvironmentVariable(String value) throws PropertyException; 119 120 121 122 /** 123 * Gets the "key-store-pin-file" property. 124 * <p> 125 * Specifies the path to the text file whose only contents should be 126 * a single line containing the clear-text PIN needed to access the 127 * PKCS11 Key Manager Provider . 128 * 129 * @return Returns the value of the "key-store-pin-file" property. 130 */ 131 String getKeyStorePinFile(); 132 133 134 135 /** 136 * Sets the "key-store-pin-file" property. 137 * <p> 138 * Specifies the path to the text file whose only contents should be 139 * a single line containing the clear-text PIN needed to access the 140 * PKCS11 Key Manager Provider . 141 * 142 * @param value The value of the "key-store-pin-file" property. 143 * @throws PropertyException 144 * If the new value is invalid. 145 */ 146 void setKeyStorePinFile(String value) throws PropertyException; 147 148 149 150 /** 151 * Gets the "key-store-pin-property" property. 152 * <p> 153 * Specifies the name of the Java property that contains the 154 * clear-text PIN needed to access the PKCS11 Key Manager Provider . 155 * 156 * @return Returns the value of the "key-store-pin-property" property. 157 */ 158 String getKeyStorePinProperty(); 159 160 161 162 /** 163 * Sets the "key-store-pin-property" property. 164 * <p> 165 * Specifies the name of the Java property that contains the 166 * clear-text PIN needed to access the PKCS11 Key Manager Provider . 167 * 168 * @param value The value of the "key-store-pin-property" property. 169 * @throws PropertyException 170 * If the new value is invalid. 171 */ 172 void setKeyStorePinProperty(String value) throws PropertyException; 173 174}