SipCommHop.java

/*
 * Copyright (C) 2005-2008 Jive Software. All rights reserved.
 *
 * Licensed 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 org.jivesoftware.openfire.sip.tester.stack;

import org.jivesoftware.openfire.sip.tester.Log;

import java.util.StringTokenizer;

/**
 * Routing algorithms return a list of hops to which the request is routed.
 *
 * @author M. Ranganathan <mranga@nist.gov> <br/> <a href=" {@docRoot}
 *         /uncopyright.html">This code is in the public domain.</a> IPv6
 *         Support added by Emil Ivov (emil_ivov (at) yahoo (dot) com)<br/>
 *         Network Research Team (http://www-r2.u-strasbg.fr))<br/> Louis
 *         Pasteur University - Strasbourg - France<br/>
 * @version JAIN-SIP-1.1
 */
public class SipCommHop implements javax.sip.address.Hop {

    protected String host;
    protected int port;
    protected String transport;
    protected boolean explicitRoute; // this is generated from a ROUTE
    protected boolean defaultRoute; // This is generated from the proxy addr
    protected boolean uriRoute; // This is extracted from the requestURI.

    /**
     * Debugging println.
     */
    @Override
	public String toString() {
        return host + ":" + port + "/" + transport;
    }

    /**
     * Create new hop given host, port and transport.
     *
     * @param hostName   hostname
     * @param portNumber port
     * @param trans      transport
     */
    public SipCommHop(String hostName, int portNumber, String trans) {
        host = hostName;
        port = portNumber;
        transport = trans;
    }

    /**
     * Creates new Hop
     *
     * @param hop is a hop string in the form of host:port/Transport
     * @throws IllegalArgumentException exception if string is not properly formatted or null.
     */
    public SipCommHop(String hop) throws IllegalArgumentException {
        if (hop == null) {
            Log.debug("SipCommHop", "Null arg: " + hop);
            throw new IllegalArgumentException("Null arg!");
        }
        StringTokenizer stringTokenizer = new StringTokenizer(hop + "/");
        String hostPort = stringTokenizer.nextToken("/").trim();
        transport = stringTokenizer.nextToken().trim();

        if (transport == null) {
            transport = "UDP";
        } else if (transport == "") {
            transport = "UDP";
        }
        if (transport.compareToIgnoreCase("UDP") != 0
                && transport.compareToIgnoreCase("TCP") != 0) {
            throw new IllegalArgumentException(hop);
        }
        String portString = null;
        // IPv6 hostport
        if (hostPort.charAt(0) == '[') {
            int rightSqBrackIndex = hostPort.indexOf(']');
            if (rightSqBrackIndex == -1) {
                throw new IllegalArgumentException("Bad IPv6 reference spec");
            }
            host = hostPort.substring(0, rightSqBrackIndex + 1);
            int portColon = hostPort.indexOf(':', rightSqBrackIndex);
            if (portColon != -1) {
                try {
                    portString = hostPort.substring(portColon + 1).trim();
                }
                catch (IndexOutOfBoundsException exc) {
                    // Do nothing - handled later
                }
            }
        }
        // IPv6 address and no port
        else if (hostPort.indexOf(':') != hostPort.lastIndexOf(":")) {
            host = '[' + hostPort + ']';
        } else { // no square brackets and a single or zero colons => IPv4
            // hostPort
            int portColon = hostPort.indexOf(':');
            if (portColon == -1) {
                host = hostPort;
            } else {
                host = hostPort.substring(0, portColon).trim();
                try {
                    portString = hostPort.substring(portColon + 1).trim();
                }
                catch (IndexOutOfBoundsException exc) {
                    // Do nothing - handled later
                }
            }
        }
        if (host == null || host.equals("")) {
            throw new IllegalArgumentException("no host!");
        }
        if (portString == null || portString.equals("")) {
            port = 5060;
        } else {
            try {
                port = Integer.parseInt(portString);
            }
            catch (NumberFormatException ex) {
                throw new IllegalArgumentException("Bad port spec");
            }
        }
    }

    /**
     * Retruns the host string.
     *
     * @return host String
     * @uml.property name="host"
     */
    public String getHost() {
        return host;
    }

    /**
     * Returns the port.
     *
     * @return port integer.
     * @uml.property name="port"
     */
    public int getPort() {
        return port;
    }

    /**
     * returns the transport string.
     *
     * @uml.property name="transport"
     */
    public String getTransport() {
        return transport;
    }

    /**
     * Return true if this is an explicit route (ie. extrcted from a ROUTE
     * Header)
     *
     * @uml.property name="explicitRoute"
     */
    public boolean isExplicitRoute() {
        return explicitRoute;
    }

    /**
     * Return true if this is a default route (ie. next hop proxy address)
     *
     * @uml.property name="defaultRoute"
     */
    public boolean isDefaultRoute() {
        return defaultRoute;
    }

    /**
     * Return true if this is uriRoute
     */
    public boolean isURIRoute() {
        return uriRoute;
    }

    /**
     * Set the URIRoute flag.
     */
    public void setURIRouteFlag() {
        uriRoute = true;
    }

    /**
     * Set the defaultRouteFlag.
     */
    public void setDefaultRouteFlag() {
        defaultRoute = true;
    }

    /**
     * Set the explicitRoute flag.
     */
    public void setExplicitRouteFlag() {
        explicitRoute = true;
    }
}