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.server; 028 029 030 031 import org.opends.server.admin.server.ConfigurationChangeListener; 032 033 034 035 /** 036 * A server-side interface for querying PKCS11 Key Manager Provider 037 * settings. 038 * <p> 039 * The PKCS11 Key Manager Provider enables the server to access the 040 * private key information through the PKCS11 interface. 041 */ 042 public interface PKCS11KeyManagerProviderCfg extends KeyManagerProviderCfg { 043 044 /** 045 * Gets the configuration class associated with this PKCS11 Key Manager Provider. 046 * 047 * @return Returns the configuration class associated with this PKCS11 Key Manager Provider. 048 */ 049 Class<? extends PKCS11KeyManagerProviderCfg> configurationClass(); 050 051 052 053 /** 054 * Register to be notified when this PKCS11 Key Manager Provider is changed. 055 * 056 * @param listener 057 * The PKCS11 Key Manager Provider configuration change listener. 058 */ 059 void addPKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener); 060 061 062 063 /** 064 * Deregister an existing PKCS11 Key Manager Provider configuration change listener. 065 * 066 * @param listener 067 * The PKCS11 Key Manager Provider configuration change listener. 068 */ 069 void removePKCS11ChangeListener(ConfigurationChangeListener<PKCS11KeyManagerProviderCfg> listener); 070 071 072 073 /** 074 * Gets the "java-class" property. 075 * <p> 076 * The fully-qualified name of the Java class that provides the 077 * PKCS11 Key Manager Provider implementation. 078 * 079 * @return Returns the value of the "java-class" property. 080 */ 081 String getJavaClass(); 082 083 084 085 /** 086 * Gets the "key-store-pin" property. 087 * <p> 088 * Specifies the clear-text PIN needed to access the PKCS11 Key 089 * Manager Provider . 090 * 091 * @return Returns the value of the "key-store-pin" property. 092 */ 093 String getKeyStorePin(); 094 095 096 097 /** 098 * Gets the "key-store-pin-environment-variable" property. 099 * <p> 100 * Specifies the name of the environment variable that contains the 101 * clear-text PIN needed to access the PKCS11 Key Manager Provider . 102 * 103 * @return Returns the value of the "key-store-pin-environment-variable" property. 104 */ 105 String getKeyStorePinEnvironmentVariable(); 106 107 108 109 /** 110 * Gets the "key-store-pin-file" property. 111 * <p> 112 * Specifies the path to the text file whose only contents should be 113 * a single line containing the clear-text PIN needed to access the 114 * PKCS11 Key Manager Provider . 115 * 116 * @return Returns the value of the "key-store-pin-file" property. 117 */ 118 String getKeyStorePinFile(); 119 120 121 122 /** 123 * Gets the "key-store-pin-property" property. 124 * <p> 125 * Specifies the name of the Java property that contains the 126 * clear-text PIN needed to access the PKCS11 Key Manager Provider . 127 * 128 * @return Returns the value of the "key-store-pin-property" property. 129 */ 130 String getKeyStorePinProperty(); 131 132 }