com.foreach.across.modules.debugweb.DebugWebModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of debug-web-module Show documentation

Debug Web Module

The newest version!

/*
 * Copyright 2014 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
 *
 * http://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 com.foreach.across.modules.debugweb;

import com.foreach.across.core.AcrossModule;
import com.foreach.across.core.annotations.AcrossDepends;
import com.foreach.across.core.context.configurer.ApplicationContextConfigurer;
import com.foreach.across.core.context.configurer.ComponentScanConfigurer;
import com.foreach.across.modules.web.AcrossWebModule;

import java.util.Set;

@AcrossDepends(required = AcrossWebModule.NAME)
public class DebugWebModule extends AcrossModule
{
	public static final String NAME = "DebugWebModule";
	public static final String RESOURCES = "debugweb";

	/**
	 * Set the root path that all {@link com.foreach.across.modules.debugweb.mvc.DebugWebController} instances should use.
	 * All request mappings will be prefixed with the path specified here.
	 *
	 * @param rootPath The root path for all DebugWebControllers.
	 * @see org.springframework.web.bind.annotation.RequestMapping
	 */
	public void setRootPath( String rootPath ) {
		setProperty( "debugWebModule.root-path", rootPath );
	}

	@Override
	public String getName() {
		return NAME;
	}

	@Override
	public String getResourcesKey() {
		return RESOURCES;
	}

	@Override
	public String getDescription() {
		return "Provides a debug web path and functionality to easily register additional debug controllers.";
	}

	@Override
	protected void registerDefaultApplicationContextConfigurers( Set contextConfigurers ) {
		contextConfigurers.add( ComponentScanConfigurer.forAcrossModule( DebugWebModule.class ) );
	}
}