org.compass.spring.web.mvc.AbstractCompassCommandController Maven / Gradle / Ivy
Show all versions of compass Show documentation
/*
* Copyright 2004-2006 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 org.compass.spring.web.mvc;
import org.compass.core.Compass;
import org.compass.core.CompassTemplate;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.web.servlet.mvc.AbstractCommandController;
/**
* A general base class for Spring's MVC Command Controllers that use
* Compass.
*
* Expects Compass instance to be injected, and provides access
* to both Compass and CompassTemplate instances.
*
* @author kimchy
*/
public abstract class AbstractCompassCommandController extends AbstractCommandController implements InitializingBean {
private Compass compass;
private CompassTemplate compassTemplate;
public void afterPropertiesSet() throws Exception {
if (compass == null) {
throw new IllegalArgumentException("Must set compass property");
}
this.compassTemplate = new CompassTemplate(compass);
}
/**
* Returns Compass instance.
*
* @return The compass instance.
*/
public Compass getCompass() {
return compass;
}
/**
* Sets the Compass instance.
*
* @param compass
*/
public void setCompass(Compass compass) {
this.compass = compass;
}
/**
* Returns a CompassTemplate that wraps the injected
* Compass instance.
*
* @return Compass template that wraps the injected Compass instance.
*/
protected CompassTemplate getCompassTemplate() {
return this.compassTemplate;
}
}