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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import org.opends.server.admin.ConfigurationClient;
031import org.opends.server.admin.ManagedObjectDefinition;
032import org.opends.server.admin.PropertyException;
033import org.opends.server.admin.std.server.TrustManagerProviderCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Trust Manager
039 * Provider settings.
040 * <p>
041 * Trust Manager Providers determine whether to trust presented
042 * certificates.
043 */
044public interface TrustManagerProviderCfgClient extends ConfigurationClient {
045
046  /**
047   * Get the configuration definition associated with this Trust Manager Provider.
048   *
049   * @return Returns the configuration definition associated with this Trust Manager Provider.
050   */
051  ManagedObjectDefinition<? extends TrustManagerProviderCfgClient, ? extends TrustManagerProviderCfg> definition();
052
053
054
055  /**
056   * Gets the "enabled" property.
057   * <p>
058   * Indicate whether the Trust Manager Provider is enabled for use.
059   *
060   * @return Returns the value of the "enabled" property.
061   */
062  Boolean isEnabled();
063
064
065
066  /**
067   * Sets the "enabled" property.
068   * <p>
069   * Indicate whether the Trust Manager Provider is enabled for use.
070   *
071   * @param value The value of the "enabled" property.
072   * @throws PropertyException
073   *           If the new value is invalid.
074   */
075  void setEnabled(boolean value) throws PropertyException;
076
077
078
079  /**
080   * Gets the "java-class" property.
081   * <p>
082   * The fully-qualified name of the Java class that provides the
083   * Trust Manager Provider implementation.
084   *
085   * @return Returns the value of the "java-class" property.
086   */
087  String getJavaClass();
088
089
090
091  /**
092   * Sets the "java-class" property.
093   * <p>
094   * The fully-qualified name of the Java class that provides the
095   * Trust Manager Provider implementation.
096   *
097   * @param value The value of the "java-class" property.
098   * @throws PropertyException
099   *           If the new value is invalid.
100   */
101  void setJavaClass(String value) throws PropertyException;
102
103}