grails.plugins.DynamicPlugin.groovy Maven / Gradle / Ivy

Go to download

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

Grace Framework : Grace Plugin Api

The newest version!

/*
 * Copyright 2021-2024 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 grails.plugins

import groovy.transform.CompileStatic

/**
 * A dynamic plugin is one that can be loaded into an application and used without restarting the application.
 * Plugin implementations should define the plugin hooks doWithDynamicModules.
 *
 * @author Michael Yan
 * @since 2022.0.0
 */
@CompileStatic
abstract class DynamicPlugin extends Plugin {

    /**
     * Invoked in a phase where plugins can add dynamic modules.
     * Subclasses should override
     */
    Closure doWithDynamicModules() {
        // TODO Implement registering dynamic modules to application (optional)
        null
    }

}