1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20
21 package org.apache.directory.server.dns.store.jndi;
22
23
24 import java.util.Set;
25
26 import org.apache.directory.server.dns.DnsException;
27 import org.apache.directory.server.dns.messages.QuestionRecord;
28 import org.apache.directory.server.dns.messages.ResourceRecord;
29
30
31 /**
32 * Interface for search strategies. The DNS protocol may search a single
33 * base Dn for resource records or use a catalog to lookup resource records
34 * in multiple zones.
35 *
36 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
37 */
38 interface SearchStrategy
39 {
40 /**
41 * Returns a set of {@link ResourceRecord}s, given a DNS {@link QuestionRecord}.
42 *
43 * @param question The DNS question
44 * @return The set of {@link ResourceRecord}s.
45 * @throws DnsException If the records can't be found
46 */
47 Set<ResourceRecord> getRecords( QuestionRecord question ) throws DnsException;
48 }