org.cybergarage.upnp.control.ControlRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of router Show documentation
The I2P router
There is a newer version: 2.6.0
/******************************************************************
*
*	CyberUPnP for Java
*
*	Copyright (C) Satoshi Konno 2002
*
*	File: ControlRequest.java
*
*	Revision:
*
*	01/29/03
*		- first revision.
*	05/22/03
*		- Giordano Sassaroli 
*		- Description: inserted a check at the beginning of the setRequestHost method
*		- Problem : If the host does not start with a '/', the device could refuse the control action
*		- Error : it is not an error, but adding the '/' when missing allows the integration with the Intel devices
*	09/02/03
*		- Giordano Sassaroli  / Suzan Foster
*		- Problem : NullpointerException thrown for devices whose description use absolute urls
*		- Error : the presence of a base url is not mandatory, the API code makes the assumption that control and event subscription urls are relative. 
*		  If the baseUrl is not present, the request host and port should be extracted from the control/subscription url
*		- Description: The method setRequestHost/setService should be changed as follows
*	02/17/04
*		- Rob van den Boomen 
*		- Fixed to set a URLBase from the SSDP header when the URLBase of the description is null.
*	02/18/04
*		- Andre 
*		- The xml nodes controlUrl and eventSubUrl can contain absolut urls, but these absolut urls may have 
*		  different ports than the base url! (so seen on my SMC 7004ABR Barricade Router, where xml files are 
*		  requested from port 80, but soap requests are made on port 5440). Therefore whenever a request is made, 
*		  the port specified by the controlUrl or eventSubUrl node should be used, else no response will be returned 
*		  (oddly, there was a response returned even on port 80, but with empty body tags. but the correct response 
*		  finally came from port 5440).
*		- Fixed to get the port from the control url when it is absolute.
*	03/20/04
*		- Thanks for Thomas Schulz 
*		- Fixed setRequestHost() for Sony's UPnP stack when the URLBase has the path.
*
******************************************************************/

package org.cybergarage.upnp.control;

import java.net.*;

import org.cybergarage.http.*;
import org.cybergarage.soap.*;

import org.cybergarage.upnp.*;

public class ControlRequest extends SOAPRequest
{
	// I2P see setRequestHost();
	private static final String WAN_IPV6_CONNECTION = "urn:schemas-upnp-org:service:WANIPv6FirewallControl:1";

	////////////////////////////////////////////////
	//	Constructor
	////////////////////////////////////////////////
	
	public ControlRequest()
	{
	}

	public ControlRequest(HTTPRequest httpReq)
	{
		set(httpReq);
	}

	////////////////////////////////////////////////
	//	Query
	////////////////////////////////////////////////

	public boolean isQueryControl()
	{
		return isSOAPAction(Control.QUERY_SOAPACTION);
	}
	
	public boolean isActionControl()
	{
		return !isQueryControl();
	}

	////////////////////////////////////////////////
	//	setRequest
	////////////////////////////////////////////////

	protected void setRequestHost(Service service)
	{
		String ctrlURL = service.getControlURL();

		// Thanks for Thomas Schulz (2004/03/20)
		String urlBase = service.getRootDevice().getURLBase();
		if (urlBase != null && 0 < urlBase.length()){
			try {
				URL url = new URL(urlBase);
				String basePath = url.getPath();
				int  baseLen = basePath.length();
				if (0 < baseLen) {
					if (1 < baseLen || (basePath.charAt(0) != '/'))
						ctrlURL = basePath + ctrlURL;
				}
			}
			catch (MalformedURLException e) {}
		}

		// Thanks for Giordano Sassaroli  (05/21/03)
		setURI(ctrlURL, true);

		// Thanks for Giordano Sassaroli  and Suzan Foster (09/02/03)
		// Thanks for Andre  (02/18/04)
		String postURL = "";
		if (HTTP.isAbsoluteURL(ctrlURL) == true)
			postURL = ctrlURL;
		
		if (postURL == null || postURL.length() <= 0)
			postURL = service.getRootDevice().getURLBase();

		// Thanks for Rob van den Boomen  (02/17/04)
		// BUGFIX, set urlbase from location string if not set in description.xml
		if (postURL == null || postURL.length() <= 0) {
			// I2P
			// if service is ipv6 service...
			String type = service.getServiceType();
			boolean preferIPv6 = WAN_IPV6_CONNECTION.equals(type);
			postURL = service.getRootDevice().getLocation(preferIPv6);
		}
		
		String reqHost = HTTP.getHost(postURL);
		int reqPort = HTTP.getPort(postURL);
		
		setHost(reqHost, reqPort);
		setRequestHost(reqHost);
		setRequestPort(reqPort);
	}
	
}