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.james.jspf.core;
021    
022    import org.apache.james.jspf.core.exceptions.NeutralException;
023    import org.apache.james.jspf.core.exceptions.NoneException;
024    import org.apache.james.jspf.core.exceptions.PermErrorException;
025    
026    /**
027     * 
028     * Implementations of this interface should handle parsing of SPFRecords
029     */
030    public interface SPFRecordParser {
031    
032        /**
033         * This Method parse the given spf record and checks for syntax
034         * 
035         * parse can be called by multiple concurrent threads.
036         * 
037         * @param spfRecord
038         *            The String which represent the spf record in dns
039         * @return result The SPF1Record
040         * @throws PermErrorException
041         *             Get thrown if an syntax error was detected
042         * @throws NoneException
043         *             Get thrown if no spf record could be found
044         * @throws NeutralException Get thrown if an empty spf record was found 
045         */
046        public SPF1Record parse(String spfRecord) throws PermErrorException,
047                NoneException, NeutralException;
048    
049    }