top.hmtools.javaWeb.userAgent.UserAgentTools Maven / Gradle / Ivy

Go to download
package top.hmtools.javaWeb.userAgent;

/**
 * Container class for user-agent information with operating system and browser details. 
 * Can decode user-agent strings.
 * 


 * Resources:

 * User Agent String.Com

 * List of User-Agents

 * Browser ID (User-Agent) Strings

 * Mobile Browser ID (User-Agent) Strings

 * Browser-Kennungen

 * Device Atlas - Mobile Device Intelligence

 * Mobile Opera user-agent strings

 * S60 platform

 * Understanding User-Agent Strings

 * Sony Ericsson Web Docs & Tools

 * What is the Safari user-agent string

 * List of User Agent Strings

 * Detecting Internet Explorer Mobile's User-Agent on the server
 */

/**
 * @author harald
 *
 */
public class UserAgentTools
{
	
	private OperatingSystem operatingSystem = OperatingSystem.UNKNOWN;
	private Browser browser = Browser.UNKNOWN;
	private int id;
	private String userAgentString;
		
	/**
	 * 构造函数。
	 * 
根据操作系统（枚举），浏览器（枚举）初始化userAgentTools（useragent信息）对象实例
	 * @param operatingSystem
	 * @param browser
	 */
	public UserAgentTools(OperatingSystem operatingSystem, Browser browser)
	{
		this.operatingSystem = operatingSystem;
		this.browser = browser;
		this.id = (( operatingSystem.getId() << 16) + browser.getId());
	}
	
	/**
	 * 构造函数。
	 * 
根据userAgent字符串（从HTTP header信息中提取）
	 * @param userAgentString
	 */
	public UserAgentTools(String userAgentString)
	{
		Browser browser = Browser.parseUserAgentString(userAgentString);
		
		OperatingSystem operatingSystem = OperatingSystem.UNKNOWN;
		
		// BOTs don't have an interesting OS for us
		if (browser != Browser.BOT)
			operatingSystem = OperatingSystem.parseUserAgentString(userAgentString);
		
		this.operatingSystem = operatingSystem;
		this.browser = browser;
		this.id = (( operatingSystem.getId() << 16) + browser.getId());
		this.userAgentString = userAgentString;
	}

	
	/**
	 * 根据userAgent字符串（从HTTP header信息中提取）获取userAgentTools（useragent信息）对象实例
	 * @param userAgentString
	 * @return UserAgent
	 */
	public static UserAgentTools parseUserAgentString(String userAgentString) {		
		return new UserAgentTools(userAgentString);
	}
	

	/**
	 * 获取浏览器版本信息
	 * 
必须在执行 UserAgent(String) 或者 UserAgent.parseUserAgent(String)后使用。 
	 * 
如果没有可用的信息，会返回null
	 * @return Version
	 */
	public Version getBrowserVersion() {
		return this.browser.getVersion(this.userAgentString);
	}
	
	/**
	 * 获取客户端操作系统信息
	 * 
必须在执行 UserAgent(String) 或者 UserAgent.parseUserAgent(String)后使用。 
	 * 
如果没有可用的信息，会返回null
	 * @return the system
	 */
	public OperatingSystem getOperatingSystem() {
		return operatingSystem;
	}

	/**
	 * 获取客户端浏览器信息
	 * 
必须在执行 UserAgent(String) 或者 UserAgent.parseUserAgent(String)后使用。 
	 * 
如果没有可用的信息，会返回null
	 * @return the browser
	 */
	public Browser getBrowser() {
		return browser;
	}

	/**
	 * Returns an unique integer value of the operating system & browser combination
	 * @return the id
	 */
	public int getId() {
		return id;
	}

	/**
	 * Combined string representation of both enums
	 */
	public String toString() {
		return this.operatingSystem.toString() + "-" + this.browser.toString();
	}
	
	/**
	 * Returns UserAgent based on specified unique id
	 * @param id
	 * @return
	 */
	public static UserAgentTools valueOf(int id)
	{
		OperatingSystem operatingSystem = OperatingSystem.valueOf((short) (id >> 16));
		Browser browser = Browser.valueOf( (short) (id & 0x0FFFF));
		return new UserAgentTools(operatingSystem,browser);
	}
	
	/**
	 * Returns UserAgent based on combined string representation
	 * @param name
	 * @return
	 */
	public static UserAgentTools valueOf(String name)
	{
		if (name == null)
            throw new NullPointerException("Name is null");
		
		String[] elements = name.split("-");
		
		if (elements.length == 2)
		{
			OperatingSystem operatingSystem = OperatingSystem.valueOf(elements[0]);
			Browser browser = Browser.valueOf(elements[1]);
			return new UserAgentTools(operatingSystem,browser);
		}
		
		throw new IllegalArgumentException(
	            "Invalid string for userAgent " + name);
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((browser == null) ? 0 : browser.hashCode());
		result = prime * result + id;
		result = prime * result
				+ ((operatingSystem == null) ? 0 : operatingSystem.hashCode());
		return result;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		final UserAgentTools other = (UserAgentTools) obj;
		if (browser == null) {
			if (other.browser != null)
				return false;
		} else if (!browser.equals(other.browser))
			return false;
		if (id != other.id)
			return false;
		if (operatingSystem == null) {
			if (other.operatingSystem != null)
				return false;
		} else if (!operatingSystem.equals(other.operatingSystem))
			return false;
		return true;
	}	
	
}