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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.client;
028
029
030
031 import org.opends.server.admin.IllegalPropertyValueException;
032 import org.opends.server.admin.ManagedObjectDefinition;
033 import org.opends.server.admin.std.server.PKCS11KeyManagerProviderCfg;
034
035
036
037 /**
038 * A client-side interface for reading and modifying PKCS11 Key
039 * Manager Provider settings.
040 * <p>
041 * The PKCS11 Key Manager Provider enables the server to access the
042 * private key information through the PKCS11 interface.
043 */
044 public interface PKCS11KeyManagerProviderCfgClient extends KeyManagerProviderCfgClient {
045
046 /**
047 * Get the configuration definition associated with this PKCS11 Key Manager Provider.
048 *
049 * @return Returns the configuration definition associated with this PKCS11 Key Manager Provider.
050 */
051 ManagedObjectDefinition<? extends PKCS11KeyManagerProviderCfgClient, ? extends PKCS11KeyManagerProviderCfg> definition();
052
053
054
055 /**
056 * Gets the "java-class" property.
057 * <p>
058 * The fully-qualified name of the Java class that provides the
059 * PKCS11 Key Manager Provider implementation.
060 *
061 * @return Returns the value of the "java-class" property.
062 */
063 String getJavaClass();
064
065
066
067 /**
068 * Sets the "java-class" property.
069 * <p>
070 * The fully-qualified name of the Java class that provides the
071 * PKCS11 Key Manager Provider implementation.
072 *
073 * @param value The value of the "java-class" property.
074 * @throws IllegalPropertyValueException
075 * If the new value is invalid.
076 */
077 void setJavaClass(String value) throws IllegalPropertyValueException;
078
079
080
081 /**
082 * Gets the "key-store-pin" property.
083 * <p>
084 * Specifies the clear-text PIN needed to access the PKCS11 Key
085 * Manager Provider .
086 *
087 * @return Returns the value of the "key-store-pin" property.
088 */
089 String getKeyStorePin();
090
091
092
093 /**
094 * Sets the "key-store-pin" property.
095 * <p>
096 * Specifies the clear-text PIN needed to access the PKCS11 Key
097 * Manager Provider .
098 *
099 * @param value The value of the "key-store-pin" property.
100 * @throws IllegalPropertyValueException
101 * If the new value is invalid.
102 */
103 void setKeyStorePin(String value) throws IllegalPropertyValueException;
104
105
106
107 /**
108 * Gets the "key-store-pin-environment-variable" property.
109 * <p>
110 * Specifies the name of the environment variable that contains the
111 * clear-text PIN needed to access the PKCS11 Key Manager Provider .
112 *
113 * @return Returns the value of the "key-store-pin-environment-variable" property.
114 */
115 String getKeyStorePinEnvironmentVariable();
116
117
118
119 /**
120 * Sets the "key-store-pin-environment-variable" property.
121 * <p>
122 * Specifies the name of the environment variable that contains the
123 * clear-text PIN needed to access the PKCS11 Key Manager Provider .
124 *
125 * @param value The value of the "key-store-pin-environment-variable" property.
126 * @throws IllegalPropertyValueException
127 * If the new value is invalid.
128 */
129 void setKeyStorePinEnvironmentVariable(String value) throws IllegalPropertyValueException;
130
131
132
133 /**
134 * Gets the "key-store-pin-file" property.
135 * <p>
136 * Specifies the path to the text file whose only contents should be
137 * a single line containing the clear-text PIN needed to access the
138 * PKCS11 Key Manager Provider .
139 *
140 * @return Returns the value of the "key-store-pin-file" property.
141 */
142 String getKeyStorePinFile();
143
144
145
146 /**
147 * Sets the "key-store-pin-file" property.
148 * <p>
149 * Specifies the path to the text file whose only contents should be
150 * a single line containing the clear-text PIN needed to access the
151 * PKCS11 Key Manager Provider .
152 *
153 * @param value The value of the "key-store-pin-file" property.
154 * @throws IllegalPropertyValueException
155 * If the new value is invalid.
156 */
157 void setKeyStorePinFile(String value) throws IllegalPropertyValueException;
158
159
160
161 /**
162 * Gets the "key-store-pin-property" property.
163 * <p>
164 * Specifies the name of the Java property that contains the
165 * clear-text PIN needed to access the PKCS11 Key Manager Provider .
166 *
167 * @return Returns the value of the "key-store-pin-property" property.
168 */
169 String getKeyStorePinProperty();
170
171
172
173 /**
174 * Sets the "key-store-pin-property" property.
175 * <p>
176 * Specifies the name of the Java property that contains the
177 * clear-text PIN needed to access the PKCS11 Key Manager Provider .
178 *
179 * @param value The value of the "key-store-pin-property" property.
180 * @throws IllegalPropertyValueException
181 * If the new value is invalid.
182 */
183 void setKeyStorePinProperty(String value) throws IllegalPropertyValueException;
184
185 }