Package org.glassfish.jersey.message.internal

Class OutboundJaxrsResponse.Builder

java.lang.Object
javax.ws.rs.core.Response.ResponseBuilder
org.glassfish.jersey.message.internal.OutboundJaxrsResponse.Builder
Enclosing class:
OutboundJaxrsResponse
public static class OutboundJaxrsResponse.Builder extends javax.ws.rs.core.Response.ResponseBuilder
Outbound JAX-RS Response.ResponseBuilder implementation. The implementation delegates method calls to an underlying outbound message context. Upon a call to a build() method a new instance of OutboundJaxrsResponse is produced.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private static final InheritableThreadLocal<URI>
    baseUriThreadLocal
     
    private final OutboundMessageContext
    context
     
    private javax.ws.rs.core.Response.StatusType
    status
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Builder(OutboundMessageContext context)
    Create new outbound JAX-RS response builder.

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.Response.ResponseBuilder
    allow(String... methods)
     
    javax.ws.rs.core.Response.ResponseBuilder
    allow(Set<String> methods)
     
    private void
    append(StringBuilder sb, boolean v, 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(URI location)
     
    javax.ws.rs.core.Response.ResponseBuilder
    cookie(javax.ws.rs.core.NewCookie... cookies)
     
    javax.ws.rs.core.Response.ResponseBuilder
    encoding(String encoding)
     
    javax.ws.rs.core.Response.ResponseBuilder
    entity(Object entity)
     
    javax.ws.rs.core.Response.ResponseBuilder
    entity(Object entity, Annotation[] annotations)
     
    javax.ws.rs.core.Response.ResponseBuilder
    expires(Date expires)
     
    private static URI
    getBaseUri()
    Return request baseUri previously set by setBaseUri(java.net.URI).
    javax.ws.rs.core.Response.ResponseBuilder
    header(String name, Object value)
     
    private javax.ws.rs.core.Response.ResponseBuilder
    header(String name, Object value, boolean single)
     
    private javax.ws.rs.core.Response.ResponseBuilder
    headerSingle(String name, Object value)
     
    javax.ws.rs.core.Response.ResponseBuilder
    language(String language)
     
    javax.ws.rs.core.Response.ResponseBuilder
    language(Locale language)
     
    javax.ws.rs.core.Response.ResponseBuilder
    lastModified(Date lastModified)
     
    javax.ws.rs.core.Response.ResponseBuilder
    link(String uri, String rel)
     
    javax.ws.rs.core.Response.ResponseBuilder
    link(URI uri, String rel)
     
    javax.ws.rs.core.Response.ResponseBuilder
    links(javax.ws.rs.core.Link... links)
     
    javax.ws.rs.core.Response.ResponseBuilder
    location(URI location)
     
    javax.ws.rs.core.Response.ResponseBuilder
    replaceAll(javax.ws.rs.core.MultivaluedMap<String,Object> headers)
     
    static void
    setBaseUri(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, String reasonPhrase)
     
    javax.ws.rs.core.Response.ResponseBuilder
    status(javax.ws.rs.core.Response.StatusType status)
     
    javax.ws.rs.core.Response.ResponseBuilder
    tag(String tag)
     
    javax.ws.rs.core.Response.ResponseBuilder
    tag(javax.ws.rs.core.EntityTag tag)
     
    javax.ws.rs.core.Response.ResponseBuilder
    type(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(List<javax.ws.rs.core.Variant> variants)
     
    javax.ws.rs.core.Response.ResponseBuilder
    variants(javax.ws.rs.core.Variant... variants)
     
    private boolean
    vary(String v, String vary)
     
    private boolean
    vary(Locale v, 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 Details

  • Constructor Details

    • Builder

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

  • Method Details

    • setBaseUri

      public static void setBaseUri(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:

    • getBaseUri

      private static 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:

    • 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:

    • 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, 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(Object entity)
      Specified by:
      entity in class javax.ws.rs.core.Response.ResponseBuilder

    • entity

      public javax.ws.rs.core.Response.ResponseBuilder entity(Object entity, 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(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(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(Locale v, Locale vary)

    • vary

      private boolean vary(String v, String vary)

    • append

      private void append(StringBuilder sb, boolean v, String s)

    • language

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

    • language

      public javax.ws.rs.core.Response.ResponseBuilder language(Locale language)
      Specified by:
      language in class javax.ws.rs.core.Response.ResponseBuilder

    • location

      public javax.ws.rs.core.Response.ResponseBuilder location(URI location)
      Specified by:
      location in class javax.ws.rs.core.Response.ResponseBuilder

    • contentLocation

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

    • encoding

      public javax.ws.rs.core.Response.ResponseBuilder encoding(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(String tag)
      Specified by:
      tag in class javax.ws.rs.core.Response.ResponseBuilder

    • lastModified

      public javax.ws.rs.core.Response.ResponseBuilder lastModified(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(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(String name, Object value)
      Specified by:
      header in class javax.ws.rs.core.Response.ResponseBuilder

    • headerSingle

      private javax.ws.rs.core.Response.ResponseBuilder headerSingle(String name, Object value)

    • header

      private javax.ws.rs.core.Response.ResponseBuilder header(String name, 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(URI uri, String rel)
      Specified by:
      link in class javax.ws.rs.core.Response.ResponseBuilder

    • link

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

    • allow

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

    • allow

      public javax.ws.rs.core.Response.ResponseBuilder allow(Set<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<String,Object> headers)
      Specified by:
      replaceAll in class javax.ws.rs.core.Response.ResponseBuilder