1/*
2* Conditions Of Use
3*
4* This software was developed by employees of the National Institute of
5* Standards and Technology (NIST), an agency of the Federal Government.
6* Pursuant to title 15 Untied States Code Section 105, works of NIST
7* employees are not subject to copyright protection in the United States
8* and are considered to be in the public domain.  As a result, a formal
9* license is not needed to use the software.
10*
11* This software is provided by NIST as a service and is expressly
12* provided "AS IS."  NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
13* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
14* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
15* AND DATA ACCURACY.  NIST does not warrant or make any representations
16* regarding the use of the software or the results thereof, including but
17* not limited to the correctness, accuracy, reliability or usefulness of
18* the software.
19*
20* Permission to use this software is contingent upon your acceptance
21* of the terms of this agreement
22*
23* .
24*
25*/
26/*******************************************************************************
27* Product of NIST/ITL Advanced Networking Technologies Division (ANTD).        *
28*******************************************************************************/
29package gov.nist.javax.sip.header;
30
31import gov.nist.javax.sip.address.*;
32
33/**
34 * The Request-Route header is added to a request by any proxy that insists on
35 * being in the path of subsequent requests for the same call leg.
36 *
37 *@version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:35 $
38 *
39 *@author M. Ranganathan   <br/>
40 *
41 *
42 *
43 */
44public class RecordRoute
45    extends AddressParametersHeader
46    implements javax.sip.header.RecordRouteHeader {
47
48    /**
49     * Comment for <code>serialVersionUID</code>
50     */
51    private static final long serialVersionUID = 2388023364181727205L;
52
53    /**
54     * constructor
55     * @param address address to set
56     */
57    public RecordRoute(AddressImpl address) {
58        super(NAME);
59        this.address = address;
60    }
61
62    /**
63     * default constructor
64     */
65    public RecordRoute() {
66        super(RECORD_ROUTE);
67
68    }
69
70    /** Encode into canonical form.
71     *@return String containing the canonicaly encoded header.
72     */
73    public String encodeBody() {
74        return encodeBody(new StringBuffer()).toString();
75    }
76
77    protected StringBuffer encodeBody(StringBuffer buffer) {
78        if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
79            buffer.append(LESS_THAN);
80        }
81        address.encode(buffer);
82        if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
83            buffer.append(GREATER_THAN);
84        }
85
86        if (!parameters.isEmpty()) {
87            buffer.append(SEMICOLON);
88            this.parameters.encode(buffer);
89        }
90        return buffer;
91    }
92}
93