Class ClientIDPlugin

java.lang.Object

com.biglybt.pifimpl.local.clientid.ClientIDPlugin

All Implemented Interfaces:

ClientIDGenerator, Plugin

public class ClientIDPlugin
extends Object
implements Plugin, ClientIDGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BIGLY_NAME
private static final String	BIGLY_VERSION
private static final String	BIGLYBT_CLIENT_NAME
private static final String	BIGLYBT_CLIENT_NAME_SM
private Core	core
private static boolean	send_os

Fields inherited from interface ClientIDGenerator

PR_CLIENT_NAME, PR_MESSAGING_MODE, PR_PROXY, PR_RAW_REQUEST, PR_SNI_HACK, PR_URL, PR_USER_AGENT

Constructor Summary

Constructors

Constructor	Description
ClientIDPlugin()

Method Summary

Modifier and Type	Method	Description
protected void	doHTTPProperties(Properties properties)
String[]	filterHTTP(byte[] hash, String[] lines_in)	For more complex situations a filter approach is used.
void	generateHTTPProperties(byte[] hash, Properties properties)	generate appropriate properties to be supplied to HTTP(S) URL connection If you want to access the torrents then you need to decode the URL to extract the hashes and then look them up (for scrape there could be multiple torrents) Enabled when the generator isn't specified as a filter
byte[]	generatePeerID(byte[] hash, boolean for_tracker)	generate a peer id - must be exactly 20 bytes
Properties	getInitialProperties()
Object	getProperty(byte[] hash, String property_name)
void	initialize(Core _core)
void	initialize(PluginInterface pi)	This method is called when the Plugin is loaded by the client
private void	initializeSupport(PluginInterface pi)

Methods inherited from class Object

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

Field Details

BIGLY_NAME

private static final String BIGLY_NAME

See Also:

• Constant Field Values

BIGLY_VERSION

private static final String BIGLY_VERSION

See Also:

• Constant Field Values

BIGLYBT_CLIENT_NAME

private static final String BIGLYBT_CLIENT_NAME

See Also:

• Constant Field Values

BIGLYBT_CLIENT_NAME_SM

private static final String BIGLYBT_CLIENT_NAME_SM

See Also:

• Constant Field Values

send_os

private static boolean send_os

core

private Core core

Constructor Details

ClientIDPlugin

public ClientIDPlugin()

Method Details

getInitialProperties

public Properties getInitialProperties()

Specified by:

getInitialProperties in interface Plugin

initialize

public void initialize(Core _core)

generatePeerID

public byte[] generatePeerID(byte[] hash,
 boolean for_tracker)

Description copied from interface: ClientIDGenerator

generate a peer id - must be exactly 20 bytes

Specified by:

generatePeerID in interface ClientIDGenerator

Parameters:

for_tracker - generator to give to tracker or for peer-peer comms

Returns:

getProperty

public Object getProperty(byte[] hash,
 String property_name)

Specified by:

getProperty in interface ClientIDGenerator

doHTTPProperties

protected void doHTTPProperties(Properties properties)

generateHTTPProperties

public void generateHTTPProperties(byte[] hash,
 Properties properties)

Description copied from interface: ClientIDGenerator

generate appropriate properties to be supplied to HTTP(S) URL connection If you want to access the torrents then you need to decode the URL to extract the hashes and then look them up (for scrape there could be multiple torrents) Enabled when the generator isn't specified as a filter

Specified by:

generateHTTPProperties in interface ClientIDGenerator

Parameters:

properties -

filterHTTP

public String[] filterHTTP(byte[] hash,
 String[] lines_in)

Description copied from interface: ClientIDGenerator

For more complex situations a filter approach is used. The lines of the request are passed in for modification and return Enabled when the generator is specified as a filter

Specified by:

filterHTTP in interface ClientIDGenerator

Parameters:

lines_in -

Returns:

initialize

public void initialize(PluginInterface pi)

Description copied from interface: Plugin

This method is called when the Plugin is loaded by the client

Specified by:

initialize in interface Plugin

Parameters:

pi - the interface that the plugin must use to communicate with the client

initializeSupport

private void initializeSupport(PluginInterface pi)