org.grails.plugins.converters.ConvertersGrailsPlugin.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grace-plugin-converters Show documentation

Grace Framework : Grace Plugin Converters

There is a newer version: 2023.2.0-M1

Show newest version

/*
 * Copyright 2004-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.grails.plugins.converters

import org.springframework.core.PriorityOrdered

import grails.converters.JSON
import grails.converters.XML
import grails.plugins.Plugin
import grails.util.GrailsUtil

import org.grails.plugins.codecs.JSONCodec
import org.grails.plugins.codecs.XMLCodec
import org.grails.web.converters.configuration.ConvertersConfigurationInitializer
import org.grails.web.converters.configuration.ObjectMarshallerRegisterer
import org.grails.web.converters.marshaller.json.ValidationErrorsMarshaller as JsonErrorsMarshaller
import org.grails.web.converters.marshaller.xml.ValidationErrorsMarshaller as XmlErrorsMarshaller

/**
 * Allows the "obj as XML" and "obj as JSON" syntax.
 *
 * @author Siegfried Puchbauer
 * @author Graeme Rocher
 *
 * @since 0.6
 */
class ConvertersGrailsPlugin extends Plugin implements PriorityOrdered {

    def version = GrailsUtil.getGrailsVersion()
    def observe = ['controllers']
    def dependsOn = [controllers: version]
    def providedArtefacts = [
            JSONCodec,
            XMLCodec
    ]

    @Override
    Closure doWithSpring() {
        { ->
            jsonErrorsMarshaller(JsonErrorsMarshaller)

            xmlErrorsMarshaller(XmlErrorsMarshaller)

            convertersConfigurationInitializer(ConvertersConfigurationInitializer)

            errorsXmlMarshallerRegisterer(ObjectMarshallerRegisterer) {
                marshaller = { XmlErrorsMarshaller om -> }
                converterClass = XML
            }

            errorsJsonMarshallerRegisterer(ObjectMarshallerRegisterer) {
                marshaller = { JsonErrorsMarshaller om -> }
                converterClass = JSON
            }
        }
    }

    @Override
    int getOrder() {
        60
    }

}