Package org.torproject.descriptor

Class DescriptorSourceFactory

java.lang.Object

org.torproject.descriptor.DescriptorSourceFactory

public final class DescriptorSourceFactory
extends java.lang.Object

Factory for descriptor sources which in turn produce descriptors.

Descriptor sources are the only producers of classes implementing the Descriptor superinterface. There exist descriptor sources for obtaining remote descriptor data (DescriptorCollector) and descriptor sources for processing local descriptor data (DescriptorReader and DescriptorParser).

By default, this factory returns implementations from the library's own impl package. This may be overridden by setting Java properties, though most users will simply use the default implementations.

These properties can be used for setting the implementation:

• descriptor.collector
• descriptor.parser
• descriptor.reader

Assuming the classpath contains the special implementation referenced, your application classes as well as a descriptor API jar the following is an example for using a different implementation of the descriptor downloader:

java -Ddescriptor.downloader=my.special.descriptorimpl.Downloader \ my.app.Mainclass

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COLLECTOR_DEFAULT	Default implementation of the DescriptorCollector descriptor source.
static java.lang.String	COLLECTOR_PROPERTY	Property name for overriding the implementation of the DescriptorCollector descriptor source, which is by default set to the class in COLLECTOR_DEFAULT.
static java.lang.String	PARSER_DEFAULT	Default implementation of the DescriptorParser descriptor source.
static java.lang.String	PARSER_PROPERTY	Property name for overriding the implementation of the DescriptorParser descriptor source, which is by default set to the class in PARSER_DEFAULT.
static java.lang.String	READER_DEFAULT	Default implementation of the DescriptorReader descriptor source.
static java.lang.String	READER_PROPERTY	Property name for overriding the implementation of the DescriptorReader descriptor source, which is by default set to the class in READER_DEFAULT.

Constructor Summary

Constructors

Constructor	Description
DescriptorSourceFactory()

Method Summary

Modifier and Type	Method	Description
static DescriptorCollector	createDescriptorCollector()	Create a new DescriptorCollector by instantiating the class in COLLECTOR_PROPERTY.
static DescriptorParser	createDescriptorParser()	Create a new DescriptorParser by instantiating the class in PARSER_PROPERTY.
static DescriptorReader	createDescriptorReader()	Create a new DescriptorReader by instantiating the class in READER_PROPERTY.

Methods inherited from class java.lang.Object

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

Field Detail

PARSER_DEFAULT

public static final java.lang.String PARSER_DEFAULT

Default implementation of the DescriptorParser descriptor source.

Since:

1.0.0

See Also:

Constant Field Values

READER_DEFAULT

public static final java.lang.String READER_DEFAULT

Default implementation of the DescriptorReader descriptor source.

Since:

1.0.0

See Also:

Constant Field Values

COLLECTOR_DEFAULT

public static final java.lang.String COLLECTOR_DEFAULT

Default implementation of the DescriptorCollector descriptor source.

Since:

1.0.0

See Also:

Constant Field Values

PARSER_PROPERTY

public static final java.lang.String PARSER_PROPERTY

Property name for overriding the implementation of the DescriptorParser descriptor source, which is by default set to the class in PARSER_DEFAULT.

Since:

1.0.0

See Also:

Constant Field Values

READER_PROPERTY

public static final java.lang.String READER_PROPERTY

Property name for overriding the implementation of the DescriptorReader descriptor source, which is by default set to the class in READER_DEFAULT.

Since:

1.0.0

See Also:

Constant Field Values

COLLECTOR_PROPERTY

public static final java.lang.String COLLECTOR_PROPERTY

Property name for overriding the implementation of the DescriptorCollector descriptor source, which is by default set to the class in COLLECTOR_DEFAULT.

Since:

1.0.0

See Also:

Constant Field Values

Constructor Detail

DescriptorSourceFactory

public DescriptorSourceFactory()

Method Detail

createDescriptorParser

public static DescriptorParser createDescriptorParser()

Create a new DescriptorParser by instantiating the class in PARSER_PROPERTY.

Since:

1.0.0

createDescriptorReader

public static DescriptorReader createDescriptorReader()

Create a new DescriptorReader by instantiating the class in READER_PROPERTY.

Since:

1.0.0

createDescriptorCollector

public static DescriptorCollector createDescriptorCollector()

Create a new DescriptorCollector by instantiating the class in COLLECTOR_PROPERTY.

Since:

1.0.0