HttpServletResponseExtension (Grace Framework

org.grails.web.mime.HttpServletResponseExtension

```
@CompileStatic
class HttpServletResponseExtension
extends 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 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 String`	`getFormat(HttpServletResponse response)` Obtains the format to use for the response using either the file extension or the ACCEPT header
	`static MimeType`	`getMimeType(HttpServletResponse response)` Obtains the MimeType for the response using either the file extension or the ACCEPT header
	`static MimeType[]`	`getMimeTypes()`
	`static MimeType[]`	`getMimeTypes(HttpServletResponse response)` Gets the configured mime types for the response
	`static MimeType[]`	`getMimeTypesFormatAware(HttpServletResponse response)` Gets the configured mime types for the response
	`static void`	`loadMimeTypeConfig(Config config)`
	`static Object`	`withFormat(HttpServletResponse response, Closure callable)` Allows for the response.withFormat { } syntax

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Property Detail
  - static MimeTypesApiSupport apiSupport
  - static Pattern disableForUserAgents
  - static boolean useAcceptHeader
  - static boolean useAcceptHeaderXhr
- Constructor Detail
  - HttpServletResponseExtension()
- Method Detail
  - @CompileStatic
    static String getFormat(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
  - @CompileStatic
    static MimeType getMimeType(HttpServletResponse response)
    
    Obtains the MimeType for the response using either the file extension or the ACCEPT header
    Parameters:
    response - The response
    Returns:
    The MimeType
  - @CompileStatic
    static MimeType[] getMimeTypes()
  - static MimeType[] getMimeTypes(HttpServletResponse response)
    
    Gets the configured mime types for the response
    Parameters:
    response - The response
    Returns:
    The configured mime types
  - static MimeType[] getMimeTypesFormatAware(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 Object withFormat(HttpServletResponse response, 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] Class HttpServletResponseExtension

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static MimeTypesApiSupport apiSupport

static Pattern disableForUserAgents

static boolean useAcceptHeader

static boolean useAcceptHeaderXhr

Constructor Detail

HttpServletResponseExtension()

Method Detail

@CompileStatic
static String getFormat(HttpServletResponse response)

@CompileStatic
static MimeType getMimeType(HttpServletResponse response)

@CompileStatic
static MimeType[] getMimeTypes()

static MimeType[] getMimeTypes(HttpServletResponse response)

static MimeType[] getMimeTypesFormatAware(HttpServletResponse response)

static void loadMimeTypeConfig(Config config)

static Object withFormat(HttpServletResponse response, Closure callable)

[Groovy] Class HttpServletResponseExtension

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static MimeTypesApiSupport apiSupport

static Pattern disableForUserAgents

static boolean useAcceptHeader

static boolean useAcceptHeaderXhr

Constructor Detail

HttpServletResponseExtension()

Method Detail

@CompileStaticstatic String getFormat(HttpServletResponse response)

@CompileStaticstatic MimeType getMimeType(HttpServletResponse response)

@CompileStaticstatic MimeType[] getMimeTypes()

static MimeType[] getMimeTypes(HttpServletResponse response)

static MimeType[] getMimeTypesFormatAware(HttpServletResponse response)

static void loadMimeTypeConfig(Config config)

static Object withFormat(HttpServletResponse response, Closure callable)

@CompileStatic
static String getFormat(HttpServletResponse response)

@CompileStatic
static MimeType getMimeType(HttpServletResponse response)

@CompileStatic
static MimeType[] getMimeTypes()