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 2010 Sun Microsystems, Inc. 015 * Portions copyright 2011-2016 ForgeRock AS. 016 */ 017 018package org.forgerock.opendj.ldap; 019 020import org.forgerock.opendj.ldap.schema.Schema; 021 022/** 023 * Schema resolvers are included with a set of {@code DecodeOptions} in order to 024 * allow application to control how {@code Schema} instances are selected when 025 * decoding requests and responses. 026 * <p> 027 * Implementations must be thread safe. More specifically, any schema caching 028 * performed by the implementation must be capable of handling multiple 029 * concurrent schema requests. 030 * 031 * @see Schema 032 * @see DecodeOptions 033 */ 034public interface SchemaResolver { 035 /** 036 * A schema resolver which always returns the current default schema as 037 * returned by {@link Schema#getDefaultSchema()}. 038 */ 039 SchemaResolver DEFAULT = new SchemaResolver() { 040 @Override 041 public Schema resolveSchema(String dn) { 042 return Schema.getDefaultSchema(); 043 } 044 }; 045 046 /** 047 * Finds the appropriate schema for use with the provided distinguished 048 * name. 049 * <p> 050 * Schema resolution must always succeed regardless of any errors that 051 * occur. 052 * 053 * @param dn 054 * The string representation of a distinguished name associated 055 * with an entry whose schema is to be located. 056 * @return The appropriate schema for use with the provided distinguished 057 * name. 058 */ 059 Schema resolveSchema(String dn); 060}