Package com.nettoolkit.gatekeeper

Class VisitorGroup

java.lang.Object

com.nettoolkit.gatekeeper.VisitorGroup

All Implemented Interfaces:

Serializable

public class VisitorGroup
extends Object
implements Serializable

VisitorGroup is a model for classifying incoming visits based on information about the visitor. Information used by visitor groups include IP address, user agent, user ID, and so on.

See Also:

• Gatekeeper visitor group docs
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VisitorGroup.Visitor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VisitorGroup(JSONObject jsonVisitorGroup)

Method Summary

Modifier and Type	Method	Description
UUID	getId()	Get visitor group ID.
String	getName()	Get visitor group name.
String	getOperator()	Get operator for USER_ID type visitor groups.
String	getType()	Get visitor group type.

Methods inherited from class java.lang.Object

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

Constructor Details

VisitorGroup

protected VisitorGroup(JSONObject jsonVisitorGroup)
                throws ParsingException

Throws:

ParsingException

Method Details

getId

public UUID getId()

Get visitor group ID.

Returns:

visitor group ID

getName

public String getName()

Get visitor group name.

Returns:

visitor group name

getType

public String getType()

Get visitor group type. The visitor type represents the kind of visitors contained by this group. Options include "IP", "ORGANIZATION", "TAG", "COUNTRY", and "USER_ID". For a complete list, see visitor types documentation.

Returns:

visitor type

getOperator

public String getOperator()

Get operator for USER_ID type visitor groups. Visitor groups of type USER_ID include an operator to determine how to match visitors. Options include "LESS", "GREATER", "BETWEEN", and "IN".