de.fhg.fokus.diameter.DiameterPeer.data.Codec Class Reference

List of all members.

---

Detailed Description

This class implements the Coding/Decoding of Diameter AVPs and Messages from/to network data.

It is implemented as conformant to RFC 3588

* The attributes can be accessed directly.

• An AVP can be created most simply by parsing an array of bytes starting at at position and decoding it from the network format using the AVP decode(buffer,start) method.
• To convert one AVP to the network format just call the byte[] encode(AVP) method
• To compute the network representation of an AVP just call the avp.group() method. This will refresh the data attribute, but will not reset the is_ungrouped flag as the childs Vector is still filled with data. You don't need to call this before an encode as it is automatically called if the is_ungrouped flag is set.

Author:

Dragos Vingarzan vingarzan -at- fokus dot fraunhofer dot de

Definition at line 59 of file Codec.java.

Static Public Member Functions
static AVP	decodeAVP (byte[] from, int start) throws AVPDecodeException
	Creates an AVP object by decoding data from a byte array as represented on network.
static byte[]	encodeAVP (AVP from)
	Encodes an AVP object into its network representation as a byte array.
static int	getEncodedAVPSize (AVP avp)
	Calculates the needed space for an encoded AVP.
static DiameterMessage	decodeDiameterMessage (byte[] from, int start) throws DiameterMessageDecodeException
	Creates an DiameterMessage object by decoding data from a byte array as represented on network.
static byte[]	encodeDiameterMessage (DiameterMessage from)
	Encodes an DiameterMessage object into its network represantation as a byte array.

---

Member Function Documentation

static AVP de.fhg.fokus.diameter.DiameterPeer.data.Codec.decodeAVP	(	byte[]	from,
		int	start
	)			throws AVPDecodeException [static]

Creates an AVP object by decoding data from a byte array as represented on network.

Parameters:

	from	the byte array
	start	from where to start decoding in the byte array

Returns:

the newly created AVP object

Exceptions:

AVPDecodeException

Definition at line 69 of file Codec.java.

References de.fhg.fokus.diameter.DiameterPeer.data.AVP.code, de.fhg.fokus.diameter.DiameterPeer.data.AVP.data, de.fhg.fokus.diameter.DiameterPeer.data.AVP.encoded_length, de.fhg.fokus.diameter.DiameterPeer.data.AVP.flag_mandatory, de.fhg.fokus.diameter.DiameterPeer.data.AVP.flag_protected, de.fhg.fokus.diameter.DiameterPeer.data.AVP.flag_vendor_specific, de.fhg.fokus.diameter.DiameterPeer.data.AVP.int_data, and de.fhg.fokus.diameter.DiameterPeer.data.AVP.vendor_id.

    {
        AVP to = new AVP();
        int i,j,len;
        
        if (from.length-start<8) throw new AVPDecodeException("Data is shorter than AVP Header");
        
        to.code =   ((int)from[start+0]&0xFF)<<24 |
                    ((int)from[start+1]&0xFF)<<16 |
                    ((int)from[start+2]&0xFF)<< 8 |
                    ((int)from[start+3]&0xFF);
        
        to.flag_vendor_specific =   (from[start+4] & 0x80)!=0;
        to.flag_mandatory =         (from[start+4] & 0x40)!=0;
        to.flag_protected =         (from[start+4] & 0x20)!=0;
        len =   ((int)from[start+5]&0xFF)<<16 |
                ((int)from[start+6]&0xFF)<< 8 |
                ((int)from[start+7]&0xFF);

        if (to.flag_vendor_specific){
            to.vendor_id =  ((int)from[start+ 8]&0xFF)<<24 |
                            ((int)from[start+ 9]&0xFF)<<16 |
                            ((int)from[start+10]&0xFF)<< 8 |
                            ((int)from[start+11]&0xFF);
            j = 12;
        } else {
            to.vendor_id = 0;
            j = 8;
        }

        if (len>from.length-start) len = from.length-start;
        to.data = new byte[len-j];
        System.arraycopy(from,start+j,to.data,0,len-j);
        
        if (len!=0)
        for(i=0;i<4&&i<len-j;i++)
            to.int_data = (to.int_data<<8)| ((byte) to.data[i]&0xFF);
        
        to.encoded_length = len;
        if (to.encoded_length%4!=0) 
            to.encoded_length = (to.encoded_length/4+1)*4; 
        
        return to;
    }

static byte [] de.fhg.fokus.diameter.DiameterPeer.data.Codec.encodeAVP

(

AVP

from

)

[static]

Encodes an AVP object into its network representation as a byte array.

Parameters:

from

the AVP object to encode

Returns:

the byte array in network ready format

Definition at line 119 of file Codec.java.

References de.fhg.fokus.diameter.DiameterPeer.data.AVP.code, de.fhg.fokus.diameter.DiameterPeer.data.AVP.data, de.fhg.fokus.diameter.DiameterPeer.data.AVP.flag_mandatory, de.fhg.fokus.diameter.DiameterPeer.data.AVP.flag_protected, de.fhg.fokus.diameter.DiameterPeer.data.AVP.flag_vendor_specific, de.fhg.fokus.diameter.DiameterPeer.data.AVP.group(), de.fhg.fokus.diameter.DiameterPeer.data.AVP.is_ungrouped, and de.fhg.fokus.diameter.DiameterPeer.data.AVP.vendor_id.

    {
        byte[] to = null;
        int total_len,send_len;
        int j;

        /* if it is ungrouped, we group it first */
        if (from.is_ungrouped)
            from.group();
        
        total_len=4+4+from.data.length;
        
        if (from.flag_vendor_specific) total_len+=4;
        send_len = total_len;
        if (total_len%4!=0) 
            total_len = (total_len/4+1)*4; 
        to = new byte[total_len];
        Arrays.fill(to,(byte)0);
        
        to[0] = (byte) ((from.code >> 24) & 0xFF);
        to[1] = (byte) ((from.code >> 16) & 0xFF);
        to[2] = (byte) ((from.code >>  8) & 0xFF);
        to[3] = (byte) ( from.code        & 0xFF);
        
        if (from.flag_vendor_specific) to[4] |= 0x80;
        if (from.flag_mandatory) to[4] |= 0x40;
        if (from.flag_protected) to[4] |= 0x20;
        to[5] = (byte) ((send_len >> 16) & 0xFF);
        to[6] = (byte) ((send_len >>  8) & 0xFF);
        to[7] = (byte) ( send_len        & 0xFF);
        
        if (from.flag_vendor_specific){
            to[ 8] = (byte) ((from.vendor_id >> 24) & 0xFF);
            to[ 9] = (byte) ((from.vendor_id >> 16) & 0xFF);
            to[10] = (byte) ((from.vendor_id >>  8) & 0xFF);
            to[11] = (byte) ( from.vendor_id        & 0xFF);
            j = 12;
        }
        else j = 8;
        
        if (from.data.length!=0)
            System.arraycopy(from.data,0,to,j,from.data.length);
    
        return to;
    }

static int de.fhg.fokus.diameter.DiameterPeer.data.Codec.getEncodedAVPSize

(

AVP

avp

)

[static]

Calculates the needed space for an encoded AVP.

Parameters:

avp

Returns:

The size of the AVP.

Definition at line 171 of file Codec.java.

References de.fhg.fokus.diameter.DiameterPeer.data.AVP.childs, de.fhg.fokus.diameter.DiameterPeer.data.AVP.data, de.fhg.fokus.diameter.DiameterPeer.data.AVP.flag_vendor_specific, and de.fhg.fokus.diameter.DiameterPeer.data.AVP.is_ungrouped.

    {
        AVP avp2;
        int datalen=0;
        int i;
        if (avp.is_ungrouped&&avp.childs!=null){
            for(i=0;i<avp.childs.size();i++){
                avp2 = (AVP) avp.childs.get(i);
                datalen += getEncodedAVPSize(avp2);
            }   
        }else{
            datalen += avp.data.length;
            if (datalen%4!=0) datalen = (datalen/4+1)*4;
        }
        if (avp.flag_vendor_specific) return 12+datalen;
        else return 8+datalen;
    }

static DiameterMessage de.fhg.fokus.diameter.DiameterPeer.data.Codec.decodeDiameterMessage	(	byte[]	from,
		int	start
	)			throws DiameterMessageDecodeException [static]

Creates an DiameterMessage object by decoding data from a byte array as represented on network.

Parameters:

	from	the byte array
	start	from where to start decoding in the byte array

Returns:

the newly created DiameterMessage object

Exceptions:

DiameterMessageDecodeException

Definition at line 197 of file Codec.java.

References de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.applicationID, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.avps, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.commandCode, de.fhg.fokus.diameter.DiameterPeer.data.AVP.encoded_length, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.endToEndID, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagError, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagProxiable, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagRequest, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagRetransmission, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.hopByHopID, and de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.version.

    {
        DiameterMessage to = new DiameterMessage();
        int i,len;
        AVP avp;
        
        if (from.length-start<20) throw new DiameterMessageDecodeException("Data is shorter than Diameter Message Header");
        
        to.version = ((int)from[start+0]&0xFF);
        if (to.version!=1) throw new DiameterMessageDecodeException("Unknown Diameter Message Version "+to.version);
        
        len =   ((int)from[start+ 1]&0xFF)<<16 |
                ((int)from[start+ 2]&0xFF)<< 8 |
                ((int)from[start+ 3]&0xFF);
        
        if (len>from.length-start) len=from.length-start;
        
        to.flagRequest =            (from[start+4] & 0x80)!=0;
        to.flagProxiable =      (from[start+4] & 0x40)!=0;
        to.flagError =          (from[start+4] & 0x20)!=0;
        to.flagRetransmission =     (from[start+4] & 0x10)!=0;

        to.commandCode =    ((int)from[start+ 5]&0xFF)<<16 |
                            ((int)from[start+ 6]&0xFF)<< 8 |
                            ((int)from[start+ 7]&0xFF);
        
        to.applicationID =  ((int)from[start+ 8]&0xFF)<<24 |
                            ((int)from[start+ 9]&0xFF)<<16 |
                            ((int)from[start+10]&0xFF)<< 8 |
                            ((int)from[start+11]&0xFF);

        to.hopByHopID = ((int)from[start+12]&0xFF)<<24 |
                            ((int)from[start+13]&0xFF)<<16 |
                            ((int)from[start+14]&0xFF)<< 8 |
                            ((int)from[start+15]&0xFF);

        to.endToEndID = ((int)from[start+16]&0xFF)<<24 |
                            ((int)from[start+17]&0xFF)<<16 |
                            ((int)from[start+18]&0xFF)<< 8 |
                            ((int)from[start+19]&0xFF);

        i = start+20;
        while (i<start+len){
            try {
                avp = Codec.decodeAVP(from,i);
            } catch (AVPDecodeException e) {
                e.printStackTrace();
                throw new DiameterMessageDecodeException(e.getMessage());
            }
            to.avps.add(avp);
            i+=avp.encoded_length;
        }       
        return to;
    }

static byte [] de.fhg.fokus.diameter.DiameterPeer.data.Codec.encodeDiameterMessage

(

DiameterMessage

from

)

[static]

Encodes an DiameterMessage object into its network represantation as a byte array.

Parameters:

from

the Diameter object to encode

Returns:

the byte array in network ready format

Definition at line 257 of file Codec.java.

References de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.applicationID, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.avps, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.commandCode, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.endToEndID, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagError, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagProxiable, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagRequest, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.flagRetransmission, de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.hopByHopID, and de.fhg.fokus.diameter.DiameterPeer.data.DiameterMessage.version.

    {
        byte[] to = null;
        int total_len;
        int i,len=0;
        Vector<byte[]> temp;
        byte[] t;
        
        temp = new Vector<byte[]>();
        for(i=0;i<from.avps.size();i++){
            t = Codec.encodeAVP((AVP)from.avps.get(i));
            temp.add(t);
            len += t.length;
        }
        total_len=20+len;
        
        to = new byte[total_len];
        Arrays.fill(to,(byte)0);

        to[0] = (byte) ( from.version     & 0xFF);
        to[1] = (byte) ((total_len >> 16) & 0xFF);
        to[2] = (byte) ((total_len >>  8) & 0xFF);
        to[3] = (byte) ( total_len        & 0xFF);
        
        if (from.flagRequest)           to[4] |= 0x80;
        if (from.flagProxiable)         to[4] |= 0x40;
        if (from.flagError)             to[4] |= 0x20;
        if (from.flagRetransmission)    to[4] |= 0x10;
        to[5] = (byte) ((from.commandCode >> 16) & 0xFF);
        to[6] = (byte) ((from.commandCode >>  8) & 0xFF);
        to[7] = (byte) ( from.commandCode        & 0xFF);
        
        to[ 8] = (byte) ((from.applicationID >> 24) & 0xFF);
        to[ 9] = (byte) ((from.applicationID >> 16) & 0xFF);
        to[10] = (byte) ((from.applicationID >>  8) & 0xFF);
        to[11] = (byte) ( from.applicationID        & 0xFF);        

        to[12] = (byte) ((from.hopByHopID >> 24) & 0xFF);
        to[13] = (byte) ((from.hopByHopID >> 16) & 0xFF);
        to[14] = (byte) ((from.hopByHopID >>  8) & 0xFF);
        to[15] = (byte) ( from.hopByHopID        & 0xFF);       

        to[16] = (byte) ((from.endToEndID >> 24) & 0xFF);
        to[17] = (byte) ((from.endToEndID >> 16) & 0xFF);
        to[18] = (byte) ((from.endToEndID >>  8) & 0xFF);
        to[19] = (byte) ( from.endToEndID        & 0xFF);       

        len = 20;
        for(i=0;i<temp.size();i++){
            t = temp.get(i);
            System.arraycopy(t,0,to,len,t.length);
            len += t.length;
        }       
    
        return to;
    }

---

The documentation for this class was generated from the following file:

• /tmp/snapshot2008729/JavaDiameterPeer/src/de/fhg/fokus/diameter/DiameterPeer/data/Codec.java

---