at.jku.fim.rubanetra.config.model

Interface KrakenProtocolConfigurationBuilder

All Known Implementing Classes:

KrakenProtocolConfigurationBuilderImpl

public interface KrakenProtocolConfigurationBuilder

Generic specification of a Kraken application protocol configuration builder.

Method Summary

Modifier and Type	Method and Description
KrakenProtocolConfigurationBuilder	bindProtocol(String bindFrom, String bindTo) Bind a protocol handler to another protocol handler, i.e.
KrakenProtocolConfiguration	buildProtocolConfiguration() Builds the protocol configuration that has been set up until now
void	resetCurrentProtocolConfiguration() Resets all settings of the current protocol configuration
KrakenProtocolConfigurationBuilder	setCurrentProtocolIdentifier(String currentProtocolIdentifier) Set the protocol identifier to use for this protocol configuration.
KrakenProtocolConfigurationBuilder	setPcapHandler(PcapHandler<PcapActivityListener> pcapHandler) Set the pcap packet input stream for this application layer protocol parser
KrakenProtocolConfigurationBuilder	setPortSpecification(PortSpecification transportProtocolPortSpec) Set a transport layer filter for the parser of this protocol
KrakenProtocolConfigurationBuilder	setTransportProtocolMappingFactory(KrakenTransportLayerMappingFactory mappingFactory) Set the transport layer mapping factory to use for building transport layer mapping strategies
KrakenProtocolConfigurationBuilder	setTransportProtocolMappingStrategy(String strategy) Set the transport layer mapping strategy to use for this protocol

Method Detail

buildProtocolConfiguration

KrakenProtocolConfiguration buildProtocolConfiguration()

Builds the protocol configuration that has been set up until now

Returns:

the immutable protocol configuration that has been set up until now

setPortSpecification

KrakenProtocolConfigurationBuilder setPortSpecification(PortSpecification transportProtocolPortSpec)

Set a transport layer filter for the parser of this protocol

Parameters:

transportProtocolPortSpec - the port specification for this application layer protocol parser

Returns:

the builder instance

See Also:

KrakenProtocolConfiguration

setTransportProtocolMappingStrategy

KrakenProtocolConfigurationBuilder setTransportProtocolMappingStrategy(String strategy)

Set the transport layer mapping strategy to use for this protocol

Parameters:

strategy - the TransportLayerMappingStrategy to use

Returns:

the builder instance

See Also:

KrakenTransportLayerMappingFactory

setTransportProtocolMappingFactory

KrakenProtocolConfigurationBuilder setTransportProtocolMappingFactory(KrakenTransportLayerMappingFactory mappingFactory)

Set the transport layer mapping factory to use for building transport layer mapping strategies

Parameters:

mappingFactory - the transport layer mapping factory to use

Returns:

the builder instance

setPcapHandler

KrakenProtocolConfigurationBuilder setPcapHandler(PcapHandler<PcapActivityListener> pcapHandler)

Set the pcap packet input stream for this application layer protocol parser

Parameters:

pcapHandler - the Pcap packet input stream

Returns:

the builder instance

resetCurrentProtocolConfiguration

void resetCurrentProtocolConfiguration()

Resets all settings of the current protocol configuration

bindProtocol

KrakenProtocolConfigurationBuilder bindProtocol(String bindFrom,
                                                String bindTo)

Bind a protocol handler to another protocol handler, i.e. define the stream of decoded data (in general one way only, unless bound vice-versa as well)

Parameters:

bindFrom - the wild protocol identifier which can be mapped by the protocol registry to an existing protocol handler, and that will be bound to the handler of the bindTo protocol

bindTo - the wild protocol identifier which can be mapped by the protocol registry to an existing protocol handler, and that will receive decoded data from the bindFrom handler

Returns:

the builder instance

setCurrentProtocolIdentifier

KrakenProtocolConfigurationBuilder setCurrentProtocolIdentifier(String currentProtocolIdentifier)

Set the protocol identifier to use for this protocol configuration.

Parameters:

currentProtocolIdentifier - a protocol identifier (should be unique within this framework)

Returns:

the builder instance