Class OutboundJaxrsResponse.Builder

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response.ResponseBuilder allow​(java.lang.String... methods)  
      javax.ws.rs.core.Response.ResponseBuilder allow​(java.util.Set<java.lang.String> methods)  
      private void append​(java.lang.StringBuilder sb, boolean v, java.lang.String s)  
      javax.ws.rs.core.Response build()  
      javax.ws.rs.core.Response.ResponseBuilder cacheControl​(javax.ws.rs.core.CacheControl cacheControl)  
      static void clearBaseUri()
      Remove the current thread's value for baseUri thread-local variable (set by setBaseUri(java.net.URI)).
      javax.ws.rs.core.Response.ResponseBuilder clone()  
      javax.ws.rs.core.Response.ResponseBuilder contentLocation​(java.net.URI location)  
      javax.ws.rs.core.Response.ResponseBuilder cookie​(javax.ws.rs.core.NewCookie... cookies)  
      javax.ws.rs.core.Response.ResponseBuilder encoding​(java.lang.String encoding)  
      javax.ws.rs.core.Response.ResponseBuilder entity​(java.lang.Object entity)  
      javax.ws.rs.core.Response.ResponseBuilder entity​(java.lang.Object entity, java.lang.annotation.Annotation[] annotations)  
      javax.ws.rs.core.Response.ResponseBuilder expires​(java.util.Date expires)  
      private static java.net.URI getBaseUri()
      Return request baseUri previously set by setBaseUri(java.net.URI).
      javax.ws.rs.core.Response.ResponseBuilder header​(java.lang.String name, java.lang.Object value)  
      private javax.ws.rs.core.Response.ResponseBuilder header​(java.lang.String name, java.lang.Object value, boolean single)  
      private javax.ws.rs.core.Response.ResponseBuilder headerSingle​(java.lang.String name, java.lang.Object value)  
      javax.ws.rs.core.Response.ResponseBuilder language​(java.lang.String language)  
      javax.ws.rs.core.Response.ResponseBuilder language​(java.util.Locale language)  
      javax.ws.rs.core.Response.ResponseBuilder lastModified​(java.util.Date lastModified)  
      javax.ws.rs.core.Response.ResponseBuilder link​(java.lang.String uri, java.lang.String rel)  
      javax.ws.rs.core.Response.ResponseBuilder link​(java.net.URI uri, java.lang.String rel)  
      javax.ws.rs.core.Response.ResponseBuilder links​(javax.ws.rs.core.Link... links)  
      javax.ws.rs.core.Response.ResponseBuilder location​(java.net.URI location)  
      javax.ws.rs.core.Response.ResponseBuilder replaceAll​(javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.Object> headers)  
      static void setBaseUri​(java.net.URI baseUri)
      Set the baseUri of the actual request into the InheritableThreadLocal.
      javax.ws.rs.core.Response.ResponseBuilder status​(int code)  
      javax.ws.rs.core.Response.ResponseBuilder status​(int status, java.lang.String reasonPhrase)  
      javax.ws.rs.core.Response.ResponseBuilder status​(javax.ws.rs.core.Response.StatusType status)  
      javax.ws.rs.core.Response.ResponseBuilder tag​(java.lang.String tag)  
      javax.ws.rs.core.Response.ResponseBuilder tag​(javax.ws.rs.core.EntityTag tag)  
      javax.ws.rs.core.Response.ResponseBuilder type​(java.lang.String type)  
      javax.ws.rs.core.Response.ResponseBuilder type​(javax.ws.rs.core.MediaType type)  
      javax.ws.rs.core.Response.ResponseBuilder variant​(javax.ws.rs.core.Variant variant)  
      javax.ws.rs.core.Response.ResponseBuilder variants​(java.util.List<javax.ws.rs.core.Variant> variants)  
      javax.ws.rs.core.Response.ResponseBuilder variants​(javax.ws.rs.core.Variant... variants)  
      private boolean vary​(java.lang.String v, java.lang.String vary)  
      private boolean vary​(java.util.Locale v, java.util.Locale vary)  
      private boolean vary​(javax.ws.rs.core.MediaType v, javax.ws.rs.core.MediaType vary)  
      • Methods inherited from class javax.ws.rs.core.Response.ResponseBuilder

        newInstance, status
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • status

        private javax.ws.rs.core.Response.StatusType status
      • baseUriThreadLocal

        private static final java.lang.InheritableThreadLocal<java.net.URI> baseUriThreadLocal
    • Constructor Detail

      • Builder

        public Builder​(OutboundMessageContext context)
        Create new outbound JAX-RS response builder.
        Parameters:
        context - underlying outbound message context.
    • Method Detail

      • setBaseUri

        public static void setBaseUri​(java.net.URI baseUri)
        Set the baseUri of the actual request into the InheritableThreadLocal.

        The baseUri will be used for absolutizing the location header content in case that only a relative URI is provided.

        After resource method invocation when the value is not needed any more to be stored in ThreadLocal clearBaseUri() should be called for cleanup in order to prevent possible memory leaks.

        Parameters:
        baseUri - - baseUri of the actual request
        Since:
        2.4
        See Also:
        location(java.net.URI)
      • getBaseUri

        private static java.net.URI getBaseUri()
        Return request baseUri previously set by setBaseUri(java.net.URI). Returned URI is used for absolutization of the location header in case that only a relative URI was provided.
        Returns:
        baseUri of the actual request
        Since:
        2.4
        See Also:
        location(java.net.URI)
      • clearBaseUri

        public static void clearBaseUri()
        Remove the current thread's value for baseUri thread-local variable (set by setBaseUri(java.net.URI)). Should be called after resource method invocation for cleanup.
        Since:
        2.4
        See Also:
        location(java.net.URI)
      • build

        public javax.ws.rs.core.Response build()
        Specified by:
        build in class javax.ws.rs.core.Response.ResponseBuilder
      • clone

        public javax.ws.rs.core.Response.ResponseBuilder clone()
        Specified by:
        clone in class javax.ws.rs.core.Response.ResponseBuilder
      • status

        public javax.ws.rs.core.Response.ResponseBuilder status​(javax.ws.rs.core.Response.StatusType status)
        Overrides:
        status in class javax.ws.rs.core.Response.ResponseBuilder
      • status

        public javax.ws.rs.core.Response.ResponseBuilder status​(int status,
                                                                java.lang.String reasonPhrase)
        Specified by:
        status in class javax.ws.rs.core.Response.ResponseBuilder
      • status

        public javax.ws.rs.core.Response.ResponseBuilder status​(int code)
        Specified by:
        status in class javax.ws.rs.core.Response.ResponseBuilder
      • entity

        public javax.ws.rs.core.Response.ResponseBuilder entity​(java.lang.Object entity)
        Specified by:
        entity in class javax.ws.rs.core.Response.ResponseBuilder
      • entity

        public javax.ws.rs.core.Response.ResponseBuilder entity​(java.lang.Object entity,
                                                                java.lang.annotation.Annotation[] annotations)
        Specified by:
        entity in class javax.ws.rs.core.Response.ResponseBuilder
      • type

        public javax.ws.rs.core.Response.ResponseBuilder type​(javax.ws.rs.core.MediaType type)
        Specified by:
        type in class javax.ws.rs.core.Response.ResponseBuilder
      • type

        public javax.ws.rs.core.Response.ResponseBuilder type​(java.lang.String type)
        Specified by:
        type in class javax.ws.rs.core.Response.ResponseBuilder
      • variant

        public javax.ws.rs.core.Response.ResponseBuilder variant​(javax.ws.rs.core.Variant variant)
        Specified by:
        variant in class javax.ws.rs.core.Response.ResponseBuilder
      • variants

        public javax.ws.rs.core.Response.ResponseBuilder variants​(java.util.List<javax.ws.rs.core.Variant> variants)
        Specified by:
        variants in class javax.ws.rs.core.Response.ResponseBuilder
      • vary

        private boolean vary​(javax.ws.rs.core.MediaType v,
                             javax.ws.rs.core.MediaType vary)
      • vary

        private boolean vary​(java.util.Locale v,
                             java.util.Locale vary)
      • vary

        private boolean vary​(java.lang.String v,
                             java.lang.String vary)
      • append

        private void append​(java.lang.StringBuilder sb,
                            boolean v,
                            java.lang.String s)
      • language

        public javax.ws.rs.core.Response.ResponseBuilder language​(java.lang.String language)
        Specified by:
        language in class javax.ws.rs.core.Response.ResponseBuilder
      • language

        public javax.ws.rs.core.Response.ResponseBuilder language​(java.util.Locale language)
        Specified by:
        language in class javax.ws.rs.core.Response.ResponseBuilder
      • location

        public javax.ws.rs.core.Response.ResponseBuilder location​(java.net.URI location)
        Specified by:
        location in class javax.ws.rs.core.Response.ResponseBuilder
      • contentLocation

        public javax.ws.rs.core.Response.ResponseBuilder contentLocation​(java.net.URI location)
        Specified by:
        contentLocation in class javax.ws.rs.core.Response.ResponseBuilder
      • encoding

        public javax.ws.rs.core.Response.ResponseBuilder encoding​(java.lang.String encoding)
        Specified by:
        encoding in class javax.ws.rs.core.Response.ResponseBuilder
      • tag

        public javax.ws.rs.core.Response.ResponseBuilder tag​(javax.ws.rs.core.EntityTag tag)
        Specified by:
        tag in class javax.ws.rs.core.Response.ResponseBuilder
      • tag

        public javax.ws.rs.core.Response.ResponseBuilder tag​(java.lang.String tag)
        Specified by:
        tag in class javax.ws.rs.core.Response.ResponseBuilder
      • lastModified

        public javax.ws.rs.core.Response.ResponseBuilder lastModified​(java.util.Date lastModified)
        Specified by:
        lastModified in class javax.ws.rs.core.Response.ResponseBuilder
      • cacheControl

        public javax.ws.rs.core.Response.ResponseBuilder cacheControl​(javax.ws.rs.core.CacheControl cacheControl)
        Specified by:
        cacheControl in class javax.ws.rs.core.Response.ResponseBuilder
      • expires

        public javax.ws.rs.core.Response.ResponseBuilder expires​(java.util.Date expires)
        Specified by:
        expires in class javax.ws.rs.core.Response.ResponseBuilder
      • cookie

        public javax.ws.rs.core.Response.ResponseBuilder cookie​(javax.ws.rs.core.NewCookie... cookies)
        Specified by:
        cookie in class javax.ws.rs.core.Response.ResponseBuilder
      • header

        public javax.ws.rs.core.Response.ResponseBuilder header​(java.lang.String name,
                                                                java.lang.Object value)
        Specified by:
        header in class javax.ws.rs.core.Response.ResponseBuilder
      • headerSingle

        private javax.ws.rs.core.Response.ResponseBuilder headerSingle​(java.lang.String name,
                                                                       java.lang.Object value)
      • header

        private javax.ws.rs.core.Response.ResponseBuilder header​(java.lang.String name,
                                                                 java.lang.Object value,
                                                                 boolean single)
      • variants

        public javax.ws.rs.core.Response.ResponseBuilder variants​(javax.ws.rs.core.Variant... variants)
        Specified by:
        variants in class javax.ws.rs.core.Response.ResponseBuilder
      • links

        public javax.ws.rs.core.Response.ResponseBuilder links​(javax.ws.rs.core.Link... links)
        Specified by:
        links in class javax.ws.rs.core.Response.ResponseBuilder
      • link

        public javax.ws.rs.core.Response.ResponseBuilder link​(java.net.URI uri,
                                                              java.lang.String rel)
        Specified by:
        link in class javax.ws.rs.core.Response.ResponseBuilder
      • link

        public javax.ws.rs.core.Response.ResponseBuilder link​(java.lang.String uri,
                                                              java.lang.String rel)
        Specified by:
        link in class javax.ws.rs.core.Response.ResponseBuilder
      • allow

        public javax.ws.rs.core.Response.ResponseBuilder allow​(java.lang.String... methods)
        Specified by:
        allow in class javax.ws.rs.core.Response.ResponseBuilder
      • allow

        public javax.ws.rs.core.Response.ResponseBuilder allow​(java.util.Set<java.lang.String> methods)
        Specified by:
        allow in class javax.ws.rs.core.Response.ResponseBuilder
      • replaceAll

        public javax.ws.rs.core.Response.ResponseBuilder replaceAll​(javax.ws.rs.core.MultivaluedMap<java.lang.String,​java.lang.Object> headers)
        Specified by:
        replaceAll in class javax.ws.rs.core.Response.ResponseBuilder