appilog.common.utils

Class ScopeDefinition

java.lang.Object

appilog.common.utils.ScopeDefinition

All Implemented Interfaces:

java.lang.Comparable

public class ScopeDefinition
extends java.lang.Object
implements java.lang.Comparable

Created by IntelliJ IDEA. User: nmardiks Date: 23/04/2006 Time: 23:51:58 This class represents a network scope definition A scope definition includes the following lists: 1. included ranges list 2. excluded ranges list

An IP is considered to be in scope if and only if it is contained within one of the included ranges list AND is not contained within ANY of the excluded ranges list

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXCLUDE_PREFIX
static java.lang.String	RANGE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ScopeDefinition()
ScopeDefinition(Range[] includedRanges, Range[] excludedRanges)
ScopeDefinition(ScopeDefinition[] rangedScopes)
ScopeDefinition(java.lang.String scopeDefStr)
ScopeDefinition(java.lang.String[] rangesStrs)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIncludedRange(java.lang.String[] rangesStr)
int	compareTo(java.lang.Object o)
Range[]	createRangeArray(int size)
boolean	equals(java.lang.Object o)
void	fillStringVector(StringVector sv)
Range[]	getExcludedRanges()
IPv4	getFirstOverlapIP(Range range) Returns the strat (first IP) of the overlap with the given range
Range[]	getIncludedRanges()
Range	getIncludeRange(IPv4 ip)
java.util.List<Range>	getNonOverlapRanges(ScopeDefinition otherScope) Get the differences in ranges
java.util.List<Range>	getOverlapRanges(ScopeDefinition otherScope) Get a list of IP ranges, that the current Scope and the otherScope overlap.
int	hashCode()
boolean	isEntirelyInScope(Range range)
boolean	isEntirelyInScope(ScopeDefinition scope)
boolean	isInIncludedScope(ScopeDefinition range)
boolean	isInScope(IPv4 ip)
boolean	isInScope(Range range) Checks if the specified range is inside this network scope definition
boolean	isInScope(ScopeDefinition scope) check if the given range is in scope
boolean	isRangeOverlapWithExcludedRange(ScopeDefinition range)
void	setExcludedRanges(Range[] array)
Range[]	splitToIncludeRanges()
ScopeDefinition	subtractScope(ScopeDefinition scope)
java.lang.String	toDisplayString(java.lang.String sepStr)
ScopeDefinition[]	toRangedScopes() todo...
java.lang.String	toString()
StringVector	toStringVector()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXCLUDE_PREFIX

public static final java.lang.String EXCLUDE_PREFIX

See Also:

Constant Field Values

RANGE_SEPARATOR

public static final java.lang.String RANGE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

ScopeDefinition

public ScopeDefinition(Range[] includedRanges,
               Range[] excludedRanges)

ScopeDefinition

public ScopeDefinition(ScopeDefinition[] rangedScopes)

ScopeDefinition

public ScopeDefinition()

ScopeDefinition

public ScopeDefinition(java.lang.String scopeDefStr)

ScopeDefinition

public ScopeDefinition(java.lang.String[] rangesStrs)

Method Detail

setExcludedRanges

public void setExcludedRanges(Range[] array)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isInScope

public boolean isInScope(Range range)

Checks if the specified range is inside this network scope definition

Parameters:

range - range to check

Returns:

true if the range is (at least partly) in the includedRanges and not entirely in the excluded range.

getIncludeRange

public Range getIncludeRange(IPv4 ip)

isEntirelyInScope

public boolean isEntirelyInScope(Range range)

getFirstOverlapIP

public IPv4 getFirstOverlapIP(Range range)

Returns the strat (first IP) of the overlap with the given range

Parameters:

range - range to check

Returns:

first IP or null if no such Ip

isInScope

public boolean isInScope(IPv4 ip)

fillStringVector

public void fillStringVector(StringVector sv)

toStringVector

public StringVector toStringVector()

toDisplayString

public java.lang.String toDisplayString(java.lang.String sepStr)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIncludedRanges

public Range[] getIncludedRanges()

getExcludedRanges

public Range[] getExcludedRanges()

toRangedScopes

public ScopeDefinition[] toRangedScopes()

todo... NOTICE!!! the dengerous assumtion taken here is that we are not allowing ovrlapping ranges

this entire erea needs to be refactored!!!!!

Returns:

getOverlapRanges

public java.util.List<Range> getOverlapRanges(ScopeDefinition otherScope)

Get a list of IP ranges, that the current Scope and the otherScope overlap.

Parameters:

otherScope -

Returns:

list of ranges that are oevrlapped

getNonOverlapRanges

public java.util.List<Range> getNonOverlapRanges(ScopeDefinition otherScope)

Get the differences in ranges

Parameters:

otherScope -

Returns:

list of ranges, which are the complementary of the intersection of the current scope and otherScope

subtractScope

public ScopeDefinition subtractScope(ScopeDefinition scope)

splitToIncludeRanges

public Range[] splitToIncludeRanges()

createRangeArray

public Range[] createRangeArray(int size)

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

addIncludedRange

public void addIncludedRange(java.lang.String[] rangesStr)

isInScope

public boolean isInScope(ScopeDefinition scope)

check if the given range is in scope

Parameters:

scope -

Returns:

isEntirelyInScope

public boolean isEntirelyInScope(ScopeDefinition scope)

isInIncludedScope

public boolean isInIncludedScope(ScopeDefinition range)

isRangeOverlapWithExcludedRange

public boolean isRangeOverlapWithExcludedRange(ScopeDefinition range)