org.nervousync.cache.annotation.CacheProvider Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Nervousync Studio (NSYC) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.nervousync.cache.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Cache provider annotation
 * 缓存适配器注解
 *
 * @author Steven Wee	[email protected]
 * @version $Revision: 1.0 $ $Date: 2018-12-26 17:23 $
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface CacheProvider {

	/**
	 * Provider name. Configure file using current name to identify provider
	 * 适配器名称，在配置文件中使用此名称识别适配器
	 *
	 * @return  Provider name
	 *          适配器名称
	 */
	String name();

	/**
	 * Default service port number. System using this value to connect cache server if configure file setting server_port is -1
	 * 默认服务端口号，如果配置文件中的服务器端口设置为-1，则系统使用此端口连接缓存服务器
	 *
	 * @return  Service port number
	 *          服务端口号
	 */
	int defaultPort();
}