org.glassfish.api.admin.CommandProgress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012 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 [2017] Payara Foundation and/or affiliates
 */
package org.glassfish.api.admin;

import java.util.Date;
import org.glassfish.api.admin.progress.ProgressStatusMirroringImpl;

/** Base interface of progress status implementation. Provides information
 * about overall progress.
 *
 * @author mmares
 */
public interface CommandProgress extends ProgressStatus {
    
    public static final String EVENT_PROGRESSSTATUS_CHANGE = "ProgressStatus/change";
    public static final String EVENT_PROGRESSSTATUS_STATE = "ProgressStatus/state";
    
    /** Timestamp of command complete event or {@code null} for running command
     */ 
    public Date getEndTime();
    
    /** Timestamp of command creation
     */
    public Date getStartTime();
    
    /** Creates child for mirroring (supplemental commands)
     */
    public ProgressStatusMirroringImpl createMirroringChild(int allocatedSteps);
    
    /** Unique id of this command
     */
    @Override
    public String getId();
    
    public String getName();
    
    public float computeCompletePortion();
    
    public String getLastMessage();
    
    public void setEventBroker(AdminCommandEventBroker eventBroker);
    
    public int computeSumSteps();
    
    public boolean isSpinnerActive();
    
}