CircumventionProvider (onionwrapper-core 0.1.3 API)

@ThreadSafe @NotNullByDefault public interface CircumventionProvider

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

CircumventionProvider.BridgeType
Field Summary

Fields

Modifier and Type

Field

Description

static final String[]

COUNTRIES_DEFAULT_OBFS4

Countries where default obfs4 bridges should be used.

static final String[]

COUNTRIES_MEEK

Countries where meek bridges should be used.

static final String[]

COUNTRIES_NON_DEFAULT_OBFS4

Countries where non-default obfs4 bridges should be used.

static final String[]

COUNTRIES_SNOWFLAKE

Countries where snowflake bridges should be used.

static final String[]

COUNTRIES_VANILLA

Countries where vanilla bridges should be used.
Method Summary

Modifier and Type

Method

Description

List<String>

getBridges(CircumventionProvider.BridgeType type, String countryCode)

Returns bridges of the given type that are usable in the given country.

List<CircumventionProvider.BridgeType>

getSuitableBridgeTypes(String countryCode)

Returns the types of bridge connection that are suitable for the given country, or CircumventionProvider.BridgeType.DEFAULT_OBFS4 and CircumventionProvider.BridgeType.VANILLA if we don't have any specific recommendations for the given country.

boolean

shouldUseBridges(String countryCode)

Returns true if bridges should be used by default in the given country.

Field Details
- COUNTRIES_DEFAULT_OBFS4
  
  static final String[] COUNTRIES_DEFAULT_OBFS4
  
  Countries where default obfs4 bridges should be used.
- COUNTRIES_NON_DEFAULT_OBFS4
  
  static final String[] COUNTRIES_NON_DEFAULT_OBFS4
  
  Countries where non-default obfs4 bridges should be used.
- COUNTRIES_VANILLA
  
  static final String[] COUNTRIES_VANILLA
  
  Countries where vanilla bridges should be used.
- COUNTRIES_MEEK
  
  static final String[] COUNTRIES_MEEK
  
  Countries where meek bridges should be used.
- COUNTRIES_SNOWFLAKE
  
  static final String[] COUNTRIES_SNOWFLAKE
  
  Countries where snowflake bridges should be used.
Method Details
- shouldUseBridges
  
  boolean shouldUseBridges(String countryCode)
  
  Returns true if bridges should be used by default in the given country.
- getSuitableBridgeTypes
  
  List<CircumventionProvider.BridgeType> getSuitableBridgeTypes(String countryCode)
  
  Returns the types of bridge connection that are suitable for the given country, or CircumventionProvider.BridgeType.DEFAULT_OBFS4 and CircumventionProvider.BridgeType.VANILLA if we don't have any specific recommendations for the given country.
- getBridges
  
  List<String> getBridges(CircumventionProvider.BridgeType type, String countryCode)
  
  Returns bridges of the given type that are usable in the given country.