Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD

## org.codehaus.groovy.grails.plugins.web.api
[Groovy] Class ResponseMimeTypesApi

    java.lang.Object
      org.codehaus.groovy.grails.plugins.web.api.ResponseMimeTypesApi

    class ResponseMimeTypesApi
    extends java.lang.Object

Methods added to javax.servlet.http.HttpServletResponse for response format handling.

Authors:
  Graeme Rocher

Since:
  2.0

Property Summary
`MimeTypesApiSupport` | `apiSupport`
`GrailsApplication` | `grailsApplication`
`MimeType` | `mimeTypes`

Constructor Summary
`ResponseMimeTypesApi()` Initialize with default settings
`ResponseMimeTypesApi(GrailsApplication grailsApplication, MimeType[] mimeTypes)` Initialize with settings provided by GrailsApplication and the given MimeType[]

Method Summary
`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
`MimeType[]` | `getMimeTypes()`
`MimeType[]` | `getMimeTypes(javax.servlet.http.HttpServletResponse response)` Gets the configured mime types for the response
`java.lang.Object` | `withFormat(javax.servlet.http.HttpServletResponse response, groovy.lang.Closure callable)` Allows for the response.withFormat { } syntax

Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), 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

### apiSupport

    MimeTypesApiSupport apiSupport

### grailsApplication

    GrailsApplication grailsApplication

### mimeTypes

    MimeType mimeTypes

Constructor Detail

### ResponseMimeTypesApi

    ResponseMimeTypesApi()

  Initialize with default settings

### ResponseMimeTypesApi

    ResponseMimeTypesApi(GrailsApplication grailsApplication, MimeType[] mimeTypes)

  Initialize with settings provided by GrailsApplication and the given MimeType[]
  Parameters:
    `grailsApplication` - The GrailsApplication
    `mimeTypes` - The mime types

Method Detail

### getFormat

    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

### getMimeTypes

    MimeType[] getMimeTypes()

### getMimeTypes

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

  Gets the configured mime types for the response
  Parameters:
    `response` - The response
  Returns:
    The configured mime types

### withFormat

    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

Groovy Documentation