net.shibboleth.idp.authn.context

Class UserAgentContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.authn.context.UserAgentContext

All Implemented Interfaces:

Iterable<BaseContext>

public class UserAgentContext
extends BaseContext

A context containing data about the user agent.

Parent:

ProfileRequestContext, AuthenticationContext

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private InetAddress	address Address of the user-agent host.
private String	identifier An identification string (such as a User-Agent header).
private eu.bitwalker.useragentutils.UserAgent	userAgent Parsed User-Agent.

Constructor Summary

Constructors

Constructor and Description
UserAgentContext()

Method Summary

Methods

Modifier and Type	Method and Description
InetAddress	getAddress() Get the address of the user-agent host.
String	getIdentifier() Get the user agent identifier.
eu.bitwalker.useragentutils.UserAgent	getUserAgent() Gets the parsed user agent.
boolean	isInstance(eu.bitwalker.useragentutils.Browser browser) Determines whether this user agent is an instance of the given browser.
boolean	isInstance(eu.bitwalker.useragentutils.OperatingSystem os) Determines whether this user agent is an instance of the given operating system.
UserAgentContext	setAddress(InetAddress userAgentAddress) Set the address of the user-agent host.
UserAgentContext	setIdentifier(String id) Set the user agent identifier.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

address

@Nullable
private InetAddress address

Address of the user-agent host.

identifier

@Nullable
private String identifier

An identification string (such as a User-Agent header).

userAgent

@Nullable
private eu.bitwalker.useragentutils.UserAgent userAgent

Parsed User-Agent.

Constructor Detail

UserAgentContext

public UserAgentContext()

Method Detail

getAddress

@Nullable
public InetAddress getAddress()

Get the address of the user-agent host.

Returns:

address of the user-agent host

setAddress

@Nonnull
public UserAgentContext setAddress(@Nullable
                                  InetAddress userAgentAddress)

Set the address of the user-agent host.

Parameters:

userAgentAddress - address of the user-agent host

Returns:

this context

getIdentifier

@Nullable
public String getIdentifier()

Get the user agent identifier.

Returns:

identifier for the user agent

setIdentifier

@Nonnull
public UserAgentContext setIdentifier(@Nullable
                                     String id)

Set the user agent identifier. The parsed user agent is available via getUserAgent() upon calling this method.

Parameters:

id - identifier for the user agent

Returns:

this context

getUserAgent

@Nullable
public eu.bitwalker.useragentutils.UserAgent getUserAgent()

Gets the parsed user agent.

Returns:

Parsed user agent or null if setIdentifier(String) has not been called.

isInstance

public boolean isInstance(@Nonnull
                 eu.bitwalker.useragentutils.Browser browser)

Determines whether this user agent is an instance of the given browser.

Parameters:

browser - browser to check.

Returns:

True if this user agent is an instance of the given browser, false otherwise.

isInstance

public boolean isInstance(@Nonnull
                 eu.bitwalker.useragentutils.OperatingSystem os)

Determines whether this user agent is an instance of the given operating system.

Parameters:

os - operating system to check.

Returns:

True if this user agent is an instance of the given operating system, false otherwise.