001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2017-2018 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.webconsole.provider.vuex;
020
021import freemarker.core.ParseException;
022import freemarker.template.MalformedTemplateNameException;
023import freemarker.template.TemplateNotFoundException;
024import java.io.IOException;
025import org.jgrapes.core.Channel;
026import org.jgrapes.core.Event;
027import org.jgrapes.core.Manager;
028import org.jgrapes.core.annotation.Handler;
029import org.jgrapes.webconsole.base.ConsoleConnection;
030import org.jgrapes.webconsole.base.PageResourceProvider;
031import org.jgrapes.webconsole.base.events.AddPageResources;
032import org.jgrapes.webconsole.base.events.AddPageResources.ScriptResource;
033import org.jgrapes.webconsole.base.events.ConsoleReady;
034
035/**
036 * Provider for the [Vuex](https://vuex.vuejs.org/guide/) library.
037 */
038public class VuexProvider extends PageResourceProvider {
039
040    /**
041     * Creates a new component with its channel set to the given 
042     * channel.
043     * 
044     * @param componentChannel the channel that the component's 
045     * handlers listen on by default and that 
046     * {@link Manager#fire(Event, Channel...)} sends the event to 
047     */
048    public VuexProvider(Channel componentChannel) {
049        super(componentChannel);
050    }
051
052    /**
053     * On {@link ConsoleReady}, fire the appropriate {@link AddPageResources}.
054     *
055     * @param event the event
056     * @param connection the web console connection
057     * @throws TemplateNotFoundException the template not found exception
058     * @throws MalformedTemplateNameException the malformed template name exception
059     * @throws ParseException the parse exception
060     * @throws IOException Signals that an I/O exception has occurred.
061     */
062    @Handler(priority = 100)
063    public void onConsoleReady(ConsoleReady event, ConsoleConnection connection)
064            throws TemplateNotFoundException, MalformedTemplateNameException,
065            ParseException, IOException {
066        connection.respond(new AddPageResources()
067            .addScriptResource(new ScriptResource()
068                .setProvides(new String[] { "vuex" })));
069    }
070}