/**
 * This file is part of the CRISTAL-iSE kernel.
 * Copyright (c) 2001-2014 The CRISTAL Consortium. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * http://www.fsf.org/licensing/licenses/lgpl.html
 */
package com.c2kernel.lifecycle.instance.predefined.agent;

import com.c2kernel.common.AccessRightsException;
import com.c2kernel.common.InvalidDataException;
import com.c2kernel.common.ObjectAlreadyExistsException;
import com.c2kernel.common.ObjectNotFoundException;
import com.c2kernel.entity.CorbaServer;
import com.c2kernel.entity.agent.ActiveEntity;
import com.c2kernel.lifecycle.instance.predefined.item.CreateItemFromDescription;
import com.c2kernel.lookup.AgentPath;
import com.c2kernel.lookup.ItemPath;
import com.c2kernel.lookup.RolePath;
import com.c2kernel.process.Gateway;
import com.c2kernel.property.PropertyArrayList;
import com.c2kernel.utils.Logger;

/**************************************************************************
 *
 * @author $Author: abranson $ $Date: 2005/10/13 08:13:58 $
 * @version $Revision: 1.47 $
 **************************************************************************/
public class CreateAgentFromDescription extends CreateItemFromDescription
{
	public CreateAgentFromDescription()
	{
		super();
	}

	/**
	 * Params:
	 * <ol><li>New Agent name</li>
	 * <li>Description version to use</li>
	 * <li>Comma-delimited Role names to assign to the agent. Must already exist.</li>
	 * <li>Initial properties to set in the new Agent</li>
	 * </ol>
	 * @see com.c2kernel.lifecycle.instance.predefined.item.CreateItemFromDescription#runActivityLogic(com.c2kernel.lookup.AgentPath, int, int, java.lang.String)
	 */
	@Override
	protected String runActivityLogic(AgentPath agent, ItemPath itemPath,
			int transitionID, String requestData) throws InvalidDataException {
		
		String[] input = getDataList(requestData);
		String newName = input[0];
		String descVer = input[1];
		String roles = input[2];
		PropertyArrayList initProps = 
				input.length > 3 ? getInitProperties(input[3]):new PropertyArrayList();
				
		Logger.msg(1, "CreateAgentFromDescription::request() - Starting.");

        try {
        	
        	// check if given roles exist
        	String[] roleArr = roles.split(",");
        	for(int i=0; i<roleArr.length; i++) {
            	RolePath thisRole = Gateway.getLookup().getRolePath(roleArr[i]);
            	if (!thisRole.exists()) throw new InvalidDataException("Role "+roleArr[i]+" does not exist");
            }
        	
            // check if the path is already taken
        	try {
        		Gateway.getLookup().getAgentPath(newName);
        		throw new ObjectAlreadyExistsException("The agent name " +newName+ " exists already.", "");
        	} catch (ObjectNotFoundException ex) { }

            // generate new entity key
            Logger.msg(6, "CreateItemFromDescription - Requesting new agent path");
            AgentPath newAgentPath = new AgentPath(new ItemPath(), newName);

            // resolve the item factory
            Logger.msg(6, "CreateItemFromDescription - Resolving item factory");

            // create the Item object
            Logger.msg(3, "CreateItemFromDescription - Creating Item");
            CorbaServer factory = Gateway.getCorbaServer();
            if (factory == null) throw new AccessRightsException("This process cannot create new Items", "");
            ActiveEntity newAgent = factory.createAgent(newAgentPath);
            Gateway.getLookupManager().add(newAgentPath);

            // initialise it with its properties and workflow

            Logger.msg(3, "CreateItemFromDescription - Initializing Item");

            newAgent.initialise(
                agent.getSystemKey(),
            	Gateway.getMarshaller().marshall(getNewProperties(itemPath, descVer, initProps, newName, agent)),
            	Gateway.getMarshaller().marshall(getNewWorkflow(itemPath, descVer)),
            	Gateway.getMarshaller().marshall(getNewCollections(itemPath, descVer))
            	);
            
            // add roles if given
            
            for(int i=1; i<input.length; i++) {
            	newAgent.addRole(input[i]);
            }

            return requestData;
        } catch (Exception e) {
            Logger.error(e);
            throw new InvalidDataException(e.getMessage(), "");
        }
	}
}