OpenDJ 3 : config framework

Nicolas Capponi

02.23.2013 b54a338f5933502809578214db03147c02e48b11

 opendj-admin/src/main/java/org/opends/server/admin/ConfigurationClient.java

@@ -27,74 +27,58 @@

package org.opends.server.admin;



import org.opends.server.admin.client.AuthorizationException;
import org.opends.server.admin.client.CommunicationException;
import org.opends.server.admin.client.ConcurrentModificationException;
import org.opends.server.admin.client.MissingMandatoryPropertiesException;
import org.opends.server.admin.client.OperationRejectedException;



/**
 * A common base interface for all managed object configuration
 * clients.
 * A common base interface for all managed object configuration clients.
 */
public interface ConfigurationClient {

  /**
   * Get the configuration definition associated with this
   * configuration.
   *
   * @return Returns the configuration definition associated with this
   *         configuration.
   */
  ManagedObjectDefinition<? extends ConfigurationClient,
      ? extends Configuration> definition();
    /**
     * Get the configuration definition associated with this configuration.
     *
     * @return Returns the configuration definition associated with this
     *         configuration.
     */
    ManagedObjectDefinition<? extends ConfigurationClient, ? extends Configuration> definition();

    /**
     * Get a property provider view of this configuration.
     *
     * @return Returns a property provider view of this configuration.
     */
    PropertyProvider properties();


  /**
   * Get a property provider view of this configuration.
   *
   * @return Returns a property provider view of this configuration.
   */
  PropertyProvider properties();



  /**
   * If this is a new configuration this method will attempt to add it
   * to the server, otherwise it will commit any changes made to this
   * configuration.
   *
   * @throws ManagedObjectAlreadyExistsException
   *           If this is a new configuration but it could not be
   *           added to the server because it already exists.
   * @throws MissingMandatoryPropertiesException
   *           If this configuration contains some mandatory
   *           properties which have been left undefined.
   * @throws ConcurrentModificationException
   *           If this is a new configuration which is being added to
   *           the server but its parent has been removed by another
   *           client, or if this configuration is being modified but
   *           it has been removed from the server by another client.
   * @throws OperationRejectedException
   *           If the server refuses to add or modify this
   *           configuration due to some server-side constraint which
   *           cannot be satisfied.
   * @throws AuthorizationException
   *           If the server refuses to add or modify this
   *           configuration because the client does not have the
   *           correct privileges.
   * @throws CommunicationException
   *           If the client cannot contact the server due to an
   *           underlying communication problem.
   */
  void commit() throws ManagedObjectAlreadyExistsException,
      MissingMandatoryPropertiesException, ConcurrentModificationException,
      OperationRejectedException, AuthorizationException,
      CommunicationException;
    /**
     * If this is a new configuration this method will attempt to add it to the
     * server, otherwise it will commit any changes made to this configuration.
     *
     * @throws ManagedObjectAlreadyExistsException
     *             If this is a new configuration but it could not be added to
     *             the server because it already exists.
     * @throws MissingMandatoryPropertiesException
     *             If this configuration contains some mandatory properties
     *             which have been left undefined.
     * @throws ConcurrentModificationException
     *             If this is a new configuration which is being added to the
     *             server but its parent has been removed by another client, or
     *             if this configuration is being modified but it has been
     *             removed from the server by another client.
     * @throws OperationRejectedException
     *             If the server refuses to add or modify this configuration due
     *             to some server-side constraint which cannot be satisfied.
     * @throws AuthorizationException
     *             If the server refuses to add or modify this configuration
     *             because the client does not have the correct privileges.
     * @throws CommunicationException
     *             If the client cannot contact the server due to an underlying
     *             communication problem.
     */
    void commit() throws ManagedObjectAlreadyExistsException, MissingMandatoryPropertiesException,
            ConcurrentModificationException, OperationRejectedException, AuthorizationException, CommunicationException;

}