Controller.java

/*
 * Copyright (c) 2014. by Robusta Code and individual contributors
 *  as indicated by the @authors tag. See the copyright.txt in the
 * distribution for a full listing of individual contributors.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package io.robusta.rra.controller;

import java.io.IOException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Created by Nicolas Zozol for Robusta Code
 * 
 * @author Nicolas Zozol
 */
public interface Controller {

    /**
     * retrieve the entity of the httpServletRequest and check if it contains specified keys
     * @param req
     * @param resp
     * @param keys
     * @return
     * @throws IOException
     */
    public boolean validate( HttpServletRequest req, HttpServletResponse resp, String... keys ) throws IOException;

    /**
     * retrieve the username and the password from the entity of the httpServletRequest
     * @param req
     * @param resp
     * @return user password
     */
    public String[] getBasicAuthentication( HttpServletRequest req, HttpServletResponse resp );

}