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<org.opensaml.messaging.context.BaseContext>

public class UserAgentContext
extends org.opensaml.messaging.context.BaseContext

A context, usually attached to AuthenticationContext, containing data about the user agent.

Nested Class Summary

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

org.opensaml.messaging.context.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).

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.
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).

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

getIdentifier

@Nullable
public String getIdentifier()

Get the user agent identifier.

Returns:

identifier for the user agent

setAddress

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

setIdentifier

public UserAgentContext setIdentifier(@Nullable
                             String id)

Set the user agent identifier.

Parameters:

id - identifier for the user agent

Returns:

this context