LogoutCommand.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.rhq.enterprise.client.commands;

import org.rhq.enterprise.client.ClientMain;
import org.rhq.enterprise.clientapi.RemoteClient;

/**
 * @author Greg Hinkle
 */
public class LogoutCommand implements ClientCommand {

    public String getPromptCommandString() {
        return "logout";
    }

    public boolean execute(ClientMain client, String[] args) {
        execute(client);
        client.getPrintWriter().println("Logout successful");

        return true;
    }

    public void execute(ClientMain client) {
        client.setTransport(null);
        client.setHost(null);
        client.setPort(0);
        RemoteClient remoteClient = client.getRemoteClient();
        if (null != remoteClient) {
            remoteClient.logout();
        }
        // this call has the side effect of setting bindings for the new remote client and its subject        
        client.setRemoteClient(null);
        client.setSubject(null);
        client.setUser(null);
        client.setPass(null);
    }

    public String getSyntax() {
        return getPromptCommandString();
    }

    public String getHelp() {
        return "Logout and disconnect from the server but do not exit the CLI";
    }

    public String getDetailedHelp() {
        return getHelp();
    }
}