org.apache.samza.system

Interface SystemFactory

public interface SystemFactory

Build the SystemConsumer and SystemProducer for a particular system, as well as the accompanying SystemAdmin.

Method Summary

Modifier and Type	Method and Description
SystemAdmin	getAdmin(java.lang.String systemName, Config config) Deprecated.
default SystemAdmin	getAdmin(java.lang.String systemName, Config config, java.lang.String adminLabel) This function provides an extra input parameter to getAdmin(java.lang.String, org.apache.samza.config.Config), which can be used to provide extra information for the admin instance, e.g.
SystemConsumer	getConsumer(java.lang.String systemName, Config config, MetricsRegistry registry) Deprecated.
default SystemConsumer	getConsumer(java.lang.String systemName, Config config, MetricsRegistry registry, java.lang.String consumerLabel) This function provides an extra input parameter to getConsumer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry), which can be used to provide extra information for the consumer instance, e.g.
SystemProducer	getProducer(java.lang.String systemName, Config config, MetricsRegistry registry) Deprecated.
default SystemProducer	getProducer(java.lang.String systemName, Config config, MetricsRegistry registry, java.lang.String producerLabel) This function provides an extra input parameter to getProducer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry), which can be used to provide extra information for the producer instance, e.g.

Method Detail

getConsumer

@Deprecated
SystemConsumer getConsumer(java.lang.String systemName,
                                       Config config,
                                       MetricsRegistry registry)

Deprecated.

getProducer

@Deprecated
SystemProducer getProducer(java.lang.String systemName,
                                       Config config,
                                       MetricsRegistry registry)

Deprecated.

getAdmin

@Deprecated
SystemAdmin getAdmin(java.lang.String systemName,
                                 Config config)

Deprecated.

getConsumer

default SystemConsumer getConsumer(java.lang.String systemName,
                                   Config config,
                                   MetricsRegistry registry,
                                   java.lang.String consumerLabel)

This function provides an extra input parameter to getConsumer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry), which can be used to provide extra information for the consumer instance, e.g. ownership of client instance, to help better identify consumers in logs, threads and client instances etc., along with other relevant information like systemName.

Parameters:

systemName - The name of the system to create consumer for.

config - The config to create consumer with.

registry - MetricsRegistry to which to publish consumer specific metrics.

consumerLabel - a string to provide info the consumer instance.

Returns:

A SystemConsumer

getProducer

default SystemProducer getProducer(java.lang.String systemName,
                                   Config config,
                                   MetricsRegistry registry,
                                   java.lang.String producerLabel)

This function provides an extra input parameter to getProducer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry), which can be used to provide extra information for the producer instance, e.g. ownership of client instance, to help better identify producers in logs, threads and client instances etc., along with other relevant information like systemName.

Parameters:

systemName - The name of the system to create producer for.

config - The config to create producer with.

registry - MetricsRegistry to which to publish producer specific metrics.

producerLabel - a string to provide info the producer instance.

Returns:

A SystemProducer

getAdmin

default SystemAdmin getAdmin(java.lang.String systemName,
                             Config config,
                             java.lang.String adminLabel)

This function provides an extra input parameter to getAdmin(java.lang.String, org.apache.samza.config.Config), which can be used to provide extra information for the admin instance, e.g. ownership of client instance, to help better identify admins in logs, threads and client instances etc., along with other relevant information like systemName.

Parameters:

systemName - The name of the system to create admin for.

config - The config to create admin with.

adminLabel - a string to provide info for the admin instance.

Returns:

A SystemAdmin