/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: HomeDirLocator.java,v 1.1 2009/01/30 12:09:38 kalpanakm Exp $
 *
 */

package com.sun.identity.agents.install.jsr196;

import com.sun.identity.install.tools.configurator.IStateAccess;
import com.sun.identity.install.tools.configurator.InstallException;
import com.sun.identity.install.tools.configurator.IServerHomeDirLocator;
import com.sun.identity.install.tools.util.FileUtils;
import com.sun.identity.install.tools.util.LocalizedMessage;
import com.sun.identity.install.tools.util.Debug;
import com.sun.identity.agents.install.jsr196.IConfigKeys;

/**
 *
 * Home directory locator for AS81 agent
 * 
 */
public class HomeDirLocator implements IServerHomeDirLocator,
    IConstants, IConfigKeys {
        
    public String getServerDirectory (IStateAccess state) 
                                    throws InstallException {
        String serverHomeDir = null;
        // Home dir is same as domain config dir for as81 onwards
        if (state != null) {
            String asConfigDir = (String)state.get(STR_KEY_AS_INST_CONFIG_DIR);
            if ((asConfigDir != null) && (asConfigDir.length() > 0)) {  
                serverHomeDir = asConfigDir;    
            }
        }          
        
        if(!FileUtils.isDirValid(serverHomeDir)) {
            Debug.log("HomeDirLocator: The server home " + 
                serverHomeDir + ", directory specified is invalid:"); 
            throw new InstallException(
                LocalizedMessage.get(LOC_AS_ERR_IN_VALID_HOME_DIR, STR_AS_GROUP));
        } else {
            //Update the state information
            state.put(STR_KEY_AS_HOME_DIR,serverHomeDir);
        }
       
        Debug.log("HomeDirLocator : Application server home " +
            "directory = " + serverHomeDir);
        return serverHomeDir;
    }
    
    /*
     * Localized constants
     */
    public static String LOC_AS_ERR_IN_VALID_HOME_DIR = 
        "AS_ERR_IN_VALID_HOME_DIR";
    
}