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.server;
017
018
019
020import java.util.SortedSet;
021import org.forgerock.opendj.config.server.ConfigurationChangeListener;
022import org.forgerock.opendj.server.config.meta.CollationMatchingRuleCfgDefn.MatchingRuleType;
023
024
025
026/**
027 * A server-side interface for querying Collation Matching Rule
028 * settings.
029 * <p>
030 * Collation Matching Rules provide support for locale-specific
031 * filtering and indexing.
032 */
033public interface CollationMatchingRuleCfg extends MatchingRuleCfg {
034
035  /**
036   * Gets the configuration class associated with this Collation Matching Rule.
037   *
038   * @return Returns the configuration class associated with this Collation Matching Rule.
039   */
040  Class<? extends CollationMatchingRuleCfg> configurationClass();
041
042
043
044  /**
045   * Register to be notified when this Collation Matching Rule is changed.
046   *
047   * @param listener
048   *          The Collation Matching Rule configuration change listener.
049   */
050  void addCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener);
051
052
053
054  /**
055   * Deregister an existing Collation Matching Rule configuration change listener.
056   *
057   * @param listener
058   *          The Collation Matching Rule configuration change listener.
059   */
060  void removeCollationChangeListener(ConfigurationChangeListener<CollationMatchingRuleCfg> listener);
061
062
063
064  /**
065   * Gets the "collation" property.
066   * <p>
067   * the set of supported locales
068   * <p>
069   * Collation must be specified using the syntax: LOCALE:OID
070   *
071   * @return Returns an unmodifiable set containing the values of the "collation" property.
072   */
073  SortedSet<String> getCollation();
074
075
076
077  /**
078   * Gets the "java-class" property.
079   * <p>
080   * Specifies the fully-qualified name of the Java class that
081   * provides the Collation Matching Rule implementation.
082   *
083   * @return Returns the value of the "java-class" property.
084   */
085  String getJavaClass();
086
087
088
089  /**
090   * Gets the "matching-rule-type" property.
091   * <p>
092   * the types of matching rules that should be supported for each
093   * locale
094   *
095   * @return Returns an unmodifiable set containing the values of the "matching-rule-type" property.
096   */
097  SortedSet<MatchingRuleType> getMatchingRuleType();
098
099}