com.mozilla.secops

Class Violation

java.lang.Object

com.mozilla.secops.Violation

public class Violation
extends Object

Represents a violation as would be submitted to iprepd

See iprepd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Violation.ViolationType Valid violation types

Constructor Summary

Constructors

Constructor and Description
Violation(String object, String type, String violation) Create new Violation
Violation(String object, String type, String violation, Integer suppressRecovery) Create new Violation with recovery suppression value

Method Summary

Modifier and Type	Method and Description
static Violation[]	fromAlert(Alert a) Convert an Alert into violations
String	getObject() Get object
String	getSourceAddress() Get source address
Integer	getSuppressRecovery()
String	getType() Get object type
String	getViolation() Get violation type
String	toJSON() Convert Violation to JSON string

Methods inherited from class java.lang.Object

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

Constructor Detail

Violation

public Violation(String object,
                 String type,
                 String violation)

Create new Violation

Parameters:

object - Object identifier

type - Object type

violation - ViolationType as string

Violation

public Violation(String object,
                 String type,
                 String violation,
                 Integer suppressRecovery)

Create new Violation with recovery suppression value

Parameters:

object - Object name

type - Type

violation - ViolationType as string

suppressRecovery - Recovery suppression value in seconds

Method Detail

getObject

public String getObject()

Get object

Returns:

Object string

getType

public String getType()

Get object type

Returns:

Object type string

getSourceAddress

public String getSourceAddress()

Get source address

This is a legacy field that maintains compatibility with older versions of iprepd. If the type is of type "ip", this function will simply return the same value as the object in the violation.

For other types, null is returned.

Returns:

Source address string

getViolation

public String getViolation()

Get violation type

Returns:

Violation type string

getSuppressRecovery

public Integer getSuppressRecovery()

toJSON

public String toJSON()

Convert Violation to JSON string

Returns:

Violation JSON string or null on serialization failure

fromAlert

public static Violation[] fromAlert(Alert a)

Convert an Alert into violations

The alert must be of the correct type (e.g., generated by HTTPRequest) and have valid associated metadata in order for conversion to be successful.

An array of resulting violations is returned. In most cases the array will have a single element, but some alerts can result in multiple violations being generated.

Parameters:

a - Alert

Returns:

Array of violations or null if conversion is not possible