install/jsr196/UnconfigureLoginConfTaskBase.java

/**
 * 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: UnconfigureLoginConfTaskBase.java,v 1.1 2009/01/30 12:09:39 kalpanakm Exp $
 *
 */

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

import java.util.Map;

import com.sun.identity.install.tools.configurator.IStateAccess;
import com.sun.identity.install.tools.configurator.ITask;
import com.sun.identity.install.tools.configurator.InstallException;
import com.sun.identity.install.tools.util.LocalizedMessage;


/**
 * The abstract class unconfigures the agent in login.conf file of the Sun App Server
 */
public abstract class UnconfigureLoginConfTaskBase extends LoginConfBase
    implements ITask
{

    public UnconfigureLoginConfTaskBase() {
        super();
    }

    public boolean execute(String name, IStateAccess stateAccess,
        Map properties) throws InstallException
    {
        return removeFromFile(stateAccess);
    }


    public LocalizedMessage getExecutionMessage(IStateAccess stateAccess,
        Map properties) {
        String loginConfFile = getLoginConfFile(stateAccess);
        Object[] args = { loginConfFile };
        LocalizedMessage message = LocalizedMessage.get(
            LOC_TSK_MSG_UNCONFIGURE_LOGIN_CONF_EXECUTE, STR_AS_GROUP, args);
        return message;
    }

    public LocalizedMessage getRollBackMessage(IStateAccess stateAccess,
        Map properties) {
        // No roll back in un-install
        return null;
    }

    public boolean rollBack(String name, IStateAccess state, Map properties)
        throws InstallException {
        // Nothing to do during un-install
        return true;
    }

    public static final String LOC_TSK_MSG_UNCONFIGURE_LOGIN_CONF_EXECUTE =
        "TSK_MSG_UNCONFIGURE_LOGIN_CONF_EXECUTE";
}