Package sonia.scm.web

Class UserAgent

java.lang.Object

sonia.scm.web.UserAgent

public final class UserAgent
extends Object

The software agent that is acting on behalf of a user. The user agent represents a browser or one of the repository client (svn, git or hg).

Since:

1.45

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserAgent.Builder	Builder class for UserAgent.

Method Summary

Modifier and Type	Method	Description
static UserAgent.Builder	browser(String name)
static UserAgent.Builder	builder(String name)	Deprecated. Use browser(String), scmClient(String) or other(String) instead
boolean	equals(Object obj)
Charset	getBasicAuthenticationCharset()	Returns the Charset, which is used to decode the basic authentication header.
String	getName()	Returns the name of UserAgent.
int	hashCode()
boolean	isBrowser()	Returns true if UserAgent is a browser.
boolean	isScmClient()	Returns true if UserAgent is an scm client (e.g.
static UserAgent.Builder	other(String name)
static UserAgent.Builder	scmClient(String name)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

@Deprecated
public static UserAgent.Builder builder(String name)

Deprecated.

Use browser(String), scmClient(String) or other(String) instead

Returns the UserAgent.Builder for the UserAgent.

Parameters:

name - name of the UserAgent

Returns:

builder for UserAgent

browser

public static UserAgent.Builder browser(String name)

scmClient

public static UserAgent.Builder scmClient(String name)

other

public static UserAgent.Builder other(String name)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getBasicAuthenticationCharset

public Charset getBasicAuthenticationCharset()

Returns the Charset, which is used to decode the basic authentication header.

Returns:

Charset for basic authentication

getName

public String getName()

Returns the name of UserAgent.

Returns:

name of UserAgent

isBrowser

public boolean isBrowser()

Returns true if UserAgent is a browser.

isScmClient

public boolean isScmClient()

Returns true if UserAgent is an scm client (e.g. git, svn or hg).

Returns:

true if UserAgent is an scm client