/**
 * JRadius - A RADIUS Server Java Adapter
 * Copyright (C) 2004-2005 PicoPoint, B.V.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

package net.jradius.freeradius;

import java.nio.ByteBuffer;
import java.nio.ByteOrder;

import net.jradius.packet.RadiusPacket;
import net.jradius.packet.attribute.AttributeList;
import net.jradius.server.JRadiusRequest;
import net.jradius.server.JRadiusServer;

import org.apache.commons.pool.ObjectPool;


/**
 * A FreeRADIUS Server Request
 *
 * @author David Bird
 */
public class FreeRadiusRequest extends JRadiusRequest
{
	private static final long serialVersionUID = 1L;
	
	protected int type;
    
	protected RadiusPacket packets[];
    protected AttributeList configItems;
    
    protected int returnValue = JRadiusServer.RLM_MODULE_UPDATED;
    
    protected ObjectPool borrowedFromPool;

    protected final ByteBuffer buffer_in;
    protected final ByteBuffer buffer_out;

    public FreeRadiusRequest()
    {
    	super();
    	
    	buffer_in = ByteBuffer.allocate(25000);
    	buffer_in.order(ByteOrder.BIG_ENDIAN);

    	buffer_out = ByteBuffer.allocate(25000);
    	buffer_out.order(ByteOrder.BIG_ENDIAN);
    }
    
    /**
     * @return the "config_items" of the request (FreeRADIUS "control"
     * 			attributes)
     */
    public AttributeList getConfigItems()
    {
        return configItems;
    }
    
    /**
     * @return the request packet array
     */
    public RadiusPacket[] getPackets()
    {
        return packets;
    }
    
    /**
     * @return the request type
     */
    public int getType()
    {
        return type;
    }
    
    /**
     * @return Returns the returnValue.
     */
    public int getReturnValue()
    {
        return returnValue;
    }

    /**
     * Set the "config_items" of the request (FreeRADIUS "control"
     * attributes)
     * @param configItems
     */
    public void setConfigItems(AttributeList configItems)
    {
        this.configItems = configItems;
    }
    
    /**
     * Set the packet array of the request
     * @param packets
     */
    public void setPackets(RadiusPacket[] packets)
    {
        this.packets = packets;
    }

    /**
     * Set the type of the request
     * @param type
     */
    public void setType(int type)
    {
        this.type = type;
    }
        
    /**
     * @param returnValue The returnValue to set.
     */
    public void setReturnValue(int returnValue)
    {
        this.returnValue = returnValue;
    }
    
    public String getTypeString()
    {
        switch(getType())
        {
            case JRadiusServer.JRADIUS_authenticate: return "authenticate";
            case JRadiusServer.JRADIUS_authorize:    return "authorize";
            case JRadiusServer.JRADIUS_preacct:      return "preacct";
            case JRadiusServer.JRADIUS_accounting:   return "accounting";
            case JRadiusServer.JRADIUS_checksimul:   return "checksimul";
            case JRadiusServer.JRADIUS_pre_proxy:    return "pre_proxy";
            case JRadiusServer.JRADIUS_post_proxy:   return "post_proxy";
            case JRadiusServer.JRADIUS_post_auth:    return "post_auth";
            default:                                 return "UNKNOWN";
        }
    }

	public ObjectPool getBorrowedFromPool() {
		return borrowedFromPool;
	}

	public void setBorrowedFromPool(ObjectPool borrowedFromPool) {
		this.borrowedFromPool = borrowedFromPool;
	}
}