grails.core.GrailsApplicationLifeCycle.groovy Maven / Gradle / Ivy
/*
* Copyright 2014-2023 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.core
/**
* API which plugins implement to provide behavior in defined application lifecycle hooks.
*
* The {@link GrailsApplicationLifeCycle#doWithSpring()} method can be used register Spring beans.
*
* @since 3.0
* @see {@link grails.plugins.Plugin}
*/
interface GrailsApplicationLifeCycle {
/**
* Sub classes should override to provide implementations
*
* @return A closure that defines beans to be registered by Spring
*/
Closure doWithSpring()
/**
* Invoked once the {@link org.springframework.context.ApplicationContext} has been refreshed in a phase
* where plugins can add dynamic methods. Subclasses should override
*/
void doWithDynamicMethods()
/**
* Invoked once the {@link org.springframework.context.ApplicationContext} has been refreshed
* and after {#doWithDynamicMethods()} is invoked. Subclasses should override
*/
void doWithApplicationContext()
/**
* Invoked when the application configuration changes
*
* @param event The event
*/
void onConfigChange(Map event)
/**
* Invoked once all prior initialization hooks: {@link GrailsApplicationLifeCycle#doWithSpring()},
* {@link GrailsApplicationLifeCycle#doWithDynamicMethods()} and {@link GrailsApplicationLifeCycle#doWithApplicationContext()}
*
* @param event The event
*/
void onStartup(Map event)
/**
* Invoked when the {@link org.springframework.context.ApplicationContext} is closed
*
* @param event The event
*/
void onShutdown(Map event)
}