org.guzz.Service Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guzz Show documentation
A java full stack data-layer solution framework with many unique features.
The newest version!
/*
 * Copyright 2008-2009 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.guzz;

import org.guzz.service.ServiceChangeCommand;
import org.guzz.service.ServiceConfig;
import org.guzz.service.ServiceInfo;
import org.guzz.service.ServiceManager;
import org.guzz.web.context.ExtendedBeanFactory;
import org.guzz.web.context.ExtendedBeanFactoryAware;
import org.guzz.web.context.GuzzContextAware;

/**
 * 
 * Service用于模块化定义，Service一般为远程的服务，如数据库DataSource Service，过滤词Service，用户认证Service等。
 * Service的具体服务者可以运行在远程，也可以运行在本地。
 * 
 * 
 * Service bootstrap sequence：
 * 

 *  Class.forName(service class name).newInstance()
 *  Inject depended services
 *  set {@link GuzzContext} if the service implements {@link GuzzContextAware}
 *  call {@link #configure(ServiceConfig[])} to start the initialization
 *  call {@link #startup()}
 *  register the service to guzz's {@link ServiceManager} (where you can query the service by name).
 *  set {@link ExtendedBeanFactory} if the service implements {@link ExtendedBeanFactoryAware}
 * 
 *
 *
 * @author liukaixuan([email protected])
 */
public interface Service {
	
	public static final _FamousService FAMOUSE_SERVICE = new _FamousService() ;
	
	static class _FamousService{
		public final String MASTER_DATABASE = "guzzMasterDB" ;
		public final String SLAVE_DATABASE = "guzzSlaveDB" ;
		public final String GUZZ_DEBUG = "guzzDebug" ;
		public final String SLOW_UPDATE = "guzzSlowUpdate" ;
		public final String DYNAMIC_SQL = "guzzDynamicSQL" ;
		public final String TEMPLATED_SQL = "guzzTemplatedSQL" ;
	}
	
	/**
	 * 如果没有配置此项，@param scs 传入 new ServiceConfig[0]
	 * 
	 * @return 是否成功配置，返回true则继续执行startup，否则打印异常并跳过此服务的启动。
	 */
	public boolean configure(ServiceConfig[] scs) ;
	
	/**执行来自中心配置服务器的调整。如停用即将下线的服务器等。*/
	public void executeCommand(ServiceChangeCommand cmd) ;
	
	public ServiceInfo getServiceInfo() ;
	
	public void setServiceInfo(ServiceInfo serviceInfo) ;
	
	public boolean isAvailable() ;
	
	/**
	 * 初始化Service环境。调用此方法时，GuzzContext已经初始化完毕。
	 * 此方法在 {@link #configure(ServiceConfig[] scs)} 方法以及相关引用注入后执行。
	 * */
	public void startup() ;
	
	public void shutdown() ;
	
}