001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.server.dns.store;
021    
022    
023    import java.util.Set;
024    
025    import org.apache.directory.server.dns.DnsException;
026    import org.apache.directory.server.dns.messages.QuestionRecord;
027    import org.apache.directory.server.dns.messages.ResourceRecord;
028    
029    
030    /**
031     * The store interface used by the DNS protocol to lookup resource records.
032     * 
033     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034     * @version $Rev: 642496 $, $Date: 2008-03-29 04:09:22 +0100 (Sat, 29 Mar 2008) $
035     */
036    public interface RecordStore
037    {
038        /**
039         * Returns a set of {@link ResourceRecord}s, given a DNS {@link QuestionRecord}.
040         * If something bad happens throw the accurate {@link DnsException} 
041         * @param question
042         * @return The set of {@link ResourceRecord}s.
043         * @throws DnsException
044         */
045        public Set<ResourceRecord> getRecords( QuestionRecord question ) throws DnsException;
046    }