com.gemstone.gemfire.internal.tools.gfsh.app.command.task.RegionCreateTask Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
The newest version!
/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.internal.tools.gfsh.app.command.task;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.cache.AttributesFactory;
import com.gemstone.gemfire.cache.Cache;
import com.gemstone.gemfire.cache.CacheException;
import com.gemstone.gemfire.cache.CacheFactory;
import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.distributed.DistributedMember;
import com.gemstone.gemfire.internal.tools.gfsh.app.command.task.data.MemberInfo;
import com.gemstone.gemfire.internal.tools.gfsh.app.command.task.data.RegionAttributeInfo;
import com.gemstone.gemfire.internal.tools.gfsh.app.misc.util.DataSerializerEx;
import com.gemstone.gemfire.internal.tools.gfsh.command.CommandResults;
import com.gemstone.gemfire.internal.tools.gfsh.command.CommandTask;
import com.gemstone.gemfire.internal.tools.gfsh.util.RegionUtil;

/**
 * 
 * RegionCreateTask creates a remote region. Invoke this class using
 * CommandClient.execute() or CommandClient.broadcast(). CommandClient.execute()
 * creates the specified region in the connected server only.
 * CommandClient.Broadcast() creates the specified region in all peers in the
 * distributed system. Both methods return CommandResults with the code set.
 * Check CommandResults.getCode() to see the task execution status.
 * RegionCreateTask.SUCCESS_CREATED for region successfully created,
 * RegionCreateTask.ERROR_... for an error creating region.
 * 
 * @author dpark
 * 
 */
public class RegionCreateTask implements CommandTask
{
	private static final long serialVersionUID = 1;

	public static final byte SUCCESS_CREATED = CommandResults.CODE_NORMAL;
	public static final byte ERROR_REGION_NOT_CREATED = 1;
	public static final byte ERROR_REGION_ALREADY_EXIST = 2;
	public static final byte ERROR_REGION_PARENT_DOES_NOT_EXIST = 3;
	public static final byte ERROR_REGION_INVALID_PATH = 4;

	private String regionFullPath;
	private RegionAttributeInfo attrInfo;

	public RegionCreateTask()
	{
	}

	/**
	 * Constructs a RegionCreateAllTask object using the default region attribute settings.
	 * @param regionFullPath The region path.
	 */
	public RegionCreateTask(String regionFullPath)
	{
		this(regionFullPath, null);
	}

	/**
	 * Constructs a RegionCreateAllTask object using the specified region attributes.
	 * @param regionFullPath The region path.
	 * @param attrInfo The region attributes. The attribute values are same as the cache.dtd values.
	 */
	public RegionCreateTask(String regionFullPath, RegionAttributeInfo attrInfo)
	{
		this.regionFullPath = regionFullPath;
		this.attrInfo = attrInfo;
	}

	public CommandResults runTask(Object userData)
	{
		return createRegion();
	}

	private CommandResults createRegion()
	{
		CommandResults results = new CommandResults();
		results.setCode(SUCCESS_CREATED);

		Cache cache = CacheFactory.getAnyInstance();
		MemberInfo memberInfo = new MemberInfo();
		DistributedMember member = cache.getDistributedSystem().getDistributedMember();
		memberInfo.setHost(member.getHost());
		memberInfo.setMemberId(member.getId());
		memberInfo.setMemberName(cache.getName());
		memberInfo.setPid(member.getProcessId());
		results.setDataObject(memberInfo);

		if (regionFullPath == null) {
			results.setCode(ERROR_REGION_INVALID_PATH);
			results.setCodeMessage("Invalid region path: " + regionFullPath);
			return results;
		}
		int index = regionFullPath.lastIndexOf("/");
		if (index == regionFullPath.length() - 1) {
			results.setCode(ERROR_REGION_INVALID_PATH);
			results.setCodeMessage("Invalid region path: " + regionFullPath);
			return results;
		}

		String regionName = regionFullPath.substring(index + 1);
		try {

			Region region = cache.getRegion(regionFullPath);
			if (region != null) {
				results.setCode(ERROR_REGION_ALREADY_EXIST);
				results.setCodeMessage("Region already exist: " + regionFullPath);
			} else {
				Region parentRegion = RegionUtil.getParentRegion(regionFullPath);
				if (parentRegion == null) {
					if (regionFullPath.split("/").length > 2) {
						results.setCode(ERROR_REGION_PARENT_DOES_NOT_EXIST);
						results.setCodeMessage("Parent region does not exist: " + regionFullPath);
					} else {
						if (attrInfo == null) {
							region = cache.createRegion(regionName, new AttributesFactory().create());
						} else {
							region = cache.createRegion(regionName, attrInfo.createRegionAttributes());
						}
						if (region == null) {
							results.setCode(ERROR_REGION_NOT_CREATED);
							results.setCodeMessage("Unable create region: " + regionFullPath);
						} else {
							results.setCodeMessage("Region created: " + region.getFullPath());
						}
					}
				} else {
					if (attrInfo == null) {
						region = parentRegion.createSubregion(regionName, new AttributesFactory().create());
					} else {
						region = parentRegion.createSubregion(regionName, attrInfo.createRegionAttributes());
					}
					if (region == null) {
						results.setCode(ERROR_REGION_NOT_CREATED);
						results.setCodeMessage("Unable create region: " + regionFullPath);
					} else {
						results.setCodeMessage("Region created: " + region.getFullPath());
					}
				}
			}
		} catch (CacheException ex) {
			results.setCode(ERROR_REGION_NOT_CREATED);
			results.setException(ex);
		}
		return results;
	}

	public void fromData(DataInput input) throws IOException, ClassNotFoundException
	{
		regionFullPath = DataSerializerEx.readUTF(input);
		attrInfo = (RegionAttributeInfo) DataSerializer.readObject(input);
	}

	public void toData(DataOutput output) throws IOException
	{
		DataSerializerEx.writeUTF(regionFullPath, output);
		DataSerializer.writeObject(attrInfo, output);
	}

}