https://github.com/sheinbergon/useragent-analyzer
User-Agent analysis for the JVM
https://github.com/sheinbergon/useragent-analyzer
asynchronous caffeine j2v8 java-8 ua-parser-js user-agent-analysis useragent
Last synced: 3 months ago
JSON representation
User-Agent analysis for the JVM
- Host: GitHub
- URL: https://github.com/sheinbergon/useragent-analyzer
- Owner: sheinbergon
- License: mit
- Created: 2017-10-04T08:43:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-21T03:49:24.000Z (over 8 years ago)
- Last Synced: 2025-07-29T06:43:27.879Z (11 months ago)
- Topics: asynchronous, caffeine, j2v8, java-8, ua-parser-js, user-agent-analysis, useragent
- Language: Java
- Homepage:
- Size: 162 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# useragent-analyzer
[](https://travis-ci.org/sheinbergon/useragent-analyzer) [](https://opensource.org/licenses/MIT) [](https://mvnrepository.com/artifact/org.sheinbergon) [](https://github.com/sheinbergon/useragent-analyzer/releases) [](https://coveralls.io/github/sheinbergon/useragent-analyzer)
A non-opinionated User-Agent analysis proxy written in Java 8.
## Introduction
The purpose of this project is to encapsulate several popular useragent analysis frameworks for the JVM (and other languages) under a single facade/interface, allowing developers to easily move between frameworks/implementations in any case some becomes obsolete/updated or simply doesn't quite fit the accuracy needs of the task at hand
## Key concepts
- Provides both synchronous & fully asynchronous APIs.
- Pluggable architecture for both caching & processing(parsing) modules.
## Getting Started
### Dependencies
Simply add the 'useragent-analyzer-dist' dependency.
Note that this distribution jar relies on the user providing the j2v8 jar for the targeted architecture.
The following examples targets 64 bit linux execution environments, but other operating systems are
supported as well. See [Maven Central](https://mvnrepository.com/artifact/com.eclipsesource.j2v8) for additional information.
#### Maven
```xml
...
org.sheinbergon
useragent-analyzer-dist
0.0.1
com.eclipsesource.j2v8
j2v8_linux_x86_64
4.8.0
...
```
#### Gradle
```groovy
compile group: 'com.eclipsesource.j2v8', name: 'j2v8_linux_x86_64', version: '4.8.0'
compile group: 'org.sheinbergon', name: 'useragent-analyzer-dist', version: '0.0.1'
```
### Simple setup
##### Setting-up a synchronous analyzer
```java
UserAgentAnalyzer analyzer = UserAgentAnalyzer.builder()
.processor(UaParserJsProcessor.builder().build())
.build();
UserAgentIngredients ingredients = analyzer.analyze("Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1")
ingredients.getOsName() // iOS
ingredients.getDeviceType() // MOBILE
```
##### Setting-up an asynchronous analyzer
```java
AsyncUserAgentAnalyzer analyzer = AsyncUserAgentAnalyzer.builder()
.processor(UaParserJsAsyncProcessor.builder().build())
.build();
analyzer.analyze("Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1")
.thenApply(UserAgentIngredients::getDeviceModel)
...
```
##### Lifecycle management/shutdown
```java
analyzer.teardown();
```
### Advanced setup
See Implementation Specs below
## Implemntation Specs
### Processors
#### ua-paresr-js
- Uses the popular javascript useragent parsing library [ua-parser.js](https://github.com/faisalman/ua-parser-js)
- Javascript code is executed using [J2V8](https://github.com/eclipsesource/J2V8)
- Requires an explicit J2V8 dependency defintion per operating system/architecture. See supported architectures [here](https://mvnrepository.com/artifact/com.eclipsesource.j2v8)
- As V8Engine instances are not thread-safe, an object-pool is used to acheive thread-safety with concurrency, supporting confiugrable pool size & allocation timeout
- Async version also supports executor pools size for V8 Engine allocation and ingestion
```java
// Sync
UserAgentAnalyzer.builder()
.processor(UaParserJsProcessor.builder()
.v8AllocationTimeout(1000L)
.v8PoolSize(5)
.build())
...
// Async
AsyncUserAgentAnalyzer.builder()
.processor(UaParserJsAsyncProcessor.builder()
.ingestionConcurrency(4)
.v8AllocationConcurrency(16)
.v8AllocationTimeout(1000L)
.v8PoolSize(5)
.build())
...
```
### Caches
#### psuedo
- Default cache implementation, never caches anything (always misses)
#### caffeine
- Caching module implemented on top of [caffeine](https://github.com/ben-manes/caffeine)
- Supports max entries configuration
```java
// Sync
UserAgentAnalyzer.builder()
.cache(CaffeineCache.builder()
.maxEntries(100000)
.build())
...
// Async
AsyncUserAgentAnalyzer.builder()
.cache(CaffeineAsyncCache.builder()
.maxEntries(100000)
.build())
...
```
## Future plans:
- Add concurrency tests
- Add more cache implementations - [guava](https://github.com/google/guava/wiki/CachesExplained)
- Add more processor implementations - [woothee](https://github.com/woothee/woothee), [yauaa](https://github.com/nielsbasjes/yauaa)