CustomsFeatures (secops-beam 0.19.2 API)

java.lang.Object
- com.mozilla.secops.customs.CustomsFeatures

All Implemented Interfaces:

Serializable
```
public class CustomsFeatures
extends Object
implements Serializable
```
CustomsFeatures describes the output of windowed feature extraction

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int NOMINAL_VARIANCE_INDEX
Considered norminal variance index on point-in-time feature calculation

Fields
Modifier and Type	Field and Description
`static int`	`NOMINAL_VARIANCE_INDEX` Considered norminal variance index on point-in-time feature calculation

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvent(Event e)` Add a single event to the event list
`boolean`	`equals(Object o)`
`ArrayList<Event>`	`getEvents()` Get event list
`ArrayList<Event>`	`getEventsOfType(FxaAuth.EventSummary t)` Get all events from event list of a certain type
`HashMap<String,Integer>`	`getSourceAddressEventCount()` Get count of total events per source address
`HashMap<FxaAuth.EventSummary,Integer>`	`getSummarizedEventCounters()` Get summarized event counters
`int`	`getTotalAccountCreateSuccess()` Get total account create success count for event set
`int`	`getTotalAccountStatusCheckCount()` Get total account status check for event set
`int`	`getTotalEvents()` Get total event count
`int`	`getTotalLoginFailureCount()` Get total login failure count for event set
`int`	`getTotalLoginSuccessCount()` Get total login success count for event set
`int`	`getTotalPasswordForgotSendCodeFailure()` Get total password forgot send code failure count for event set
`int`	`getTotalPasswordForgotSendCodeSuccess()` Get total password forgot send code success count for event set
`HashMap<String,Integer>`	`getUniquePathRequestCount()` Get unique path request count
`HashMap<String,Integer>`	`getUniquePathSuccessfulRequestCount()` Get unique path request count for successful requests
`int`	`getUnknownEventCounter()` Get unknown event counter
`int`	`getVarianceIndex()` Get variance index
`int`	`hashCode()`
`void`	`merge(CustomsFeatures cf)` Merge this feature set with another one
`boolean`	`nominalVariance()` Return true if calculated variance index meets or exceeds nominal index value
`void`	`recalculate()` Force recalculation of point-in-time statistics
`void`	`setEvents(ArrayList<Event> events)` Set event list

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NOMINAL_VARIANCE_INDEX
```
public static final int NOMINAL_VARIANCE_INDEX
```
    Considered norminal variance index on point-in-time feature calculation
    
    See Also:
    
    Constant Field Values
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - nominalVariance
```
public boolean nominalVariance()
```
    Return true if calculated variance index meets or exceeds nominal index value
    
    Returns:
    
    boolean
  - recalculate
```
public void recalculate()
```
    Force recalculation of point-in-time statistics
  - merge
```
public void merge(CustomsFeatures cf)
```
    Merge this feature set with another one
    
    Parameters:
    
    cf - CustomsFeatures to merge into this object
  - getTotalEvents
```
public int getTotalEvents()
```
    Get total event count
    Return the total of all events in the collection, including those that could not be summarized or were not explicitly registered for raw event storage.
    
    Returns:
    
    int
  - getVarianceIndex
```
public int getVarianceIndex()
```
    Get variance index
    
    Returns:
    
    int
  - getUnknownEventCounter
```
public int getUnknownEventCounter()
```
    Get unknown event counter
    
    Returns:
    
    int
  - getSummarizedEventCounters
```
public HashMap<FxaAuth.EventSummary,Integer> getSummarizedEventCounters()
```
    Get summarized event counters
    
    Returns:
    
    HashMap
  - getUniquePathRequestCount
```
public HashMap<String,Integer> getUniquePathRequestCount()
```
    Get unique path request count
    
    Returns:
    
    HashMap
  - getUniquePathSuccessfulRequestCount
```
public HashMap<String,Integer> getUniquePathSuccessfulRequestCount()
```
    Get unique path request count for successful requests
    
    Returns:
    
    HashMap
  - getSourceAddressEventCount
```
public HashMap<String,Integer> getSourceAddressEventCount()
```
    Get count of total events per source address
    
    Returns:
    
    HashMap
  - getTotalPasswordForgotSendCodeFailure
```
public int getTotalPasswordForgotSendCodeFailure()
```
    Get total password forgot send code failure count for event set
    
    Returns:
    
    int
  - getTotalPasswordForgotSendCodeSuccess
```
public int getTotalPasswordForgotSendCodeSuccess()
```
    Get total password forgot send code success count for event set
    
    Returns:
    
    int
  - getTotalLoginFailureCount
```
public int getTotalLoginFailureCount()
```
    Get total login failure count for event set
    
    Returns:
    
    int
  - getTotalLoginSuccessCount
```
public int getTotalLoginSuccessCount()
```
    Get total login success count for event set
    
    Returns:
    
    int
  - getTotalAccountCreateSuccess
```
public int getTotalAccountCreateSuccess()
```
    Get total account create success count for event set
    
    Returns:
    
    int
  - getTotalAccountStatusCheckCount
```
public int getTotalAccountStatusCheckCount()
```
    Get total account status check for event set
    
    Returns:
    
    int
  - addEvent
```
public void addEvent(Event e)
```
    Add a single event to the event list
    
    Parameters:
    
    e - Event
  - getEvents
```
public ArrayList<Event> getEvents()
```
    Get event list
    
    Returns:
    
    ArrayList
  - setEvents
```
public void setEvents(ArrayList<Event> events)
```
    Set event list
    
    Parameters:
    
    events - ArrayList
  - getEventsOfType
```
public ArrayList<Event> getEventsOfType(FxaAuth.EventSummary t)
```
    Get all events from event list of a certain type
    
    Parameters:
    
    t - FxaAuth.EventSummary
    
    Returns:
    
    ArrayList

Class CustomsFeatures

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOMINAL_VARIANCE_INDEX

Method Detail

equals

hashCode

nominalVariance

recalculate

merge

getTotalEvents

getVarianceIndex

getUnknownEventCounter

getSummarizedEventCounters

getUniquePathRequestCount

getUniquePathSuccessfulRequestCount

getSourceAddressEventCount

getTotalPasswordForgotSendCodeFailure

getTotalPasswordForgotSendCodeSuccess

getTotalLoginFailureCount

getTotalLoginSuccessCount

getTotalAccountCreateSuccess

getTotalAccountStatusCheckCount

addEvent

getEvents

setEvents

getEventsOfType