org.linkeddatafragments.fragments.IFragmentRequestParser Maven / Gradle / Ivy

package org.linkeddatafragments.fragments;

import org.linkeddatafragments.config.ConfigReader;

import javax.servlet.http.HttpServletRequest;

/**
 * Parses HTTP requests into specific {@link ILinkedDataFragmentRequest}s.
 *
 * @author Olaf Hartig
 */
public interface IFragmentRequestParser
{
    /**
     * Parses the given HTTP request into a specific
     * {@link ILinkedDataFragmentRequest}.
     *
     * @param httpRequest
     * @param config
     * @return
     * @throws IllegalArgumentException
     *         If the given HTTP request cannot be interpreted (perhaps due to
     *         missing request parameters).
     */
    ILinkedDataFragmentRequest parseIntoFragmentRequest(
            final HttpServletRequest httpRequest,
            final ConfigReader config)
                    throws IllegalArgumentException;
}