com.pcube.apps.engage.common
Class GlobalController

java.lang.Object
  com.pcube.apps.engage.common.ArrayElement
      com.pcube.apps.engage.common.GlobalController

All Implemented Interfaces:

Formattable, com.pcube.apps.framework.commons.NamedObject, java.io.Serializable, java.lang.Cloneable

public class GlobalController
extends ArrayElement
implements java.io.Serializable, java.lang.Cloneable, Formattable, com.pcube.apps.framework.commons.NamedObject

Global Controllers let the user limit the total upstream/downstream BW consumed by transactions belonging to certain services/packages. This is done by creating a Global Controller, defining its BW limit, and then linking it to a subscriber’s BW controller. Any transaction that is mapped by some rule to this subscriber’s BW controller will also be mapped to this Global Controller. When necessary, the Global Controller reduces the BW of transaction flowing through it so that its BW limit is not exceeded. The Global Controllers are directional i.e. they apply to upstream transactions or downstream transaction but not to both.

Author:

uzir

See Also:

Serialized Form

Field Summary

static int	DEFAULT_GC_TYPE
static long	MAXIMUM_BW
static long	MAXIMUM_BW_8K
static long	MINIMUM_BW
static int	TEMPLATE_VIRTUAL_LINK_GC_TYPE
static long	UNLIMITED_BW
static long	UNLIMITED_BW_PERCENTAGE
static java.lang.String	UNLIMITED_BW_STR
static int	VIRTUAL_LINK_GC_INSIDE_TEMPLATE_TYPE

Constructor Summary

GlobalController(java.lang.String name, java.lang.String description)
Constructor.

GlobalController(java.lang.String name, java.lang.String description, int gcType)

Method Summary

java.lang.Object	clone() Producing an identical object to this object.
void	fromStream(java.io.BufferedReader in, Formatter f) Method fromStream
static long	getActualBwOfGlobalController(long seTotalLinkBwKbps, float totalLinkBwPercentage, float gcBwPercentage)
long	getBw()
float	getBwPercentage() Deprecated.
float	getBWPercentage() Deprecated.
java.lang.String	getDescription() Get the Global Controller's description
float	getMaxBWPercentAcrossTimeFrames()
float	getMinBWPercentAcrossTimeFrames()
java.lang.String	getName() Get the Global Controller's name
TimeBasedValue	getTimeBasedBW()
TimeBasedValue	getTimeBasedBWPercentage() Deprecated.
int	getType()
float	getValue(int timeFrame) Deprecated.
boolean	isAggregatedGc()
boolean	isGcEqual(GlobalController other)
boolean	isGcUniformAcrossTimeframes()
void	setAggregatedGc(boolean isAggregatedGc)
void	setBW(long bw) MAXIMUM_BW associate with SCE8000 10Gig, therefore MAX valid value per link is 10Gig and 10Gig * 2 for aggregate GCs
void	setBWPercentage(float percentage) Deprecated.
void	setDescription(java.lang.String description) Set the Global Controller's description
void	setName(java.lang.String name)
void	setTimeBasedBw(TimeBasedValue timebaseBw)
void	setTimeBasedBWPercentage(TimeBasedValue percentage) Deprecated.
void	setType(int type)
void	setValueFrom(GlobalController other) Sets the value of this Global Controller to resemble another Global Controller.
void	toStream(java.io.PrintStream out, Formatter f) Method toStream
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNLIMITED_BW

public static final long UNLIMITED_BW

See Also:

Constant Field Values

UNLIMITED_BW_STR

public static final java.lang.String UNLIMITED_BW_STR

See Also:

Constant Field Values

UNLIMITED_BW_PERCENTAGE

public static final long UNLIMITED_BW_PERCENTAGE

See Also:

Constant Field Values

MAXIMUM_BW_8K

public static final long MAXIMUM_BW_8K

See Also:

Constant Field Values

MAXIMUM_BW

public static final long MAXIMUM_BW

See Also:

Constant Field Values

MINIMUM_BW

public static final long MINIMUM_BW

See Also:

Constant Field Values

DEFAULT_GC_TYPE

public static final int DEFAULT_GC_TYPE

See Also:

Constant Field Values

TEMPLATE_VIRTUAL_LINK_GC_TYPE

public static final int TEMPLATE_VIRTUAL_LINK_GC_TYPE

See Also:

Constant Field Values

VIRTUAL_LINK_GC_INSIDE_TEMPLATE_TYPE

public static final int VIRTUAL_LINK_GC_INSIDE_TEMPLATE_TYPE

See Also:

Constant Field Values

Constructor Detail

GlobalController

public GlobalController(java.lang.String name,
                        java.lang.String description)

Constructor.

Parameters:

name - the Global Controller's name

description - the Global Controller's description

GlobalController

public GlobalController(java.lang.String name,
                        java.lang.String description,
                        int gcType)

Method Detail

getActualBwOfGlobalController

public static long getActualBwOfGlobalController(long seTotalLinkBwKbps,
                                                 float totalLinkBwPercentage,
                                                 float gcBwPercentage)

Parameters:

seTotalLinkBwKbps -

totalLinkBwPercentage -

gcBwPercentage -

Returns:

clone

public java.lang.Object clone()

Producing an identical object to this object.

Specified by:

clone in class ArrayElement

Returns:

a newly allocated object similar to this object.

See Also:

Object.clone()

fromStream

public void fromStream(java.io.BufferedReader in,
                       Formatter f)
                throws ImportExportException

Description copied from interface: Formattable

Method fromStream

Specified by:

fromStream in interface Formattable

Throws:

ImportExportException

See Also:

Formattable.fromStream(java.io.BufferedReader, com.pcube.apps.engage.common.Formatter)

getBWPercentage

public float getBWPercentage()

Deprecated.

Gets the percentage of this Global Controller from this Global Controller's directional total wire percentage.

Returns:

the percentage

getValue

public float getValue(int timeFrame)

Deprecated.

Parameters:

timeFrame -

Returns:

getTimeBasedBWPercentage

public TimeBasedValue getTimeBasedBWPercentage()

Deprecated.

Returns:

getTimeBasedBW

public TimeBasedValue getTimeBasedBW()

getDescription

public java.lang.String getDescription()

Get the Global Controller's description

Returns:

getName

public java.lang.String getName()

Get the Global Controller's name

Specified by:

getName in interface com.pcube.apps.framework.commons.NamedObject

Returns:

the Global Controller's name

setBWPercentage

public void setBWPercentage(float percentage)

Deprecated.

Set the Global Controller's bandwidth. The percentage of the Global Controller is configured and the actual value set is this percentage out of the percentage of total wire in thie Global Controller's direction from the SE device's maximum bandwidth

Parameters:

percentage -

setBW

public void setBW(long bw)

MAXIMUM_BW associate with SCE8000 10Gig, therefore MAX valid value per link is 10Gig and 10Gig * 2 for aggregate GCs

Parameters:

bw -

setDescription

public void setDescription(java.lang.String description)

Set the Global Controller's description

Parameters:

description -

setValueFrom

public void setValueFrom(GlobalController other)

Sets the value of this Global Controller to resemble another Global Controller.

Parameters:

other -

toStream

public void toStream(java.io.PrintStream out,
                     Formatter f)

Description copied from interface: Formattable

Method toStream

Specified by:

toStream in interface Formattable

See Also:

Formattable.toStream(java.io.PrintStream, com.pcube.apps.engage.common.Formatter)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

setName

public void setName(java.lang.String name)

Specified by:

setName in interface com.pcube.apps.framework.commons.NamedObject

getBwPercentage

public float getBwPercentage()

Deprecated.

Returns:

getBw

public long getBw()

setTimeBasedBWPercentage

public void setTimeBasedBWPercentage(TimeBasedValue percentage)

Deprecated.

Parameters:

percentage -

setTimeBasedBw

public void setTimeBasedBw(TimeBasedValue timebaseBw)

getMaxBWPercentAcrossTimeFrames

public float getMaxBWPercentAcrossTimeFrames()

getMinBWPercentAcrossTimeFrames

public float getMinBWPercentAcrossTimeFrames()

isGcUniformAcrossTimeframes

public boolean isGcUniformAcrossTimeframes()

isGcEqual

public boolean isGcEqual(GlobalController other)

setAggregatedGc

public void setAggregatedGc(boolean isAggregatedGc)

isAggregatedGc

public boolean isAggregatedGc()

getType

public int getType()

setType

public void setType(int type)