Class 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 java.lang.Object
    implements javax.ws.rs.client.WebTarget, Initializable<JerseyWebTarget>
    Jersey implementation of JAX-RS client target contract.
    • Field Detail

      • targetUri

        private final javax.ws.rs.core.UriBuilder targetUri
    • Constructor Detail

      • JerseyWebTarget

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

        JerseyWebTarget​(java.net.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 Detail

      • getUri

        public java.net.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​(java.lang.String path)
                             throws java.lang.NullPointerException
        Specified by:
        path in interface javax.ws.rs.client.WebTarget
        Throws:
        java.lang.NullPointerException
      • matrixParam

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

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

        private static javax.ws.rs.core.UriBuilder setQueryParam​(javax.ws.rs.core.UriBuilder uriBuilder,
                                                                 java.lang.String name,
                                                                 java.lang.Object[] values)
      • checkForNullValues

        private static void checkForNullValues​(java.lang.String name,
                                               java.lang.Object[] values)
      • request

        public JerseyInvocation.Builder request​(java.lang.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​(java.lang.String name,
                                               java.lang.Object value)
                                        throws java.lang.NullPointerException
        Specified by:
        resolveTemplate in interface javax.ws.rs.client.WebTarget
        Throws:
        java.lang.NullPointerException
      • resolveTemplate

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

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

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

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

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

        private void checkTemplateValues​(java.util.Map<java.lang.String,​java.lang.Object> templateValues)
                                  throws java.lang.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:
        java.lang.NullPointerException - if the name-value map or any of the names or encoded values in the map is null.
      • register

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

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

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

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

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

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

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

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

        public JerseyWebTarget property​(java.lang.String name,
                                        java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object