McastConfiguration.java

/*
 * Copyright 2012 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.springframework.data.gemfire.config.annotation;

import java.util.Map;
import java.util.Properties;

import org.springframework.data.gemfire.config.annotation.support.EmbeddedServiceConfigurationSupport;
import org.springframework.data.gemfire.util.PropertiesBuilder;

/**
 * The {@link McastConfiguration} class is a Spring {@link org.springframework.context.annotation.ImportBeanDefinitionRegistrar}
 * that applies additional GemFire configuration by way of GemFire System properties to configure and use
 * multi-cast networking for GemFire communication and distribution rather than the (preferred)
 * Locator-based location services.
 *
 * @author John Blum
 * @see org.springframework.data.gemfire.config.annotation.EnableMcast
 * @see org.springframework.data.gemfire.config.annotation.support.EmbeddedServiceConfigurationSupport
 * @since 1.9.0
 */
public class McastConfiguration extends EmbeddedServiceConfigurationSupport {

	public static final int DEFAULT_MCAST_PORT = 10334;
	public static final int DEFAULT_MCAST_RECEIVE_BUFFER_SIZE = 1048576;
	public static final int DEFAULT_MCAST_SEND_BUFFER_SIZE = 65535;

	public static final String DEFAULT_MCAST_ADDRESS = "239.192.81.1";
	public static final String DEFAULT_MCAST_FLOW_CONTROL = "1048576,0.25,5000";

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected Class getAnnotationType() {
		return EnableMcast.class;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected Properties toGemFireProperties(Map<String, Object> annotationAttributes) {
		PropertiesBuilder gemfireProperties = PropertiesBuilder.create();

		gemfireProperties.unsetProperty("locators");

		gemfireProperties.setPropertyIfNotDefault("mcast-address",
			annotationAttributes.get("address"), DEFAULT_MCAST_ADDRESS);

		gemfireProperties.setPropertyIfNotDefault("mcast-flow-control",
			annotationAttributes.get("flowControl"), DEFAULT_MCAST_FLOW_CONTROL);

		gemfireProperties.setPropertyIfNotDefault("mcast-port", annotationAttributes.get("port"), DEFAULT_MCAST_PORT);

		gemfireProperties.setPropertyIfNotDefault("mcast-recv-buffer-size",
			annotationAttributes.get("receiveBufferSize"), DEFAULT_MCAST_RECEIVE_BUFFER_SIZE);

		gemfireProperties.setPropertyIfNotDefault("mcast-send-buffer-size",
			annotationAttributes.get("sendBufferSize"), DEFAULT_MCAST_SEND_BUFFER_SIZE);

		return gemfireProperties.build();
	}
}