001    /*
002     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003     *
004     * Copyright (c) 2008-2010 Oracle and/or its affiliates. All rights reserved.
005     *
006     * The contents of this file are subject to the terms of either the GNU
007     * General Public License Version 2 only ("GPL") or the Common Development
008     * and Distribution License("CDDL") (collectively, the "License").  You
009     * may not use this file except in compliance with the License.  You can
010     * obtain a copy of the License at
011     * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
012     * or packager/legal/LICENSE.txt.  See the License for the specific
013     * language governing permissions and limitations under the License.
014     *
015     * When distributing the software, include this License Header Notice in each
016     * file and include the License file at packager/legal/LICENSE.txt.
017     *
018     * GPL Classpath Exception:
019     * Oracle designates this particular file as subject to the "Classpath"
020     * exception as provided by Oracle in the GPL Version 2 section of the License
021     * file that accompanied this code.
022     *
023     * Modifications:
024     * If applicable, add the following below the License Header, with the fields
025     * enclosed by brackets [] replaced by your own identifying information:
026     * "Portions Copyright [year] [name of copyright owner]"
027     *
028     * Contributor(s):
029     * If you wish your version of this file to be governed by only the CDDL or
030     * only the GPL Version 2, indicate your decision by adding "[Contributor]
031     * elects to include this software in this distribution under the [CDDL or GPL
032     * Version 2] license."  If you don't indicate a single choice of license, a
033     * recipient has the option to distribute your version of this file under
034     * either the CDDL, the GPL Version 2 or to extend the choice of license to
035     * its licensees as provided above.  However, if you add GPL Version 2 code
036     * and therefore, elected the GPL Version 2 license, then the option applies
037     * only if the new code is made subject to such option by the copyright
038     * holder.
039     */
040    
041    package com.sun.enterprise.admin.cli;
042    
043    import java.util.*;
044    import org.jvnet.hk2.annotations.*;
045    import org.jvnet.hk2.component.*;
046    import org.glassfish.api.Param;
047    import org.glassfish.api.admin.*;
048    import com.sun.enterprise.universal.i18n.LocalStringsImpl;
049    
050    /**
051     * A local unset command to unset environment variables.
052     *  
053     * @author Bill Shannon
054     */
055    @Service(name = "unset")
056    @Scoped(PerLookup.class)
057    public class UnsetCommand extends CLICommand {
058    
059        @Param(name = "environment-variable", primary = true, multiple = true)
060        private List<String> vars;
061    
062        private static final LocalStringsImpl strings =
063                new LocalStringsImpl(UnsetCommand.class);
064    
065        @Override
066        public int executeCommand()
067                throws CommandException, CommandValidationException {
068            int ret = 0;    // by default, success
069    
070            // process each operand
071            for (String name : vars) {
072                // check that name is legitimate
073                if (!name.startsWith(Environment.AS_ADMIN_ENV_PREFIX)) {
074                    logger.info(strings.get("badEnvVarUnset", name));
075                    ret = -1;
076                    continue;
077                }
078    
079                if (env.get(name) == null) {
080                    logger.info(strings.get("cantRemoveEnvVar", name));
081                    ret = -1;
082                } else
083                    env.remove(name);
084            }
085            return ret;
086        }
087    }