Class JerseyWebTarget

java.lang.Object
org.glassfish.jersey.client.JerseyWebTarget
All Implemented Interfaces:
javax.ws.rs.client.WebTarget, javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>, Initializable<JerseyWebTarget>
public class JerseyWebTarget extends Object implements javax.ws.rs.client.WebTarget, Initializable<JerseyWebTarget>
Jersey implementation of JAX-RS client target contract.

  • Field Details

    • config

      private final ClientConfig config

    • targetUri

      private final javax.ws.rs.core.UriBuilder targetUri

  • Constructor Details

    • JerseyWebTarget

      JerseyWebTarget(String uri, JerseyClient parent)
      Create new web target instance.
      Parameters:
      uri - target URI.
      parent - parent client.

    • JerseyWebTarget

      JerseyWebTarget(URI uri, JerseyClient parent)
      Create new web target instance.
      Parameters:
      uri - target URI.
      parent - parent client.

    • JerseyWebTarget

      JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder, JerseyClient parent)
      Create new web target instance.
      Parameters:
      uriBuilder - builder for the target URI.
      parent - parent client.

    • JerseyWebTarget

      JerseyWebTarget(javax.ws.rs.core.Link link, JerseyClient parent)
      Create new web target instance.
      Parameters:
      link - link to the target URI.
      parent - parent client.

    • JerseyWebTarget

      protected JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder, JerseyWebTarget that)
      Create new web target instance.
      Parameters:
      uriBuilder - builder for the target URI.
      that - original target to copy the internal data from.

    • JerseyWebTarget

      protected JerseyWebTarget(javax.ws.rs.core.UriBuilder uriBuilder, ClientConfig clientConfig)
      Create new web target instance.
      Parameters:
      uriBuilder - builder for the target URI.
      clientConfig - target configuration.

  • Method Details

    • getUri

      public URI getUri()
      Specified by:
      getUri in interface javax.ws.rs.client.WebTarget

    • checkNotClosed

      private void checkNotClosed()

    • getUriBuilder

      public javax.ws.rs.core.UriBuilder getUriBuilder()
      Specified by:
      getUriBuilder in interface javax.ws.rs.client.WebTarget

    • path

      public JerseyWebTarget path(String path) throws NullPointerException
      Specified by:
      path in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • matrixParam

      public JerseyWebTarget matrixParam(String name, Object... values) throws NullPointerException
      Specified by:
      matrixParam in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • queryParam

      public JerseyWebTarget queryParam(String name, Object... values) throws NullPointerException
      Specified by:
      queryParam in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • setQueryParam

      private static javax.ws.rs.core.UriBuilder setQueryParam(javax.ws.rs.core.UriBuilder uriBuilder, String name, Object[] values)

    • checkForNullValues

      private static void checkForNullValues(String name, Object[] values)

    • request

      public JerseyInvocation.Builder request()
      Specified by:
      request in interface javax.ws.rs.client.WebTarget

    • request

      public JerseyInvocation.Builder request(String... acceptedResponseTypes)
      Specified by:
      request in interface javax.ws.rs.client.WebTarget

    • request

      public JerseyInvocation.Builder request(javax.ws.rs.core.MediaType... acceptedResponseTypes)
      Specified by:
      request in interface javax.ws.rs.client.WebTarget

    • resolveTemplate

      public JerseyWebTarget resolveTemplate(String name, Object value) throws NullPointerException
      Specified by:
      resolveTemplate in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • resolveTemplate

      public JerseyWebTarget resolveTemplate(String name, Object value, boolean encodeSlashInPath) throws NullPointerException
      Specified by:
      resolveTemplate in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • resolveTemplateFromEncoded

      public JerseyWebTarget resolveTemplateFromEncoded(String name, Object value) throws NullPointerException
      Specified by:
      resolveTemplateFromEncoded in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • resolveTemplates

      public JerseyWebTarget resolveTemplates(Map<String,Object> templateValues) throws NullPointerException
      Specified by:
      resolveTemplates in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • resolveTemplates

      public JerseyWebTarget resolveTemplates(Map<String,Object> templateValues, boolean encodeSlashInPath) throws NullPointerException
      Specified by:
      resolveTemplates in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • resolveTemplatesFromEncoded

      public JerseyWebTarget resolveTemplatesFromEncoded(Map<String,Object> templateValues) throws NullPointerException
      Specified by:
      resolveTemplatesFromEncoded in interface javax.ws.rs.client.WebTarget
      Throws:
      NullPointerException

    • checkTemplateValues

      private void checkTemplateValues(Map<String,Object> templateValues) throws NullPointerException
      Check template values for null values. Throws NullPointerException if the name-value map or any of the names or encoded values in the map is null.
      Parameters:
      templateValues - map to check.
      Throws:
      NullPointerException - if the name-value map or any of the names or encoded values in the map is null.

    • register

      public JerseyWebTarget register(Class<?> providerClass)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • register

      public JerseyWebTarget register(Object provider)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • register

      public JerseyWebTarget register(Class<?> providerClass, int bindingPriority)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • register

      public JerseyWebTarget register(Class<?> providerClass, Class<?>... contracts)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • register

      public JerseyWebTarget register(Class<?> providerClass, Map<Class<?>,Integer> contracts)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • register

      public JerseyWebTarget register(Object provider, int bindingPriority)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • register

      public JerseyWebTarget register(Object provider, Class<?>... contracts)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • register

      public JerseyWebTarget register(Object provider, Map<Class<?>,Integer> contracts)
      Specified by:
      register in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • property

      public JerseyWebTarget property(String name, Object value)
      Specified by:
      property in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>

    • getConfiguration

      public ClientConfig getConfiguration()
      Description copied from interface: Initializable
      Get a live view of an internal client configuration state of this initializable instance.
      Specified by:
      getConfiguration in interface javax.ws.rs.core.Configurable<javax.ws.rs.client.WebTarget>
      Specified by:
      getConfiguration in interface Initializable<JerseyWebTarget>
      Returns:
      configuration live view of the internal configuration state.

    • preInitialize

      public JerseyWebTarget preInitialize()
      Description copied from interface: Initializable
      Pre-initializes the runtime and runtime configuration of this component in order to improve performance during the first request.

      Once this method is called no other method implementing Configurable should be called on this pre initialized component, otherwise the initialized client runtime will be discarded and the configuration will change back to uninitialized.

      Specified by:
      preInitialize in interface Initializable<JerseyWebTarget>
      Returns:
      pre-initialized Jersey client component.

    • toString

      public String toString()
      Overrides:
      toString in class Object