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 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 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 * docs/licenses/cddl.txt. 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 2010-2014 UnboundID Corp. 026 */ 027 package com.unboundid.directory.sdk.common.internal; 028 029 030 031 import com.unboundid.util.NotExtensible; 032 import com.unboundid.util.ThreadSafety; 033 import com.unboundid.util.ThreadSafetyLevel; 034 import com.unboundid.util.args.ArgumentException; 035 import com.unboundid.util.args.ArgumentParser; 036 037 038 039 /** 040 * This interface is used to mark extensions which may obtain configuration 041 * information using an LDAP SDK argument parser. 042 */ 043 @NotExtensible() 044 @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 045 public interface Configurable 046 { 047 /** 048 * Updates the provided argument parser to define any configuration arguments 049 * which may be used by this extension. The argument parser may also be 050 * updated to define relationships between arguments (e.g., to specify 051 * required, exclusive, or dependent argument sets). 052 * 053 * @param parser The argument parser to be updated with the configuration 054 * arguments which may be used by this extension. 055 * 056 * @throws ArgumentException If a problem is encountered while updating the 057 * provided argument parser. 058 */ 059 void defineConfigArguments(final ArgumentParser parser) 060 throws ArgumentException; 061 }