HttpServletResponseExtension (Grails 5.1.8-SNAPSHOT)

org.grails.web.mime.HttpServletResponseExtension

```
@groovy.transform.CompileStatic
class HttpServletResponseExtension
extends java.lang.Object
```
Extends the HttpServletResponse object with new methods for handling MimeType instances
Authors:
Graeme Rocher
Since:
3.0

Properties Summary

Properties
Type	Name and description
`static MimeTypesApiSupport`	`apiSupport`
`static java.util.regex.Pattern`	`disableForUserAgents`
`static boolean`	`useAcceptHeader`
`static boolean`	`useAcceptHeaderXhr`

Constructor Summary

Constructors
Constructor and description
`HttpServletResponseExtension ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.lang.String`	`getFormat(javax.servlet.http.HttpServletResponse response)` Obtains the format to use for the response using either the file extension or the ACCEPT header
	`static MimeType`	`getMimeType(javax.servlet.http.HttpServletResponse response)` Obtains the MimeType for the response using either the file extension or the ACCEPT header
	`static MimeType[]`	`getMimeTypes()`
	`static MimeType[]`	`getMimeTypes(javax.servlet.http.HttpServletResponse response)` Gets the configured mime types for the response
	`static MimeType[]`	`getMimeTypesFormatAware(javax.servlet.http.HttpServletResponse response)` Gets the configured mime types for the response
	`static void`	`loadMimeTypeConfig(Config config)`
	`static java.lang.Object`	`withFormat(javax.servlet.http.HttpServletResponse response, groovy.lang.Closure callable)` Allows for the response.withFormat { } syntax

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static MimeTypesApiSupport apiSupport
  - static java.util.regex.Pattern disableForUserAgents
  - static boolean useAcceptHeader
  - static boolean useAcceptHeaderXhr
- Constructor Detail
  - HttpServletResponseExtension()
- Method Detail
  - @groovy.transform.CompileStatic static java.lang.String getFormat(javax.servlet.http.HttpServletResponse response)
    
    Obtains the format to use for the response using either the file extension or the ACCEPT header
    Parameters:
    response - The response
    Returns:
    The request format
  - @groovy.transform.CompileStatic static MimeType getMimeType(javax.servlet.http.HttpServletResponse response)
    
    Obtains the MimeType for the response using either the file extension or the ACCEPT header
    Parameters:
    response - The response
    Returns:
    The MimeType
  - @groovy.transform.CompileStatic static MimeType[] getMimeTypes()
  - static MimeType[] getMimeTypes(javax.servlet.http.HttpServletResponse response)
    
    Gets the configured mime types for the response
    Parameters:
    response - The response
    Returns:
    The configured mime types
  - static MimeType[] getMimeTypesFormatAware(javax.servlet.http.HttpServletResponse response)
    
    Gets the configured mime types for the response
    Parameters:
    response - The response
    Returns:
    The configured mime types
  - static void loadMimeTypeConfig(Config config)
  - static java.lang.Object withFormat(javax.servlet.http.HttpServletResponse response, groovy.lang.Closure callable)
    
    Allows for the response.withFormat { } syntax
    Parameters:
    response - The response
    callable - A closure
    Returns:
    The result of the closure call

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class HttpServletResponseExtension

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static MimeTypesApiSupport apiSupport

static java.util.regex.Pattern disableForUserAgents

static boolean useAcceptHeader

static boolean useAcceptHeaderXhr

Constructor Detail

HttpServletResponseExtension()

Method Detail

@groovy.transform.CompileStatic static java.lang.String getFormat(javax.servlet.http.HttpServletResponse response)

@groovy.transform.CompileStatic static MimeType getMimeType(javax.servlet.http.HttpServletResponse response)

@groovy.transform.CompileStatic static MimeType[] getMimeTypes()

static MimeType[] getMimeTypes(javax.servlet.http.HttpServletResponse response)

static MimeType[] getMimeTypesFormatAware(javax.servlet.http.HttpServletResponse response)

static void loadMimeTypeConfig(Config config)

static java.lang.Object withFormat(javax.servlet.http.HttpServletResponse response, groovy.lang.Closure callable)