/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
 
/*
 * $Header: /cvs/glassfish/admin/mbeanapi-impl/src/java/com/sun/enterprise/management/config/VirtualServerConfigFactory.java,v 1.5 2007/05/05 05:23:20 tcfujii Exp $
 * $Revision: 1.5 $
 * $Date: 2007/05/05 05:23:20 $
 */
package com.sun.enterprise.management.config;

import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.Collections;

import javax.management.ObjectName;
import javax.management.AttributeList;

import com.sun.enterprise.management.support.oldconfig.OldConfigProxies;
import com.sun.enterprise.management.support.oldconfig.OldHTTPServiceMBean;
import com.sun.enterprise.management.support.oldconfig.OldConfigsMBean;

import com.sun.appserv.management.base.XTypes;
import com.sun.appserv.management.base.Util;

import com.sun.appserv.management.config.VirtualServerConfigKeys;

import com.sun.appserv.management.util.misc.MapUtil;
import com.sun.appserv.management.util.misc.GSetUtil;

import com.sun.enterprise.management.support.WebModuleSupport;



/**
 */
public final class VirtualServerConfigFactory extends ConfigFactory
{
	/**
		@param callbacks	ObjectName of the config to which this HTTPServiceConfigMBean belongs
	 */
		public
	VirtualServerConfigFactory( final ConfigFactoryCallback callbacks )
	{
		super( callbacks );
	}
	
	private final Set<String>	LEGAL_OPTIONAL_KEYS	= 
		GSetUtil.newUnmodifiableStringSet(
		VirtualServerConfigKeys.HTTP_LISTENERS_KEY,
		VirtualServerConfigKeys.STATE_KEY,
		VirtualServerConfigKeys.DOC_ROOT_PROPERTY_KEY,
		VirtualServerConfigKeys.ACCESS_LOG_PROPERTY_KEY 
);
	
	    protected Set<String>
	getLegalOptionalCreateKeys()
	{
		return( LEGAL_OPTIONAL_KEYS );
	}
	
	
		protected Map<String,String>
	getParamNameOverrides()
	{
		return( MapUtil.newMap( CONFIG_NAME_KEY, "id" ) );
	}
	
	/**
		The caller is responsible for dealing with any Properties.
	 */
		protected ObjectName
	createOldChildConfig(
		final AttributeList translatedAttrs, final Properties props )
	{
        final String target = getConfigName();

		final OldConfigsMBean	oldConfigsMBean =
			getOldConfigProxies().getOldConfigsMBean();
		
		trace( "VirtualServerConfigFactory.createOldChildConfig: creating using: " +
			stringify( translatedAttrs ) );
			
		final ObjectName	objectName	=
				oldConfigsMBean.createVirtualServer( translatedAttrs, props, target );
		
		return( objectName );
	}
	
	public final static String	HOSTS_KEY				= "Hosts";
	
	/**
		Parameters:
		<ul>
		
		<li>CONFIG_NAME_KEY</li>
		<li>HOSTS_KEY</li>
		<li>HTTP_LISTENERS_KEY</li>
		<li>DEFAULT_WEB_MODULE_KEY</li>
		<li>STATE_KEY</li>
		<li>LOG_FILE_KEY</li>
		<li>DOC_ROOT_KEY</li>
		<li>ACCESS_LOG_KEY</li>
		</ul>
	 */
		public ObjectName
	create(
		final String	name,
		final String	hosts,
		final Map<String,String>		optional )
	{
        final String[] requiredParams = new String[]
		{
			HOSTS_KEY,			hosts,
		};
		
		// special prefix
		if ( ! WebModuleSupport.isLegalVirtualServerName( name ) )
		{
			throw new IllegalArgumentException( name );
		}
		
		final Map<String,String> params	= initParams( name, requiredParams, optional );
		
		final ObjectName	amxName	= createNamedChild( name, params );
		
		return( amxName );
	}
	
		public void
	internalRemove( final ObjectName objectName )
	{
         // now - obtain Old HTTPService proxy
         final OldHTTPServiceMBean oldHTTPServer =
         	getOldConfigProxies().getOldHTTPServiceMBean( getConfigName() );
         	
         // and ask it to remove VirtualServer
         final String	name	= Util.getName( objectName );
         oldHTTPServer.removeVirtualServerById( name );
	}
}




