org.mobicents.javax.servlet.sip.dns.DNSResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sip-servlets-client Show documentation
There is a newer version: 4.0.128
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This 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 software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.mobicents.javax.servlet.sip.dns;

import java.util.List;
import java.util.Set;

import javax.servlet.sip.SipURI;
import javax.servlet.sip.URI;

/**
 * Allows for an application to perform DNS queries to modify the SIP Message before it is sent out.

 * To get the DNSResolver from your application just use 
 *  * DNSResolver dnsResolver = (DNSResolver) getServletContext().getAttribute("org.mobicents.servlet.sip.DNS_RESOLVER");
 * 
 * 
 * @author [email protected]
 *
 */
public interface DNSResolver {

	/**
	 * From the uri passed in parameter, try to find the corresponding SipURI.
	 * If the uri in parameter is already a SipURI without a user=phone param, it is just returned
	 * If the uri in parameter is a TelURL or SipURI with a user=phone param, the phone number is converted to a domain name
	 * then a corresponding NAPTR DNS lookup is done to find the SipURI
	 * 
	 *  Usage Example 
	 * 	 * 	DNSResolver dnsResolver = (DNSResolver) getServletContext().getAttribute("org.mobicents.servlet.sip.DNS_RESOLVER");
	 * try {
	 *		URI uri = sipFactory.createURI("tel:+358-555-1234567");
	 *		SipURI sipURI = dnsResolver.getSipURI(uri);
	 * } catch (ServletParseException e) {
	 * 		logger.error("Impossible to create the tel URL", e);
	 * }
	 * 
	 * 
	 * @param uri the uri used to find the corresponding SipURI
	 * @return the SipURI found through ENUM methods or the uri itself if the uri is already a SipURI without a user=phone param
	 */
	SipURI getSipURI(URI uri);
	
	/**
	 * From the host in parameter, perform an A and AAAA Lookup and also use local host name to IP Address mapping (as DNSJava bypass the /etc/hosts)
	 * to find the list of IP Address corresponding to that hostname
	 * @param host hostname to resolve
	 * @return list of IP Addresses corresponding to that hostname
	 */
	Set resolveHost(String host);
        
	/**
	 * Discovers servers according to RFC 3263 and/or ENUM support for the given uri passed in parameters
	 * @param uri the uri for which the DNS lookups have to be done
	 * @return a List of SipURI that have to be tried each one in turn.
	 */
	List locateURIs(SipURI uri);        
        
        
	
	void setDnsTimeout(int timeout);
	int getDnsTimeout();
}