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 import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode; 033 034 035 036 /** 037 * A server-side interface for querying Trust Store Backend settings. 038 * <p> 039 * The Trust Store Backend provides an LDAP view of a file-based trust 040 * store. It is used by the administrative cryptographic framework. 041 */ 042 public interface TrustStoreBackendCfg extends BackendCfg { 043 044 /** 045 * Gets the configuration class associated with this Trust Store Backend. 046 * 047 * @return Returns the configuration class associated with this Trust Store Backend. 048 */ 049 Class<? extends TrustStoreBackendCfg> configurationClass(); 050 051 052 053 /** 054 * Register to be notified when this Trust Store Backend is changed. 055 * 056 * @param listener 057 * The Trust Store Backend configuration change listener. 058 */ 059 void addTrustStoreChangeListener(ConfigurationChangeListener<TrustStoreBackendCfg> listener); 060 061 062 063 /** 064 * Deregister an existing Trust Store Backend configuration change listener. 065 * 066 * @param listener 067 * The Trust Store Backend configuration change listener. 068 */ 069 void removeTrustStoreChangeListener(ConfigurationChangeListener<TrustStoreBackendCfg> listener); 070 071 072 073 /** 074 * Gets the "java-class" property. 075 * <p> 076 * Specifies the fully-qualified name of the Java class that 077 * provides the backend implementation. 078 * 079 * @return Returns the value of the "java-class" property. 080 */ 081 String getJavaClass(); 082 083 084 085 /** 086 * Gets the "trust-store-file" property. 087 * <p> 088 * Specifies the path to the file that stores the trust information. 089 * <p> 090 * It may be an absolute path, or a path that is relative to the 091 * OpenDS Directory Server instance root. 092 * 093 * @return Returns the value of the "trust-store-file" property. 094 */ 095 String getTrustStoreFile(); 096 097 098 099 /** 100 * Gets the "trust-store-pin" property. 101 * <p> 102 * Specifies the clear-text PIN needed to access the Trust Store 103 * Backend . 104 * 105 * @return Returns the value of the "trust-store-pin" property. 106 */ 107 String getTrustStorePin(); 108 109 110 111 /** 112 * Gets the "trust-store-pin-environment-variable" property. 113 * <p> 114 * Specifies the name of the environment variable that contains the 115 * clear-text PIN needed to access the Trust Store Backend . 116 * 117 * @return Returns the value of the "trust-store-pin-environment-variable" property. 118 */ 119 String getTrustStorePinEnvironmentVariable(); 120 121 122 123 /** 124 * Gets the "trust-store-pin-file" property. 125 * <p> 126 * Specifies the path to the text file whose only contents should be 127 * a single line containing the clear-text PIN needed to access the 128 * Trust Store Backend . 129 * 130 * @return Returns the value of the "trust-store-pin-file" property. 131 */ 132 String getTrustStorePinFile(); 133 134 135 136 /** 137 * Gets the "trust-store-pin-property" property. 138 * <p> 139 * Specifies the name of the Java property that contains the 140 * clear-text PIN needed to access the Trust Store Backend . 141 * 142 * @return Returns the value of the "trust-store-pin-property" property. 143 */ 144 String getTrustStorePinProperty(); 145 146 147 148 /** 149 * Gets the "trust-store-type" property. 150 * <p> 151 * Specifies the format for the data in the key store file. 152 * <p> 153 * Valid values should always include 'JKS' and 'PKCS12', but 154 * different implementations may allow other values as well. 155 * 156 * @return Returns the value of the "trust-store-type" property. 157 */ 158 String getTrustStoreType(); 159 160 161 162 /** 163 * Gets the "writability-mode" property. 164 * <p> 165 * Specifies the behavior that the backend should use when 166 * processing write operations. 167 * 168 * @return Returns the value of the "writability-mode" property. 169 */ 170 WritabilityMode getWritabilityMode(); 171 172 }