eu.bitwalker.useragentutils.UserAgent Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2014, Harald Walker (bitwalker.eu) and contributing developers
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* * Neither the name of bitwalker nor the names of its
* contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package eu.bitwalker.useragentutils;
import java.io.Serializable;
/**
* Container class for user-agent information with operating system and browser details.
* Can decode user-agent strings.
*
* Resources:
* User Agent String.Com
* My User Agent String
* List of User-Agents
* user-agent-string.info
* 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 UserAgent implements Serializable
{
private static final long serialVersionUID = 7025462762784240212L;
private OperatingSystem operatingSystem = OperatingSystem.UNKNOWN;
private Browser browser = Browser.UNKNOWN;
private int id;
private String userAgentString;
public UserAgent(OperatingSystem operatingSystem, Browser browser)
{
this.operatingSystem = operatingSystem;
this.browser = browser;
this.id = (( operatingSystem.getId() << 16) + browser.getId());
}
public UserAgent(String userAgentString)
{
String userAgentLowercaseString = userAgentString == null ? null : userAgentString.toLowerCase();
Browser browser = Browser.parseUserAgentLowercaseString(userAgentLowercaseString);
OperatingSystem operatingSystem = OperatingSystem.UNKNOWN;
// BOTs don't have an interesting OS for us
if (browser != Browser.BOT)
operatingSystem = OperatingSystem.parseUserAgentLowercaseString(userAgentLowercaseString);
this.operatingSystem = operatingSystem;
this.browser = browser;
this.id = ((operatingSystem.getId() << 16) + browser.getId());
this.userAgentString = userAgentString;
}
/**
* @param userAgentString
* @return UserAgent
*/
public static UserAgent parseUserAgentString(String userAgentString) {
return new UserAgent(userAgentString);
}
/**
* Detects the detailed version information of the browser. Depends on the userAgent to be available.
* Use it only after using UserAgent(String) or UserAgent.parseUserAgent(String).
* Returns null if it can not detect the version information.
* @return Version
*/
public Version getBrowserVersion() {
return this.browser.getVersion(this.userAgentString);
}
/**
* @return the system
*/
public OperatingSystem getOperatingSystem() {
return operatingSystem;
}
/**
* @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 UserAgent valueOf(int id)
{
OperatingSystem operatingSystem = OperatingSystem.valueOf((short) (id >> 16));
Browser browser = Browser.valueOf( (short) (id & 0x0FFFF));
return new UserAgent(operatingSystem,browser);
}
/**
* Returns UserAgent based on combined string representation
* @param name
* @return
*/
public static UserAgent 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 UserAgent(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 UserAgent other = (UserAgent) 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;
}
}