com.foxsmart.csu.config
Interface CompositeComponent

All Known Implementing Classes:

AsyncInterfaceComponent, AtmInterfaceComponent, BriInterfaceComponent, BviInterfaceComponent, CbrInterfaceComponent, ChannelInterfaceComponent, CiscoRouterConfig, ClassComponent, ClassMapComponent, DialerInterfaceComponent, EthernetInterfaceComponent, FastEthernetInterfaceComponent, FddiInterfaceComponent, FrAtmInterfaceComponent, GigabitEthernetInterfaceComponent, GroupAsyncInterfaceComponent, HssiInterfaceComponent, InterfaceComponent, LexInterfaceComponent, LineComponent, LoopbackInterfaceComponent, MapClassAtmComponent, MapClassDialerComponent, MapClassFrameRelayComponent, MultilinkInterfaceComponent, NullInterfaceComponent, PolicyMapComponent, PortChannelInterfaceComponent, PosInterfaceComponent, SerialInterfaceComponent, TenGigabitEthernetInterfaceComponent, TokenRingInterfaceComponent, TunnelInterfaceComponent, VgAnylanInterfaceComponent, VifInterfaceComponent, VirtualTemplateInterfaceComponent, VirtualTokenRingInterfaceComponent, VlanInterfaceComponent, XTagAtmInterfaceComponent

public interface CompositeComponent

This interface identifies a composite component (i.e. a component that has children).

Method Summary

java.lang.String	generateHeaderIos() Returns the header IOS configuration string for this component.
java.util.List	getChildComponentKeys() Returns the list of child keys of this composite component.
java.util.List	getChildComponentUpdateKeys() Returns the list of child keys of this composite component.
java.util.List	getPackages() Gets a list of the packages used to instantiate components (e.g.

Method Detail

generateHeaderIos

java.lang.String generateHeaderIos()
                                   throws InvalidConfigurationException

Returns the header IOS configuration string for this component. The header is the line of IOS that is used to distinguish the parent from its children.

Returns:

The header IOS configuration string.

Throws:

InvalidConfigurationException - if the IOS configuration is invalid and the header IOS string can not be generated. The validate() method is used to determine if the configuration is valid.

getPackages

java.util.List getPackages()

Gets a list of the packages used to instantiate components (e.g. "com.foxsmart.csu.config"). The packages will be used in the order they are listed.

Returns:

the packages.

getChildComponentKeys

java.util.List getChildComponentKeys()

Returns the list of child keys of this composite component. The keys are stored in the order that they should be processed for generating IOS statements. Class objects (e.g. Length.class) should be used for supported components while strings (e.g. "ip") should be used for unsupported components.

Returns:

The list of child component keys for generating IOS statements.

getChildComponentUpdateKeys

java.util.List getChildComponentUpdateKeys()

Returns the list of child keys of this composite component. The keys are stored in the order that they should be processed for updating IOS statements. Class objects (e.g. Length.class) should be used for supported components while strings (e.g. "ip") should be used for unsupported components. In most cases, this list will be the same as getChildComponentKeys with the exception being when the order of updates matters and is different from the order listed in a "show configuration" router command.

Returns:

The list of child component keys for updating IOS statements.