All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.enterprise.admin.remote.GeneratedManPageManager Maven / Gradle / Ivy

There is a newer version: 7.2024.1.Alpha1
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
// Portions Copyright [2018] Payara Foundation and/or affiliates

package com.sun.enterprise.admin.remote;

import com.sun.enterprise.universal.NameValue;
import com.sun.enterprise.universal.glassfish.AdminCommandResponse;
import java.util.*;

/**
 *
 * @author bnevins
 */
class GeneratedManPageManager implements ResponseManager {
    
    AdminCommandResponse response;
    private String name; 
    private String synopsis; 
    List> params = new LinkedList>();
    List> operands = new LinkedList>();
    private static final String TAB = "    ";
    private static final String EOL = System.lineSeparator();
    
    GeneratedManPageManager(AdminCommandResponse response) {
        this.response = response;
    }

    public void process() throws RemoteException {
        String usageText = response.getValue(AdminCommandResponse.SYNOPSIS);

        if(usageText == null) {
            // this is one way to figure out there was an error!
            throw new RemoteFailureException("XXXXXXXXXXXXXXXXXXXX", 
                    response.getMainMessage());
        }
        setName();
        setSynopsis();
        setParamsAndOperands();
        StringBuilder sb = new StringBuilder();
        sb.append(EOL);
        printName(sb);
        printSynopsis(sb);
        printParams(sb);
        printOperands(sb);
        throw new RemoteSuccessException(sb.toString());
    }

    private void setName() {
        name = displayInProperLen(response.getMainMessage());
    }

    private void printName(StringBuilder sb) {
        sb.append("NAME :").append(EOL);
        sb.append(name).append(EOL);
    }

    private void setSynopsis() {
        synopsis = response.getValue(AdminCommandResponse.SYNOPSIS);
        
        if (synopsis.startsWith("Usage: ")) {
            synopsis = synopsis.substring(7);     
        }
        // this looks too horrible - go with one long line...
        //synopsis = displayInProperLen(synopsis);
    }
    private void printSynopsis(StringBuilder sb) {
        sb.append("SYNOPSIS :").append(EOL);
        sb.append(TAB).append(synopsis).append(EOL);
        sb.append(EOL);
    }

    private void setParamsAndOperands() {
        List> list = response.getMainKeys();
        
        for(NameValue nv : list) {
            String name = nv.getName();
            if(name.equals(AdminCommandResponse.SYNOPSIS))
                continue;
            if(name.endsWith("operand")) 
                operands.add(nv);
            else
                params.add(nv);
        }
    }

    private void printParams(StringBuilder sb) {
        sb.append("OPTIONS :").append(EOL);
        
        for(NameValue nv : params) {
            sb.append(TAB + "--").append(nv.getName()).append(EOL);
            sb.append(displayInProperLen(nv.getValue()));
            sb.append(EOL);
        }
    }

    private void printOperands(StringBuilder sb) {

        sb.append("OPERANDS :").append(EOL);

        for(NameValue nv : operands) {
            String key = nv.getName();
            // peel off "_operand"
            key = key.substring(0, key.length() - 8);
            String value = nv.getValue();
            sb.append(displayInProperLen(key + " - " + value));
            sb.append(EOL);
        }
    }
       
    // bnevins -- original code reused, this looks painful to change...
    private String displayInProperLen(String strToDisplay) {
        int index = 0;
        StringBuilder sb = new StringBuilder();
        
        for (int ii=0; ii+70




© 2015 - 2024 Weber Informatics LLC | Privacy Policy