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.jdkim.api;
21  
22  import java.util.List;
23  
24  import org.apache.james.jdkim.exceptions.PermFailException;
25  import org.apache.james.jdkim.exceptions.TempFailException;
26  
27  public interface PublicKeyRecordRetriever {
28  
29      /**
30       * @param methodAndOption
31       *                the options declared for the lookup method.
32       * @param selector
33       *                the value of "s=" tag
34       * @param token
35       *                the value of the "d=" tag
36       * @return A list of strings representing 0 to multiple records
37       * @throws TempFailException
38       *                 in case of timeout and other network errors.
39       * @throws PermFailException
40       *                 in case of unsupported options
41       */
42      public List/* String */getRecords(CharSequence methodAndOption,
43              CharSequence selector, CharSequence token)
44              throws TempFailException, PermFailException;
45  
46  }