Package com.inductiveautomation.ignition.common.util

Class HttpUtils

  • public class HttpUtils
extends java.lang.Object
    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.

    • Constructor Summary

      Constructors 
      Constructor Description
      HttpUtils()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean isOkResponse​(java.lang.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 boolean isOkResponse​(java.lang.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 boolean isOkResponse​(java.net.URL url)
      Makes a test connection to the provided URL.
      static boolean isOkResponse​(java.net.URL url, int timeout)  
      static boolean isValidUrl​(java.lang.String url)
      Tests the url for valid format.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • VALID_URL_PATTERN

        public static final java.util.regex.Pattern VALID_URL_PATTERN

    • Constructor Detail

      • HttpUtils

        public HttpUtils()

    • Method Detail

      • isOkResponse

        public static boolean isOkResponse​(java.net.URL url)
                            throws java.io.IOException
        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:
        java.io.IOException

      • isOkResponse

        public static boolean isOkResponse​(java.net.URL url,
                                   int timeout)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • isOkResponse

        public static boolean isOkResponse​(java.lang.String address)
                            throws java.net.MalformedURLException
        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:
        java.net.MalformedURLException

      • isOkResponse

        public static boolean isOkResponse​(java.lang.String address,
                                   int timeout)
                            throws java.net.MalformedURLException
        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
        timeout - connection timeout in millis
        Returns:
        true when the given string resolves to an http or https connection that gives a code 200 response
        Throws:
        java.net.MalformedURLException

      • isValidUrl

        public static boolean isValidUrl​(java.lang.String url)
        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