ds.funnel.traffic.factory

Class TrafficGeneratorBuilder

java.lang.Object

ds.funnel.traffic.factory.TrafficGeneratorBuilder

public class TrafficGeneratorBuilder
extends java.lang.Object

This class configures and returns TrafficGenerator objects, based upon parameters given to it. A TrafficGeneratorBuilder stores each component for a traffic generator; the configureTrafficFromFile() and the configureComponent() methods configure multiple or one, respectively, of these components. After the components have been configured as desired, the createTrafficGenerator() method should be called to create and retrieve a traffic generator which uses the current components. Any components which have not yet been configured in the builder will be null.

Author:

Kira Lindburg

Constructor Summary

Constructors

Constructor and Description
TrafficGeneratorBuilder()

Method Summary

Modifier and Type	Method and Description
void	configureComponent(ComponentSpecification specification) Configures the builder to use a component following the provided specification when the createTrafficGenerator() method is called.
void	configureComponentsFromFile(java.lang.String configurationFile) If the configurationFile contains a valid specification for a traffic generator as defined in the ConfigurationParser class, configures the builder to create the desired component types with the specified parameters.
void	configureComponentsFromString(java.lang.String configurationString) If the configurationString contains a valid specification for a traffic generator as defined in the ConfigurationParser class, configures the builder to create the desired component types with the specified parameters.
TrafficGenerator	createTrafficGenerator()
TrafficGenerator	createTrafficGenerator(EventDispatcher dispatcher)
TrafficGenerator	createTrafficGenerator(EventDispatcher dispatcher, java.lang.String streamIdentifier)
ComponentSpecification	getComponentSpecification(ComponentType type) Obtains the curretnly configured component specification for the given type
java.lang.String	getConfigurationString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TrafficGeneratorBuilder

public TrafficGeneratorBuilder()

Method Detail

configureComponentsFromFile

public void configureComponentsFromFile(java.lang.String configurationFile)
                                 throws java.io.FileNotFoundException

If the configurationFile contains a valid specification for a traffic generator as defined in the ConfigurationParser class, configures the builder to create the desired component types with the specified parameters. All previous configurations of the builder will be overwritten. If the file contains any invalid flags, the method will halt at the first error and an exception will be thrown; the builder may be left partially configured. Note that no other checking on the specifications will be performed until the createTrafficGenerator() method is called.

Parameters:

configurationFile - the name of a text file containing specification for how to configure components for a traffic generator

Throws:

java.io.FileNotFoundException - if the given file cannot be opened

java.lang.IllegalArgumentException - if the file contains invalid flags

configureComponentsFromString

public void configureComponentsFromString(java.lang.String configurationString)

If the configurationString contains a valid specification for a traffic generator as defined in the ConfigurationParser class, configures the builder to create the desired component types with the specified parameters. All previous configurations of the builder will be overwritten. If the string contains any invalid flags, the method will halt at the first error and an exception will be thrown; the builder may be left partially configured. Note that no other checking on the specifications will be performed until the createTrafficGenerator() method is called.

Parameters:

configurationString - a string containing specifications for how to configure a traffic generator

Throws:

java.lang.IllegalArgumentException - if the string contains invalid flags

configureComponent

public void configureComponent(ComponentSpecification specification)

Configures the builder to use a component following the provided specification when the createTrafficGenerator() method is called. No real checking on the values contained will be performed until the time that createTrafficGenerator() is called. If a component of the same main type (PacketGenerator, PacketSizeDistribution, etc) had previously been configured, the provided specification will completely replace that specification.

Parameters:

specification - a ComponentSpecification indicating how to configure the component

getComponentSpecification

public ComponentSpecification getComponentSpecification(ComponentType type)

Obtains the curretnly configured component specification for the given type

Parameters:

type - The type of component previously configured to return.

Returns:

The component specification for the given type, or null if it has not configured

createTrafficGenerator

public TrafficGenerator createTrafficGenerator()

Returns:

a new TrafficGenerator instance, with components corresponding to however the builder is currently configured; the traffic generator returned will have a null dispatcher and stream identifier

Throws:

java.lang.IllegalArgumentException - if the ComponentType contained in the ComponentSpecification is an unrecognized type (one which TrafficGeneratorBuilder is not equipped to handle), or if any of the parameters contained within the specification are not the correct type of parameters for the type of component specified

createTrafficGenerator

public TrafficGenerator createTrafficGenerator(EventDispatcher dispatcher)

Parameters:

dispatcher - the event dispatcher the newly created traffic generator will use to send packets

Returns:

a new TrafficGenerator instance, with components corresponding to however the builder is currently configured, and dispatcher set to the provided event dispatcher; the stream identifier will be null

Throws:

java.lang.IllegalArgumentException - if the ComponentType contained in the ComponentSpecification is an unrecognized type (one which TrafficGeneratorBuilder is not equipped to handle), or if any of the parameters contained within the specification are not the correct type of parameters for the type of component specified

createTrafficGenerator

public TrafficGenerator createTrafficGenerator(EventDispatcher dispatcher,
                                               java.lang.String streamIdentifier)

Parameters:

dispatcher - the event dispatcher the newly created traffic generator will use to send packets

streamIdentifier - a string which can be used to identify to which stream data dispatched from the newly created traffic generator belongs

Returns:

a new TrafficGenerator instance, with components corresponding to however the builder is currently configured, dispatcher set to the provided event dispatcher, and streamIdentifier set to the provided string

Throws:

java.lang.IllegalArgumentException - if the ComponentType contained in the ComponentSpecification is an unrecognized type (one which TrafficGeneratorBuilder is not equipped to handle), or if any of the parameters contained within the specification are not the correct type of parameters for the type of component specified

getConfigurationString

public java.lang.String getConfigurationString()

Returns:

a String containing all currently configured component specifications, in a format which could be parsed by the ConfigurationParser