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.NeutralException;
23 import org.apache.james.jspf.core.exceptions.NoneException;
24 import org.apache.james.jspf.core.exceptions.PermErrorException;
25
26 /**
27 *
28 * Implementations of this interface should handle parsing of SPFRecords
29 */
30 public interface SPFRecordParser {
31
32 /**
33 * This Method parse the given spf record and checks for syntax
34 *
35 * parse can be called by multiple concurrent threads.
36 *
37 * @param spfRecord
38 * The String which represent the spf record in dns
39 * @return result The SPF1Record
40 * @throws PermErrorException
41 * Get thrown if an syntax error was detected
42 * @throws NoneException
43 * Get thrown if no spf record could be found
44 * @throws NeutralException Get thrown if an empty spf record was found
45 */
46 public SPF1Record parse(String spfRecord) throws PermErrorException,
47 NoneException, NeutralException;
48
49 }