GroovyMacro.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.internal.macro.groovy;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;
import javax.script.ScriptEngineFactory;

import org.xwiki.component.annotation.Component;
import org.xwiki.component.phase.InitializationException;
import org.xwiki.rendering.macro.descriptor.DefaultContentDescriptor;
import org.xwiki.rendering.macro.script.AbstractJSR223ScriptMacro;
import org.xwiki.rendering.macro.script.JSR223ScriptMacroParameters;

/**
 * Execute script in the provided script language.
 * 
 * @version $Id: 6e2a36e5f1b8852a908da40ea4b9445d421f2518 $
 * @since 1.7M3
 */
@Component
@Named("groovy")
@Singleton
public class GroovyMacro extends AbstractJSR223ScriptMacro<JSR223ScriptMacroParameters>
{
    /**
     * The description of the macro.
     */
    private static final String DESCRIPTION = "Execute a groovy script.";

    /**
     * The description of the macro content.
     */
    private static final String CONTENT_DESCRIPTION = "the groovy script to execute";

    /**
     * A specific XWiki Groovy Script Engine Factory.
     */
    @Inject
    @Named("groovy")
    private ScriptEngineFactory groovyScriptEngineFactory;

    /**
     * Create and initialize the descriptor of the macro.
     */
    public GroovyMacro()
    {
        super("Groovy", DESCRIPTION, new DefaultContentDescriptor(CONTENT_DESCRIPTION));
    }

    @Override
    public void initialize() throws InitializationException
    {
        super.initialize();

        // Register Groovy Compilation Customizers by registering the XWiki Groovy Script Engine Factory which extends
        // the default Groovy Script Engine Factory and registers Compilation Customizers.
        this.scriptEngineManager.registerEngineName("groovy", this.groovyScriptEngineFactory);
    }
}