AVP.java

Go to the documentation of this file.

/*
 * $Id: AVP.java 361 2007-06-28 21:07:47Z vingarzan $
 *
 * Copyright (C) 2004-2006 FhG Fokus
 *
 * This file is part of Open IMS Core - an open source IMS CSCFs & HSS
 * implementation
 *
 * Open IMS Core is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * For a license to use the Open IMS Core software under conditions
 * other than those described here, or to purchase support for this
 * software, please contact Fraunhofer FOKUS by e-mail at the following
 * addresses:
 *     info@open-ims.org
 *
 * Open IMS Core 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

package de.fhg.fokus.diameter.DiameterPeer.data;

import java.util.Vector;

public class AVP {
    
    public int code=0;
    
    public boolean flag_vendor_specific=false;
    
    public boolean flag_mandatory=true;
    
    public boolean flag_protected=false;
    
    public int vendor_id=0;
        
    public int encoded_length=0;
    
    
    public byte[] data={};
    
    public int int_data;
    
    public Vector childs = null;
    
    public boolean is_ungrouped=false;

    
    public AVP()
    {
    }
    
    public AVP(int Code,boolean Vendor_Specific,boolean Mandatory,boolean Protected,
            int Vendor_id)
    {
        this.code = Code;
        this.flag_vendor_specific = Vendor_Specific;
        this.flag_mandatory = Mandatory;
        this.flag_protected = Protected;
        this.vendor_id = Vendor_id;
        if (this.vendor_id!=0) this.flag_vendor_specific = true;
    }
    
    
    public AVP(int Code,boolean Mandatory,int Vendor_id)
    {
        this.code = Code;
        this.flag_mandatory = Mandatory;
        this.vendor_id = Vendor_id;
        if (this.vendor_id!=0) this.flag_vendor_specific = true;
    }

    public void setData(byte[] Data)
    {
        this.data = Data;
        for(int i=0;i<4&&i<data.length;i++)
            int_data = (int_data<<8)|(0xFF & data[i]);      
    }

    public void setData(byte[] Data,int start,int len)
    {
        if (len<Data.length - start)
            len = Data.length - start;
        this.data = new byte[len];
        System.arraycopy(Data,start,this.data,0,len);
        for(int i=0;i<4&&i<data.length;i++)
            int_data = (int_data<<8)|(0xFF & data[i]);
        
    }
    
    public void setData(char[] Data)
    {
        this.data = new byte[Data.length];
        System.arraycopy(Data,0,this.data,0,Data.length);
        for(int i=0;i<4&&i<data.length;i++)
            int_data = (int_data<<8)|(0xFFFF & data[i]);        
    }

    public void setData(String Data)
    {
        this.data = Data.getBytes();
        for(int i=0;i<4&&i<data.length;i++)
            int_data = (int_data<<8)|(0xFF & data[i]);
    }

    public void setData(int Data)
    {
        data = new byte[4];
        data[0] = (byte)((Data>>24) &0xFF);
        data[1] = (byte)((Data>>16) &0xFF);
        data[2] = (byte)((Data>> 8) &0xFF);
        data[3] = (byte)((Data    ) &0xFF);
        int_data = Data;
    }

    public int getIntData() {
        return int_data;
    }
    
    public byte[] getData() {
        return data;
    }
    
    public void addChildAVP(AVP child)
    {
        if (!is_ungrouped) is_ungrouped = true;
        if (childs == null) childs = new Vector();
        childs.add(child);
    }
    
    public int getChildCount()
    {
        if (!is_ungrouped||childs==null) return 0;
        return childs.size();
    }
    
    public AVP getChildAVP(int index)
    {
        if (!is_ungrouped||childs==null) return null;
        if (index<childs.size())
            return (AVP)childs.get(index);
        else return null;
    }
    
    public void deleteChildAVP(AVP avp)
    {
        if (!is_ungrouped||childs==null) return;
        childs.remove(avp);
    }
    
    public AVP findChildAVP(int Code)
    {
        AVP avp;
        if (!is_ungrouped) return null;
        for(int i=0;i<childs.size();i++){
            avp = (AVP) childs.get(i);
            if (avp.code == Code) {
                return avp;
            }
        }
        return null;
    }
    
    public AVP findChildAVP(int Code,boolean Mandatory,int Vendor_id)
    {
        AVP avp;
        if (!is_ungrouped) return null;
        for(int i=0;i<childs.size();i++){
            avp = (AVP) childs.get(i);
            if (avp.code == Code &&
                avp.flag_mandatory == Mandatory &&
                avp.vendor_id == Vendor_id) 
                    return avp;
        }
        return null;
    }
    
    public AVP[] findChildAVPs(int Code)
    {
        
        AVP[] avpset;
        int j = 0, count = 0;
        AVP avp;
        
        if (!is_ungrouped) return null;
        
        for(int i=0;i<childs.size();i++){
            avp = (AVP) childs.get(i);
            if (avp.code == Code)
                    count++;
        }
        
        if (count == 0) return null;
        avpset = new AVP[count];
        for(int i=0;i<childs.size();i++){
            avp = (AVP) childs.get(i);
            if (avp.code == Code) {
                avpset[j++] = avp;
                if (j == count) break;
            }
        }

        return avpset;
    }

    public void ungroup() throws AVPDecodeException
    {
        int i = 0;
        AVP x;
        if (is_ungrouped) return;
        is_ungrouped = true;
        childs = new Vector();
        while (i<data.length){
            x = Codec.decodeAVP(data,i);
            childs.add(x);
            i+=x.encoded_length;
        }
    }
    
    public void group() 
    {
        Vector temp;
        int i,len=0;
        byte[] t;
        if (!is_ungrouped||childs==null||childs.size()==0) {
            data = new byte[0];
        }
        temp = new Vector();
        for(i=0;i<childs.size();i++){
            t = Codec.encodeAVP((AVP)childs.get(i));
            temp.add(t);
            len += t.length;
        }
        data = new byte[len];
        len = 0;
        for(i=0;i<temp.size();i++){
            t = (byte[]) temp.get(i);
            System.arraycopy(t,0,data,len,t.length);
            len += t.length;
        }
    }
    
    public String toString()
    {
        StringBuffer x = new StringBuffer();

        int i;
        x.append("AVP:");
        x.append(" Code=");x.append(code);
        if (flag_vendor_specific) x.append(" V");
        if (flag_mandatory) x.append(" M");
        if (flag_protected) x.append(" P");
        x.append(" Len=");x.append(data.length);
        if (flag_vendor_specific){
            x.append(" V_ID=");x.append(vendor_id);
        }
        x.append(" Data=0x");
        for(i=0;i<data.length;i++){
            x.append(hexa[(data[i]>>4)&0x0F]);
            x.append(hexa[data[i]&0x0F]);
        }
        x.append(" INT_Data=");x.append(int_data);
        x.append(" Char_Data=\"");
        for(i=0;i<data.length;i++)
            if (data[i]>=32&&data[i]<=126)
                x.append((char)data[i]);
            else 
                x.append(".");
        x.append("\"");
        if (is_ungrouped){
            x.append(" {");
            for(i=0;i<childs.size();i++){
                if (i!=0) x.append(",");
                x.append(childs.get(i).toString());
            }
            x.append("}");
        }
        return x.toString();
    }

    
    private static char[] hexa={'0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f'};
    
    public static final int Session_Id          = 263;
    
    public static final int Origin_Host         = 264;
    
    public static final int Origin_Realm        = 296;

    public static final int Destination_Host    = 293;
    
    public static final int Destination_Realm   = 283;
    
    public static final int Auth_Application_Id = 258;
    
    public static final int Acct_Application_Id = 259;
    
    public static final int Vendor_Specific_Application_Id  = 260;
    
    public static final int Vendor_Id           = 266;
    
    public static final int Result_Code         = 268;
    
    public static final int Host_IP_Address     = 257;
    
    public static final int Product_Name        = 269;
    
    public static final int Disconnect_Cause    = 273;
    
}

---