HttpServletResponseExtension (Grails 4.1.0.M1)

org.grails.web.mime.HttpServletResponseExtension

Extends the HttpServletResponse object with new methods for handling MimeType instances
Authors:
Graeme Rocher
Since:
3.0

Properties Summary

Properties
Type	Name and description
`private static MimeTypesApiSupport`	`apiSupport`
`private static java.util.regex.Pattern`	`disableForUserAgents`
`private static boolean`	`useAcceptHeader`
`private 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(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
	`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
	`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 java.lang.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

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
  - private static MimeTypesApiSupport apiSupport
  - private static java.util.regex.Pattern disableForUserAgents
  - private static boolean useAcceptHeader
  - private static boolean useAcceptHeaderXhr
- Constructor Detail
  - HttpServletResponseExtension()
- Method Detail
  - @groovy.transform.CompileStaticCompileStatic static java.lang.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
  - @groovy.transform.CompileStaticCompileStatic 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
  - @groovy.transform.CompileStaticCompileStatic 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 java.lang.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

private static MimeTypesApiSupport apiSupport

private static java.util.regex.Pattern disableForUserAgents

private static boolean useAcceptHeader

private static boolean useAcceptHeaderXhr

Constructor Detail

HttpServletResponseExtension()

Method Detail

@groovy.transform.CompileStaticCompileStatic static java.lang.String getFormat(HttpServletResponse response)

@groovy.transform.CompileStaticCompileStatic static MimeType getMimeType(HttpServletResponse response)

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

static MimeType[] getMimeTypes(HttpServletResponse response)

static MimeType[] getMimeTypesFormatAware(HttpServletResponse response)

static void loadMimeTypeConfig(Config config)

static java.lang.Object withFormat(HttpServletResponse response, Closure callable)