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.ldap.DN;
023import org.forgerock.opendj.server.config.server.HTTPAnonymousAuthorizationMechanismCfg;
024
025
026
027/**
028 * A client-side interface for reading and modifying HTTP Anonymous
029 * Authorization Mechanism settings.
030 * <p>
031 * The HTTP Anonymous Authorization Mechanism is used to define static
032 * authorization.
033 */
034public interface HTTPAnonymousAuthorizationMechanismCfgClient extends HTTPAuthorizationMechanismCfgClient {
035
036  /**
037   * Get the configuration definition associated with this HTTP Anonymous Authorization Mechanism.
038   *
039   * @return Returns the configuration definition associated with this HTTP Anonymous Authorization Mechanism.
040   */
041  ManagedObjectDefinition<? extends HTTPAnonymousAuthorizationMechanismCfgClient, ? extends HTTPAnonymousAuthorizationMechanismCfg> definition();
042
043
044
045  /**
046   * Gets the "java-class" property.
047   * <p>
048   * Specifies the fully-qualified name of the Java class that
049   * provides the HTTP Anonymous Authorization Mechanism
050   * implementation.
051   *
052   * @return Returns the value of the "java-class" property.
053   */
054  String getJavaClass();
055
056
057
058  /**
059   * Sets the "java-class" property.
060   * <p>
061   * Specifies the fully-qualified name of the Java class that
062   * provides the HTTP Anonymous Authorization Mechanism
063   * implementation.
064   *
065   * @param value The value of the "java-class" property.
066   * @throws PropertyException
067   *           If the new value is invalid.
068   */
069  void setJavaClass(String value) throws PropertyException;
070
071
072
073  /**
074   * Gets the "user-dn" property.
075   * <p>
076   * The authorization DN which will be used for performing anonymous
077   * operations.
078   *
079   * @return Returns the value of the "user-dn" property.
080   */
081  DN getUserDN();
082
083
084
085  /**
086   * Sets the "user-dn" property.
087   * <p>
088   * The authorization DN which will be used for performing anonymous
089   * operations.
090   *
091   * @param value The value of the "user-dn" property.
092   * @throws PropertyException
093   *           If the new value is invalid.
094   */
095  void setUserDN(DN value) throws PropertyException;
096
097}