8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: ICOSDefinition.java,v 1.3 2008/06/25 05:41:47 qcheng Exp $
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This interface provides method signatures which will be implemented for COS
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * definitions. Each of the COS definition classes implement this interface, and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * provide implementations for these methods.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This method sets the name for the COS definition.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param name
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * the name of this COS definition.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This method returns the name of the COS definition.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return the name of the COS definition.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This method adds a COS attribute to the COS definition.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param attrName
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * the name of the attribute.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param qualifier
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The qualifier for the attribute. The valid range of values
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * are: 0 (default), 1 (override), 2 (operational), 3
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (merge-schemes).
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws UMSException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if an exception occurs.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public void addCOSAttribute(String attrName, int qualifier)
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This method removes a COS attribute from the COS definiton.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param attrName
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The name of the COS attribute to be removed.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public void removeCOSAttribute(String attrName);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This method returns an array of COS attributes.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return an array of COS attributes.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // Attribute name strings for COS definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents the default naming attribute for COS definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String DEFAULT_NAMING_ATTR = "cn";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents a keyword used in COS definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String COSTEMPLATEDN = "cosTemplateDn";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents a keyword used in COS definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String COSSPECIFIER = "cosSpecifier";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents a keyword used in COS definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String ICOSSPECIFIER = "cosIndirectSpecifier";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents a keyword used in COS definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String COSATTRIBUTE = "cosAttribute";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents an LDAP search filter used for searching for COS
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * definitions by name.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String COSSUPERDEF_NAME_SEARCH =
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster "(&(objectclass=ldapsubentry)(objectclass=cossuperdefinition)("
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents an LDAP search filter used for searching for COS
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String COSSUPERDEF_SEARCH =
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster "&(objectclass=ldapsubentry)(objectclass=cossuperdefinition)";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // for DS 4.x
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents a keyword used in Directory Server 4.x COS
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * implementations.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String COSTARGETTREE = "cosTargetTree";
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster // cosAttribute qualifiers for COS definitions.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents the minimum value a COS attribute qualifier may
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents the maximum value a COS attribute qualifier may
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents the numeric qualifier constant for "default".
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents the numeric qualifier constant for "override".
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents the numeric qualifier constant for "operational".
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This field represents the numeric qualifier constant for "merge-schemes".
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This represents a string array of COS attribute qualifiers. The valid
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * values are "default", "override", "operational", and "merge-schemes".
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public static final String[] qualifiers = { "default", "override",