/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2008 Sun Microsystems, Inc.
|
* Portions Copyright 2014 ForgeRock AS.
|
*/
|
|
package org.forgerock.opendj.config;
|
|
import org.forgerock.opendj.config.client.ConcurrentModificationException;
|
import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException;
|
import org.forgerock.opendj.config.client.OperationRejectedException;
|
import org.forgerock.opendj.ldap.LdapException;
|
|
/**
|
* 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 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 LdapException
|
* If any other error occurs.
|
*/
|
void commit() throws ManagedObjectAlreadyExistsException, MissingMandatoryPropertiesException,
|
ConcurrentModificationException, OperationRejectedException, LdapException;
|
|
}
|
