871b417a57cab3336793a845810383ceae4233cbMark de Reeper/**
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved.
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * The contents of this file are subject to the terms
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * of the Common Development and Distribution License
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * (the License). You may not use this file except in
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * compliance with the License.
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * You can obtain a copy of the License at
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * https://opensso.dev.java.net/public/CDDLv1.0.html or
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * opensso/legal/CDDLv1.0.txt
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * See the License for the specific language governing
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * permission and limitations under the License.
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * When distributing Covered Code, include this CDDL
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * Header Notice in each file and include the License file
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * at opensso/legal/CDDLv1.0.txt.
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * If applicable, add the following below the CDDL Header,
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * with the fields enclosed by brackets [] replaced by
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * your own identifying information:
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * "Portions Copyrighted [year] [name of copyright owner]"
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * $Id: HomeDirValidator.java,v 1.1 2009/01/21 18:43:55 kanduls Exp $
871b417a57cab3336793a845810383ceae4233cbMark de Reeper */
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper/**
5c39d8f041417518a02ce2c941d96c2d33b2a364Mark de Reeper * Portions Copyrighted 2013 ForgeRock AS.
871b417a57cab3336793a845810383ceae4233cbMark de Reeper */
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeperpackage com.sun.identity.agents.tools.jetty.v7;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.configurator.IStateAccess;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.configurator.InstallException;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.configurator.ValidationResult;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.configurator.ValidationResultStatus;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.configurator.ValidatorBase;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.util.Debug;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.util.FileUtils;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport com.sun.identity.install.tools.util.LocalizedMessage;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport java.io.File;
871b417a57cab3336793a845810383ceae4233cbMark de Reeperimport java.util.Map;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeperpublic class HomeDirValidator extends ValidatorBase implements IConstants, IConfigKeys {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper public HomeDirValidator() throws InstallException {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper super();
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper /**
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * Method isHomeDirValid
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * @param jettyHomeDir
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * @param props
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * @param state
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper * @return ValidationResult
871b417a57cab3336793a845810383ceae4233cbMark de Reeper *
871b417a57cab3336793a845810383ceae4233cbMark de Reeper */
871b417a57cab3336793a845810383ceae4233cbMark de Reeper public ValidationResult isHomeDirValid(String jettyHomeDir, Map props, IStateAccess state) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper ValidationResultStatus validRes = ValidationResultStatus.STATUS_FAILED;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper LocalizedMessage returnMessage = null;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper if ((jettyHomeDir != null) && (jettyHomeDir.trim().length() >= 0)) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper // The config dir has been normalized to have "/" only
871b417a57cab3336793a845810383ceae4233cbMark de Reeper String jettyJarFile = jettyHomeDir + STR_FORWARD_SLASH + JETTY_START_JAR;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper String jettyIniFile = jettyHomeDir + STR_FORWARD_SLASH + JETTY_START_INI;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper String webAppDir =jettyHomeDir + STR_FORWARD_SLASH + JETTY_WEB_APP_DIR;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper if (FileUtils.isFileValid(jettyJarFile) && FileUtils.isFileValid(jettyIniFile) &&
871b417a57cab3336793a845810383ceae4233cbMark de Reeper canUpdateJettyConfigFile(jettyHomeDir)) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper returnMessage = LocalizedMessage.get(VA_MSG_JETTY_VAL_HOME, STR_JETTY_GROUP,
871b417a57cab3336793a845810383ceae4233cbMark de Reeper new Object[] { jettyHomeDir });
871b417a57cab3336793a845810383ceae4233cbMark de Reeper validRes = ValidationResultStatus.STATUS_SUCCESS;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper state.put(STR_KEY_JETTY_START_JAR_PATH, jettyJarFile);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Debug.log("HomeDirValidator: Added Jetty start.jar to state --> " + jettyHomeDir);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper state.put(STR_KEY_JETTY_START_INI_PATH, jettyIniFile);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Debug.log("HomeDirValidator: Added Jetty start.ini to state --> " + jettyIniFile);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper state.put(STR_KEY_JETTY_INST_DEPLOY_DIR, webAppDir);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Debug.log("HomeDirValidator: Added Jetty webapp dir to state --> " + webAppDir);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper if (validRes.getIntValue() == ValidationResultStatus.INT_STATUS_FAILED) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper returnMessage = LocalizedMessage.get(VA_WRN_JETTY_IN_VAL_HOME, STR_JETTY_GROUP,
871b417a57cab3336793a845810383ceae4233cbMark de Reeper new Object[] { jettyHomeDir });
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Debug.log("HomeDirValidator : Is Jetty Home directory " + jettyHomeDir + " valid ? " + validRes.isSuccessful());
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper return new ValidationResult(validRes, null, returnMessage);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper public void initializeValidatorMap() throws InstallException {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Class[] paramObjs = { String.class, Map.class, IStateAccess.class };
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper try {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper getValidatorMap().put("VALID_JETTY_HOME_DIR", this.getClass().getMethod("isHomeDirValid", paramObjs));
871b417a57cab3336793a845810383ceae4233cbMark de Reeper } catch (NoSuchMethodException nsme) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Debug.log("HomeDirValidator: NoSuchMethodException thrown while loading method :", nsme);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper throw new InstallException(LocalizedMessage.get(LOC_VA_ERR_VAL_METHOD_NOT_FOUND), nsme);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper } catch (SecurityException se) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Debug.log("HomeDirValidator: SecurityException thrown while loading method :", se);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper throw new InstallException(LocalizedMessage.get(LOC_VA_ERR_VAL_METHOD_NOT_FOUND), se);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper } catch (Exception ex) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper Debug.log("HomeDirValidator: Exception thrown while loading method :", ex);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper throw new InstallException(LocalizedMessage.get(LOC_VA_ERR_VAL_METHOD_NOT_FOUND), ex);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper protected boolean canUpdateJettyConfigFile(String jettyHomeDir) {
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper String jettyConfFile =
871b417a57cab3336793a845810383ceae4233cbMark de Reeper jettyHomeDir + STR_FORWARD_SLASH + STR_ETC_DIRECTORY + STR_FORWARD_SLASH + STR_SERVER_XML;
871b417a57cab3336793a845810383ceae4233cbMark de Reeper File file = new File(jettyConfFile);
871b417a57cab3336793a845810383ceae4233cbMark de Reeper
871b417a57cab3336793a845810383ceae4233cbMark de Reeper return (file.exists() && file.canWrite() && file.canRead() && file.getParentFile().canWrite());
871b417a57cab3336793a845810383ceae4233cbMark de Reeper }
871b417a57cab3336793a845810383ceae4233cbMark de Reeper}
871b417a57cab3336793a845810383ceae4233cbMark de Reeper