View Javadoc

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  package org.apache.james.jspf.core;
21  
22  import org.apache.james.jspf.core.exceptions.TimeoutException;
23  
24  import java.util.List;
25  
26  /**
27   * Interface which should be used to access all necassary DNS-Records
28   *  
29   */
30  public interface DNSService {
31      
32      /**
33       * Retrieve dns records for the given host
34       * 
35       * @param request the dns request
36       * @return an array of Strings representing the records
37       * @throws TimeoutException
38       */
39      public List getRecords(DNSRequest request) throws TimeoutException;
40  
41      /**
42       * Try to get all domain names for the running host
43       * 
44       * @return names A List contains all domain names which could resolved
45       */
46      public List getLocalDomainNames();
47  
48      /**
49       * Set the timeout for DNS-Requests
50       * 
51       * @param timeOut The timeout in seconds
52       */
53      public void setTimeOut(int timeOut);
54      
55      /**
56       * @return the current record limit
57       */
58      public int getRecordLimit();
59  
60      /**
61       * Sets a new limit for the number of records for MX and PTR lookups.
62       * 
63       * @param recordLimit the new limit (0 => unlimited)
64       */
65      public void setRecordLimit(int recordLimit);
66  
67  }