idk/i2p.plugins.firefox
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

update index.html

Browse Source 
Former-commit-id: 6ff6ca4fb3
Former-commit-id: 2986e6125d058346c6609a675ead59500e99ae18
This commit is contained in:
idk
2022-08-30 17:37:02 -04:00
parent 9881fb62e8
commit 7423a327e7
7 changed files with 112 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
I2PBrowser.md
View File

@ -67,9 +67,15 @@ package: net.i2p.i2pfirefox
+ Access: public + Access: public
#### boolean usability [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L)
>
+ Access: public
## Methods ## Methods
### launchFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L33) ### launchFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L34)
+ Description: + Description:
+ Access: private + Access: private
@ -81,7 +87,7 @@ package: net.i2p.i2pfirefox
| url | String[] | | | url | String[] | |
### launchChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L37) ### launchChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L39)
+ Description: + Description:
+ Access: private + Access: private
@ -93,7 +99,7 @@ package: net.i2p.i2pfirefox
| url | String[] | | | url | String[] | |
### launchGeneric [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L41) ### launchGeneric [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L44)
+ Description: + Description:
+ Access: private + Access: private
@ -105,7 +111,7 @@ package: net.i2p.i2pfirefox
| url | String[] | | | url | String[] | |
### setBrowser [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L64) ### setBrowser [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L67)
+ Description: + Description:
+ Access: public + Access: public
@ -116,7 +122,7 @@ package: net.i2p.i2pfirefox
| browserPath | String | | | browserPath | String | |
### hasChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L74) ### hasChromium [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L77)
+ Description: Return true if there is a Chromium available + Description: Return true if there is a Chromium available
+ Access: public + Access: public
@ -125,7 +131,7 @@ package: net.i2p.i2pfirefox
This method has no parameters. This method has no parameters.
### hasFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L91) ### hasFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L94)
+ Description: Return true if there is a Firefox variant available + Description: Return true if there is a Firefox variant available
+ Access: public + Access: public
@ -134,7 +140,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L111) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L114)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory.
+ Access: public + Access: public
@ -146,7 +152,7 @@ This method has no parameters.
| url | String[] | | | url | String[] | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L153) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L156)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory.
+ Access: public + Access: public
@ -157,7 +163,7 @@ This method has no parameters.
| privateWindow | boolean | | | privateWindow | boolean | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L162) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L165)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches either Firefox or Chromium with the profile directory.
+ Access: public + Access: public
@ -166,7 +172,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L164) ### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L167)
+ Description: + Description:
+ Access: private + Access: private
@ -178,7 +184,7 @@ This method has no parameters.
| inUrl | String | | | inUrl | String | |
### main [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L174) ### main [[src]](src/java/net/i2p/i2pfirefox/I2PBrowser.java#L177)
+ Description: + Description:
+ Access: public + Access: public

63
I2PChromium.md
View File

@ -45,9 +45,16 @@ package: net.i2p.i2pfirefox
+ Access: private + Access: private
#### boolean usability [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L)
>
+ Access: public
+ Modifiers: static
## Methods ## Methods
### FIND_CHROMIUM_SEARCH_PATHS_UNIX [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L44) ### FIND_CHROMIUM_SEARCH_PATHS_UNIX [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L45)
+ Description: + Description:
+ Access: private + Access: private
@ -57,7 +64,7 @@ package: net.i2p.i2pfirefox
This method has no parameters. This method has no parameters.
### FIND_CHROMIUM_SEARCH_PATHS_OSX [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L60) ### FIND_CHROMIUM_SEARCH_PATHS_OSX [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L61)
+ Description: + Description:
+ Access: private + Access: private
@ -67,7 +74,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### FIND_CHROMIUM_SEARCH_PATHS_WINDOWS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L78) ### FIND_CHROMIUM_SEARCH_PATHS_WINDOWS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L79)
+ Description: + Description:
+ Access: private + Access: private
@ -77,7 +84,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### FIND_ALL_CHROMIUM_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L115) ### FIND_ALL_CHROMIUM_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L116)
+ Description: + Description:
+ Access: private + Access: private
@ -87,7 +94,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### FIND_CHROMIUM_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L135) ### FIND_CHROMIUM_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L136)
+ Description: + Description:
+ Access: private + Access: private
@ -97,7 +104,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### NEARBY_CHROMIUM_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L149) ### NEARBY_CHROMIUM_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L150)
+ Description: + Description:
+ Access: private + Access: private
@ -107,7 +114,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### CHROMIUM_FINDER [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L203) ### CHROMIUM_FINDER [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L204)
+ Description: + Description:
+ Access: private + Access: private
@ -117,7 +124,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### getOperatingSystem [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L215) ### getOperatingSystem [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L216)
+ Description: + Description:
+ Access: private + Access: private
@ -127,7 +134,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### onlyValidChromiums [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L237) ### onlyValidChromiums [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L238)
+ Description: Check our list of chrome paths for a valid chrome binary. Just an existence check for now but should check versions in the future. + Description: Check our list of chrome paths for a valid chrome binary. Just an existence check for now but should check versions in the future.
+ Access: public + Access: public
@ -136,7 +143,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### topChromium [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L257) ### topChromium [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L258)
+ Description: Return the best available Chromium from the list of Chromiums we have. + Description: Return the best available Chromium from the list of Chromiums we have.
+ Access: public + Access: public
@ -145,7 +152,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### topChromium [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L286) ### topChromium [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L287)
+ Description: Return the best available Chromium from the list of Chromiums we have. if override is passed it will be validated and if it validates it will be used. + Description: Return the best available Chromium from the list of Chromiums we have. if override is passed it will be validated and if it validates it will be used.
+ Access: public + Access: public
@ -156,7 +163,7 @@ This method has no parameters.
| overrideChromium | String | | | overrideChromium | String | |
### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L304) ### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L305)
+ Description: Build a ProcessBuilder for the top Chromium binary and the default profile. + Description: Build a ProcessBuilder for the top Chromium binary and the default profile.
+ Access: public + Access: public
@ -165,7 +172,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L317) ### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L318)
+ Description: Build a ProcessBuilder for the top Chromium binary and the default profile. @args the arguments to pass to the Chromium binary + Description: Build a ProcessBuilder for the top Chromium binary and the default profile. @args the arguments to pass to the Chromium binary
+ Access: public + Access: public
@ -176,7 +183,7 @@ This method has no parameters.
| args | String[] | | | args | String[] | |
### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L329) ### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L330)
+ Description: Build a ProcessBuilder for the top Chromium binary and the default profile. + Description: Build a ProcessBuilder for the top Chromium binary and the default profile.
+ Access: public + Access: public
@ -185,7 +192,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L342) ### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L343)
+ Description: Build a ProcessBuilder for the top Chromium binary and the default profile. + Description: Build a ProcessBuilder for the top Chromium binary and the default profile.
+ Access: public + Access: public
@ -196,7 +203,7 @@ This method has no parameters.
| args | String[] | the arguments to pass to the Chromium binary. | | args | String[] | the arguments to pass to the Chromium binary. |
### processBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L387) ### processBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L388)
+ Description: Build a ProcessBuilder for the top Chromium binary and the default profile with a specific set of extended arguments. + Description: Build a ProcessBuilder for the top Chromium binary and the default profile with a specific set of extended arguments.
+ Access: public + Access: public
@ -207,7 +214,7 @@ This method has no parameters.
| args | String[] | the extended arguments to pass to the Chromium binary. | | args | String[] | the extended arguments to pass to the Chromium binary. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L441) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L442)
+ Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of 200 seconds. + Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of 200 seconds.
+ Access: public + Access: public
@ -216,7 +223,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L451) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L452)
+ Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of the specified number of seconds. + Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public + Access: public
@ -227,7 +234,7 @@ This method has no parameters.
| timeout | int | the number of seconds to wait for the proxy to be ready. | | timeout | int | the number of seconds to wait for the proxy to be ready. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L463) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L464)
+ Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds. + Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public + Access: public
@ -239,7 +246,7 @@ This method has no parameters.
| port | int | the port to wait for the proxy to be ready on. | | port | int | the port to wait for the proxy to be ready on. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L476) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L477)
+ Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds. + Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public + Access: public
@ -252,7 +259,7 @@ This method has no parameters.
| host | String | the host to wait for the proxy to be ready on. | | host | String | the host to wait for the proxy to be ready on. |
### checkifPortIsOccupied [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L489) ### checkifPortIsOccupied [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L490)
+ Description: + Description:
+ Access: private + Access: private
@ -264,7 +271,7 @@ This method has no parameters.
| host | String | | | host | String | |
### launchAndDetatch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L499) ### launchAndDetatch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L500)
+ Description: + Description:
+ Access: public + Access: public
@ -276,7 +283,7 @@ This method has no parameters.
| url | String[] | | | url | String[] | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L544) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L545)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Chromium with the profile directory.
+ Access: public + Access: public
@ -288,7 +295,7 @@ This method has no parameters.
| url | String[] | | | url | String[] | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L567) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L568)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Chromium with the profile directory.
+ Access: public + Access: public
@ -299,7 +306,7 @@ This method has no parameters.
| privateWindow | boolean | | | privateWindow | boolean | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L576) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L577)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Chromium with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Chromium with the profile directory.
+ Access: public + Access: public
@ -308,7 +315,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L578) ### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L579)
+ Description: + Description:
+ Access: private + Access: private
@ -320,7 +327,7 @@ This method has no parameters.
| inUrl | String | | | inUrl | String | |
### main [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L588) ### main [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L589)
+ Description: + Description:
+ Access: public + Access: public
@ -332,7 +339,7 @@ This method has no parameters.
| args | String[] | | | args | String[] | |
### sleep [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L610) ### sleep [[src]](src/java/net/i2p/i2pfirefox/I2PChromium.java#L611)
+ Description: + Description:
+ Access: private + Access: private

6
I2PCommonBrowser.md
View File

@ -105,9 +105,10 @@ package: net.i2p.i2pfirefox
| sourceDirectory | File | | | sourceDirectory | File | |
| destinationDirectory | File | | | destinationDirectory | File | |
| browser | String | | | browser | String | |
| base | String | |
### copyDirectoryCompatibityMode [[src]](src/java/net/i2p/i2pfirefox/I2PCommonBrowser.java#L166) ### copyDirectoryCompatibityMode [[src]](src/java/net/i2p/i2pfirefox/I2PCommonBrowser.java#L168)
+ Description: + Description:
+ Access: private + Access: private
@ -119,9 +120,10 @@ package: net.i2p.i2pfirefox
| source | File | | | source | File | |
| destination | File | | | destination | File | |
| browser | String | | | browser | String | |
| base | String | |
### copyFile [[src]](src/java/net/i2p/i2pfirefox/I2PCommonBrowser.java#L175) ### copyFile [[src]](src/java/net/i2p/i2pfirefox/I2PCommonBrowser.java#L177)
+ Description: + Description:
+ Access: private + Access: private

72
I2PFirefox.md
View File

@ -45,9 +45,16 @@ package: net.i2p.i2pfirefox
+ Access: private + Access: private
#### boolean usability [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L)
>
+ Access: public
+ Modifiers: static
## Methods ## Methods
### FIND_FIREFOX_SEARCH_PATHS_UNIX [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L44) ### FIND_FIREFOX_SEARCH_PATHS_UNIX [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L45)
+ Description: + Description:
+ Access: private + Access: private
@ -57,7 +64,7 @@ package: net.i2p.i2pfirefox
This method has no parameters. This method has no parameters.
### FIND_FIREFOX_SEARCH_PATHS_OSX [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L59) ### FIND_FIREFOX_SEARCH_PATHS_OSX [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L60)
+ Description: + Description:
+ Access: private + Access: private
@ -67,7 +74,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### FIND_FIREFOX_SEARCH_PATHS_WINDOWS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L76) ### FIND_FIREFOX_SEARCH_PATHS_WINDOWS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L77)
+ Description: + Description:
+ Access: private + Access: private
@ -77,7 +84,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### FIND_ALL_FIREFOX_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L112) ### FIND_ALL_FIREFOX_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L113)
+ Description: + Description:
+ Access: private + Access: private
@ -87,7 +94,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### FIND_FIREFOX_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L132) ### FIND_FIREFOX_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L133)
+ Description: + Description:
+ Access: private + Access: private
@ -97,7 +104,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### NEARBY_FIREFOX_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L146) ### NEARBY_FIREFOX_SEARCH_PATHS [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L147)
+ Description: + Description:
+ Access: private + Access: private
@ -107,7 +114,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### FIREFOX_FINDER [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L200) ### FIREFOX_FINDER [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L201)
+ Description: + Description:
+ Access: private + Access: private
@ -117,7 +124,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### getOperatingSystem [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L212) ### getOperatingSystem [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L213)
+ Description: + Description:
+ Access: private + Access: private
@ -127,7 +134,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### onlyValidFirefoxes [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L234) ### onlyValidFirefoxes [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L235)
+ Description: Check our list of firefox paths for a valid firefox binary. Just an existence check for now but should check versions in the future. + Description: Check our list of firefox paths for a valid firefox binary. Just an existence check for now but should check versions in the future.
+ Access: public + Access: public
@ -136,7 +143,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### topFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L254) ### topFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L255)
+ Description: Return the best available Firefox from the list of Firefoxes we have. + Description: Return the best available Firefox from the list of Firefoxes we have.
+ Access: public + Access: public
@ -145,7 +152,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### topFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L283) ### topFirefox [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L284)
+ Description: Return the best available Firefox from the list of Firefoxes we have. if override is passed it will be validated and if it validates it will be used. + Description: Return the best available Firefox from the list of Firefoxes we have. if override is passed it will be validated and if it validates it will be used.
+ Access: public + Access: public
@ -156,7 +163,7 @@ This method has no parameters.
| overrideFirefox | String | | | overrideFirefox | String | |
### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L301) ### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L302)
+ Description: Build a ProcessBuilder for the top Firefox binary and the default profile. + Description: Build a ProcessBuilder for the top Firefox binary and the default profile.
+ Access: public + Access: public
@ -165,7 +172,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L313) ### defaultProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L314)
+ Description: Build a ProcessBuilder for the top Firefox binary and the default profile. + Description: Build a ProcessBuilder for the top Firefox binary and the default profile.
+ Access: public + Access: public
@ -176,7 +183,7 @@ This method has no parameters.
| args | String[] | the args to pass to the Firefox binary | | args | String[] | the args to pass to the Firefox binary |
### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L327) ### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L328)
+ Description: Build a ProcessBuilder for the top Firefox binary and the default profile. Pass the --private-window flag to open a window. + Description: Build a ProcessBuilder for the top Firefox binary and the default profile. Pass the --private-window flag to open a window.
+ Access: public + Access: public
@ -185,7 +192,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L340) ### privateProcessBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L341)
+ Description: Build a ProcessBuilder for the top Firefox binary and the default profile. Pass the --private-window flag to open a window. + Description: Build a ProcessBuilder for the top Firefox binary and the default profile. Pass the --private-window flag to open a window.
+ Access: public + Access: public
@ -196,7 +203,7 @@ This method has no parameters.
| args | String[] | the arguments to pass to the Firefox binary | | args | String[] | the arguments to pass to the Firefox binary |
### processBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L361) ### processBuilder [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L362)
+ Description: Build a ProcessBuilder for the top Firefox binary and the default profile with a specific set of extended arguments. + Description: Build a ProcessBuilder for the top Firefox binary and the default profile with a specific set of extended arguments.
+ Access: public + Access: public
@ -207,7 +214,7 @@ This method has no parameters.
| args | String[] | the extended arguments to pass to the Firefox binary. | | args | String[] | the extended arguments to pass to the Firefox binary. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L388) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L389)
+ Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of 200 seconds. + Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of 200 seconds.
+ Access: public + Access: public
@ -216,7 +223,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L398) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L399)
+ Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of the specified number of seconds. + Description: Waits for an HTTP proxy on port 4444 to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public + Access: public
@ -227,7 +234,7 @@ This method has no parameters.
| timeout | int | the number of seconds to wait for the proxy to be ready. | | timeout | int | the number of seconds to wait for the proxy to be ready. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L410) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L411)
+ Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds. + Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public + Access: public
@ -239,7 +246,7 @@ This method has no parameters.
| port | int | the port to wait for the proxy to be ready on. | | port | int | the port to wait for the proxy to be ready on. |
### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L423) ### waitForProxy [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L424)
+ Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds. + Description: Waits for an HTTP proxy on the specified port to be ready. Returns false on timeout of the specified number of seconds.
+ Access: public + Access: public
@ -252,7 +259,7 @@ This method has no parameters.
| host | String | the host to wait for the proxy to be ready on. | | host | String | the host to wait for the proxy to be ready on. |
### checkifPortIsOccupied [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L436) ### checkifPortIsOccupied [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L437)
+ Description: + Description:
+ Access: private + Access: private
@ -264,7 +271,16 @@ This method has no parameters.
| host | String | | | host | String | |
### launchAndDetatch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L446) ### usabilityMode [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L447)
+ Description:
+ Access: private
+ return: String
This method has no parameters.
### launchAndDetatch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L454)
+ Description: + Description:
+ Access: public + Access: public
@ -276,7 +292,7 @@ This method has no parameters.
| url | String[] | | | url | String[] | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L491) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L500)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Firefox with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Firefox with the profile directory.
+ Access: public + Access: public
@ -288,7 +304,7 @@ This method has no parameters.
| url | String[] | | | url | String[] | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L513) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L522)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Firefox with the profile directory. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Firefox with the profile directory.
+ Access: public + Access: public
@ -299,7 +315,7 @@ This method has no parameters.
| privateWindow | boolean | | | privateWindow | boolean | |
### launch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L523) ### launch [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L532)
+ Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Firefox with the profile directory. Uses a semi-permanent profile. + Description: Populates a profile directory with a proxy configuration. Waits for an HTTP proxy on the port 4444 to be ready. Launches Firefox with the profile directory. Uses a semi-permanent profile.
+ Access: public + Access: public
@ -308,7 +324,7 @@ This method has no parameters.
This method has no parameters. This method has no parameters.
### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L525) ### ValidURL [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L534)
+ Description: + Description:
+ Access: private + Access: private
@ -320,7 +336,7 @@ This method has no parameters.
| inUrl | String | | | inUrl | String | |
### main [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L536) ### main [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L545)
+ Description: + Description:
+ Access: public + Access: public
@ -332,7 +348,7 @@ This method has no parameters.
| args | String[] | | | args | String[] | |
### sleep [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L559) ### sleep [[src]](src/java/net/i2p/i2pfirefox/I2PFirefox.java#L571)
+ Description: + Description:
+ Access: private + Access: private

13
I2PFirefoxProfileBuilder.md
View File

@ -54,6 +54,7 @@ This method has no parameters.
| Name | Type | Description | | Name | Type | Description |
| ----- | ----- | ----- | | ----- | ----- | ----- |
| file | String | | | file | String | |
| base | String | |
### baseProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileBuilder.java#L57) ### baseProfileDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileBuilder.java#L57)
@ -63,7 +64,9 @@ This method has no parameters.
+ Modifiers: static + Modifiers: static
+ return: String + return: String
This method has no parameters. | Name | Type | Description |
| ----- | ----- | ----- |
| base | String | |
### runtimeDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileBuilder.java#L81) ### runtimeDirectory [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileBuilder.java#L81)
@ -95,7 +98,9 @@ This method has no parameters.
+ Modifiers: static + Modifiers: static
+ return: boolean + return: boolean
This method has no parameters. | Name | Type | Description |
| ----- | ----- | ----- |
| base | String | |
### copyStrictOptions [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileBuilder.java#L149) ### copyStrictOptions [[src]](src/java/net/i2p/i2pfirefox/I2PFirefoxProfileBuilder.java#L149)
@ -105,6 +110,8 @@ This method has no parameters.
+ Modifiers: static + Modifiers: static
+ return: true if successful false otherwise + return: true if successful false otherwise
This method has no parameters. | Name | Type | Description |
| ----- | ----- | ----- |
| base | String | |

1
I2PFirefoxProfileUnpacker.md
View File

@ -45,5 +45,6 @@ package: net.i2p.i2pfirefox
| Name | Type | Description | | Name | Type | Description |
| ----- | ----- | ----- | | ----- | ----- | ----- |
| profileDirectory | String | | | profileDirectory | String | |
| base | String | |

2
index.html
View File

@ -139,7 +139,7 @@
<div> <div>
<pre> <pre>
mkdir ~/tmp-i2pfirefox &amp;&amp; cd ~/tmp-i2pfirefox mkdir ~/tmp-i2pfirefox &amp;&amp; cd ~/tmp-i2pfirefox
wget https://github.com/eyedeekay/i2p.plugins.firefox/releases/download/0.0.10/i2pfirefox.zip wget https://github.com/eyedeekay/i2p.plugins.firefox/releases/download/0.0.16/i2pfirefox.zip
unzip i2pfirefox.zip unzip i2pfirefox.zip
./i2pfirefox.cmd ./i2pfirefox.cmd