Package org.kiwiproject.jaxrs.client

Class KiwiJerseyClients

  • public class KiwiJerseyClients
extends Object
    Static utilities related to Jersey Client instances. If these methods are used with a JAX-RS implementation other than Jersey, you should not expect anything to work. Some might fail silently, others could throw unexpected exceptions, etc.

    We do not check to make sure the Client instances are in fact Jersey client instances; we expect if you are using a class named KiwiJerseyClients you understand this, and if not then, as they say, all bets are off.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void checkTimeout​(long timeoutMillis)
      Check the given timeout, in milliseconds, to be used for a Jersey connect and/or read timeout.
      static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client, int timeoutMillis)
      Set connect timeout.
      static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client, long timeoutMillis)
      Set connect timeout.
      static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client, io.dropwizard.util.Duration timeout)
      Set connect timeout.
      static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client, Duration timeout)
      Set connect timeout.
      static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client, int timeoutMillis)
      Set read timeout.
      static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client, long timeoutMillis)
      Set read timeout.
      static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client, io.dropwizard.util.Duration timeout)
      Set read timeout.
      static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client, Duration timeout)
      Set read timeout.

    • Constructor Detail

      • KiwiJerseyClients

        public KiwiJerseyClients()

    • Method Detail

      • connectTimeout

        public static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client,
                                                       io.dropwizard.util.Duration timeout)
        Set connect timeout.
        Parameters:
        client - the Jersey Client instance
        timeout - the timeout as a Dropwizard Duration
        Returns:
        the provided Client instance

      • connectTimeout

        public static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client,
                                                       Duration timeout)
        Set connect timeout.
        Parameters:
        client - the Jersey Client instance
        timeout - the timeout as a Java Duration
        Returns:
        the provided Client instance

      • connectTimeout

        public static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client,
                                                       long timeoutMillis)
        Set connect timeout.
        Parameters:
        client - the Jersey Client instance
        timeoutMillis - the long timeout in milliseconds
        Returns:
        the provided Client instance

      • connectTimeout

        public static javax.ws.rs.client.Client connectTimeout​(javax.ws.rs.client.Client client,
                                                       int timeoutMillis)
        Set connect timeout.
        Parameters:
        client - the Jersey Client instance
        timeoutMillis - the int timeout in milliseconds
        Returns:
        the provided Client instance
        See Also:
        ClientProperties.CONNECT_TIMEOUT

      • readTimeout

        public static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client,
                                                    io.dropwizard.util.Duration timeout)
        Set read timeout.
        Parameters:
        client - the Jersey Client instance
        timeout - the timeout as a Dropwizard Duration
        Returns:
        the provided Client instance

      • readTimeout

        public static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client,
                                                    Duration timeout)
        Set read timeout.
        Parameters:
        client - the Jersey Client instance
        timeout - the timeout as a Java Duration
        Returns:
        the provided Client instance

      • readTimeout

        public static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client,
                                                    long timeoutMillis)
        Set read timeout.
        Parameters:
        client - the Jersey Client instance
        timeoutMillis - the long timeout in milliseconds
        Returns:
        the provided Client instance

      • readTimeout

        public static javax.ws.rs.client.Client readTimeout​(javax.ws.rs.client.Client client,
                                                    int timeoutMillis)
        Set read timeout.
        Parameters:
        client - the Jersey Client instance
        timeoutMillis - the int timeout in milliseconds
        Returns:
        the provided Client instance
        See Also:
        ClientProperties.READ_TIMEOUT

      • checkTimeout

        public static void checkTimeout​(long timeoutMillis)
        Check the given timeout, in milliseconds, to be used for a Jersey connect and/or read timeout.
        Parameters:
        timeoutMillis - the timeout to check, in milliseconds
        Throws:
        IllegalArgumentException - if the given number of milliseconds is greater than Integer.MAX_VALUE
        See Also:
        ClientProperties.CONNECT_TIMEOUT, ClientProperties.READ_TIMEOUT