de.griefed.serverpackcreator.utilities.common

Class WebUtilities

java.lang.Object

de.griefed.serverpackcreator.utilities.common.WebUtilities

@Component
public final class WebUtilities
extends java.lang.Object

Utility-class revolving around interactions with web-resources.

Constructor Summary

Constructors

Constructor and Description
WebUtilities(ApplicationProperties injectedApplicationProperties)

Method Summary

Modifier and Type	Method and Description
java.lang.String	createHasteBinFromFile(java.io.File textFile) Create a HasteBin post from a given text file.
boolean	downloadAndReplaceFile(java.io.File destinationFile, java.net.URL downloadURL) Download the file from the specified URL to the specified destination, replacing the file if it already exists.
boolean	downloadAndReplaceFile(java.lang.String fileDestination, java.net.URL downloadURL) Download the file from the specified URL to the specified destination, replacing the file if it already exists.
boolean	downloadFile(java.io.File destinationFile, java.net.URL downloadURL) Download the file from the specified URL to the specified destination.
boolean	downloadFile(java.lang.String fileDestination, java.net.URL downloadURL) Download the file from the specified URL to the specified destination.
java.lang.String	getResponseAsString(java.net.URL url) Get the reponse of a call to a URL as a string.
int	getResponseCode(java.net.URL url) Get the response-code of a call to a URL as an integer.
boolean	hasteBinPreChecks(java.io.File fileToCheck) Checks the filesize of the given file whether it is smaller or bigger than 10 MB.
boolean	isReachable(java.net.URL url) Check the availability of the host of the given URL and whether the URL gives a status code of 200.
void	openLinkInBrowser(java.net.URI uri) Open the given uri in a browser.
void	openLinkInBrowser(java.net.URL url) Open the given url in a browser.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebUtilities

public WebUtilities(ApplicationProperties injectedApplicationProperties)

Method Detail

downloadAndReplaceFile

public boolean downloadAndReplaceFile(java.io.File destinationFile,
                                      java.net.URL downloadURL)

Download the file from the specified URL to the specified destination, replacing the file if it already exists. The destination should end in a valid filename. Any directories up to the specified file will be created.

Parameters:

destinationFile - The file to store the web-resource in. Examples:
/tmp/some_folder/foo.bar
C:/temp/some_folder/bar.foo

downloadURL - The URL to the file you want to download.

Returns:

Boolean. Returns true if the file could be found on the hosts filesystem.

downloadAndReplaceFile

public boolean downloadAndReplaceFile(java.lang.String fileDestination,
                                      java.net.URL downloadURL)

Download the file from the specified URL to the specified destination, replacing the file if it already exists. The destination should end in a valid filename. Any directories up to the specified file will be created.

Parameters:

fileDestination - The file to store the web-resource in. Examples:
/tmp/some_folder/foo.bar
C:/temp/some_folder/bar.foo

downloadURL - The URL to the file you want to download.

Returns:

Boolean. Returns true if the file could be found on the hosts filesystem.

downloadFile

public boolean downloadFile(java.lang.String fileDestination,
                            java.net.URL downloadURL)

Download the file from the specified URL to the specified destination. The destination should end in a valid filename. Any directories up to the specified file will be created.

Parameters:

fileDestination - The destination where the file should be stored. Must include the filename as well. Examples:
/tmp/some_folder/foo.bar
C:/temp/some_folder/bar.foo

downloadURL - The URL to the file you want to download.

Returns:

Boolean. Returns true if the file could be found on the hosts filesystem.

downloadFile

public boolean downloadFile(java.io.File destinationFile,
                            java.net.URL downloadURL)

Download the file from the specified URL to the specified destination. The destination should end in a valid filename. Any directories up to the specified file will be created.

Parameters:

destinationFile - File. The file to store the web-resource in. Examples:
/tmp/some_folder/foo.bar
C:/temp/some_folder/bar.foo

downloadURL - URL. The URL to the file you want to download.

Returns:

Boolean. Returns true if the file could be found on the hosts filesystem.

openLinkInBrowser

public void openLinkInBrowser(java.net.URL url)

Open the given url in a browser.

Parameters:

url - The URI to the website you want to open.

openLinkInBrowser

public void openLinkInBrowser(java.net.URI uri)

Open the given uri in a browser.

Parameters:

uri - The URI to the website you want to open.

hasteBinPreChecks

public boolean hasteBinPreChecks(java.io.File fileToCheck)

Checks the filesize of the given file whether it is smaller or bigger than 10 MB.

Parameters:

fileToCheck - The file or directory to check.

Returns:

Boolean. True if the file is smaller, false if the file is bigger than 10 MB.

createHasteBinFromFile

public java.lang.String createHasteBinFromFile(java.io.File textFile)

Create a HasteBin post from a given text file. The text file provided is read into a string and then passed onto Haste zneix which creates a HasteBin post out of the passed String and returns the URL to the newly created post.
Created with the help of kaimu-kun's hastebin.java (MIT License) and edited to use HasteBin fork zneix/haste-server. My fork of kaimu-kun's hastebin.java is available at Griefed/hastebin.java.

Parameters:

textFile - The file which will be read into a String of which then to create a HasteBin post of.

Returns:

String. Returns a String containing the URL to the newly created HasteBin post.

getResponseAsString

public java.lang.String getResponseAsString(java.net.URL url)
                                     throws java.io.IOException

Get the reponse of a call to a URL as a string.

Parameters:

url - The URL you want to get the response from

Returns:

The response.

Throws:

java.io.IOException - if the URL could not be called or a communication error occurred.

getResponseCode

public int getResponseCode(java.net.URL url)
                    throws java.io.IOException

Get the response-code of a call to a URL as an integer.

Parameters:

url - The URL you want to get the response from

Returns:

The response.

Throws:

java.io.IOException - if the URL could not be called or a communication error occurred.

isReachable

public boolean isReachable(java.net.URL url)

Check the availability of the host of the given URL and whether the URL gives a status code of 200. Only when both the host is available and the URL returns a status code of 200 does this method return true.

Parameters:

url - The URL of which to check for host-availability.

Returns:

true if, and only if, the host is available and the URL returns the status code 200..