Class HttpUtils
java.lang.Object
com.inductiveautomation.ignition.common.util.HttpUtils
Filename: HttpUtils Author: Perry Arellano-Jones Created on: 8/14/15
This class provides some simple connectivity utilities which may be common when trying to get information about an HTTP connection.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic booleanisOkResponse(String address) This static method will try to resolve a URL passed in as a string, and if successful, will try to determine if the response given is an "OK" response (aka, code 200).static booleanisOkResponse(String address, int timeout) This static method will try to resolve a URL passed in as a string, and if successful, will try to determine if the response given is an "OK" response (aka, code 200).static booleanisOkResponse(URL url) Makes a test connection to the provided URL.static booleanisOkResponse(URL url, int timeout) static booleanisValidHeaderName(String name) static booleanisValidHeaderValue(String value) static booleanisValidUrl(String url) Tests the url for valid format.static StringsanitizeHeaderValue(String value) Drop characters illegal in an HTTP header value (retaining printable ASCII and HTAB) and trim surrounding whitespace.
-
Field Details
-
RESPONSE_OK
public static final int RESPONSE_OK- See Also:
-
VALID_URL_PATTERN
-
-
Constructor Details
-
HttpUtils
public HttpUtils()
-
-
Method Details
-
isOkResponse
Makes a test connection to the provided URL. If the response has a 200 "OK" code, the method returns true. If the response is anything other than 200, this method returns false.This method is useful when trying to verify that a URL is online and has a valid site available. Omitting the timeout parameter uses 0, or an infinite timeout
- Parameters:
url- the URL that will be tested for connection/content quality.- Returns:
- true when the GET request of the url is responded to with a code 200
- Throws:
IOException
-
isOkResponse
- Throws:
IOException
-
isOkResponse
This static method will try to resolve a URL passed in as a string, and if successful, will try to determine if the response given is an "OK" response (aka, code 200). On success it returns true. All other response codes return false.- Parameters:
address- which is the url to be tested for connectivity- Returns:
- true when the given string resolves to an http or https connection that gives a code 200 response
- Throws:
MalformedURLException
-
isOkResponse
This static method will try to resolve a URL passed in as a string, and if successful, will try to determine if the response given is an "OK" response (aka, code 200). On success it returns true. All other response codes return false.- Parameters:
address- which is the url to be tested for connectivitytimeout- connection timeout in millis- Returns:
- true when the given string resolves to an http or https connection that gives a code 200 response
- Throws:
MalformedURLException
-
isValidUrl
Tests the url for valid format. Does not attempt to resolve or validate beyond the syntactic structure of the string.- Parameters:
url- url to test- Returns:
- false if invalid or url was null
-
isValidHeaderName
- Returns:
- true if
nameis a non-empty, legal HTTP header name (an RFC 7230 token).
-
isValidHeaderValue
- Returns:
- true if every character of
valueis legal in an HTTP header value (printable ASCII or HTAB).
-
sanitizeHeaderValue
-