SimpleProgressObjectImpl.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2011 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.
 */

/*
  * ProgressObjectIimplWithError.java
  *
  * Created on August 13, 2004, 9:53 AM
  */

package org.glassfish.deployapi;

import java.util.Vector;
import java.util.Iterator;

import javax.enterprise.deploy.spi.status.DeploymentStatus;
import javax.enterprise.deploy.spi.status.ProgressObject;
import javax.enterprise.deploy.spi.status.ProgressEvent;
import javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException;
import javax.enterprise.deploy.spi.status.ProgressListener;
import javax.enterprise.deploy.shared.StateType;

/**
  *Implements a progress object primarily intended to report an error during a DeploymentManager
  *method invocation.
  * @author  tjquinn
  */
public class SimpleProgressObjectImpl implements ProgressObject {
    
    /** Records registered listeners */
    private Vector listeners = new Vector();

    /**
     *Records all events delivered so late-registering listeners will be informed of all past events
     *as well as future ones.
     */
    protected Vector deliveredEvents = new Vector();
    
    /** Records the deployment status.  Normally of type DeploymentStatusWithError */
    private DeploymentStatus deploymentStatus = null;
    
    /** Creates a new instance of ProgressObjectIimplWithError */
    public SimpleProgressObjectImpl(DeploymentStatus deploymentStatus) {
        this.deploymentStatus = deploymentStatus;
    }

    /**
     *Registers a listener for progress events.
     *@param new progress listener
     */
    public void addProgressListener(javax.enterprise.deploy.spi.status.ProgressListener progressListener) {
	synchronized (listeners) {
            listeners.add(progressListener);
	    if (deliveredEvents.size() > 0) {
	        for (Iterator i = deliveredEvents.iterator(); i.hasNext();) {
		    progressListener.handleProgressEvent((ProgressEvent)i.next());
	        }
	    }
	}
    }    
    
    public void cancel() throws javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException {
        throw new OperationUnsupportedException("cancel not supported");
    }
    
    public javax.enterprise.deploy.spi.status.ClientConfiguration getClientConfiguration(javax.enterprise.deploy.spi.TargetModuleID targetModuleID) {
        return null;
    }
    
    public javax.enterprise.deploy.spi.status.DeploymentStatus getDeploymentStatus() {
        return deploymentStatus;
    }
    
    public javax.enterprise.deploy.spi.TargetModuleID[] getResultTargetModuleIDs() {
        return new javax.enterprise.deploy.spi.TargetModuleID[0];
    }
    
    public boolean isCancelSupported() {
        return false;
    }
    
    public boolean isStopSupported() {
        return false;
    }

    /**
     *Unregister a previously-registered event listener.
     *@param the listener to unregister
     */
    public void removeProgressListener(javax.enterprise.deploy.spi.status.ProgressListener progressListener) {
	synchronized (listeners) {
            listeners.remove(progressListener);
	}
    }
    
    public void stop() throws javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException {
        throw new OperationUnsupportedException("stop not supported");
    }
    
    /**
     * Notifies all listeners that have registered interest for ProgressEvent notification. 
     */
    protected void fireProgressEvent(ProgressEvent progressEvent) {
	Vector currentListeners = null;
        synchronized (listeners) {
            currentListeners = (Vector) listeners.clone();
            deliveredEvents.add(progressEvent);
        }

        for (Iterator listenersItr = currentListeners.iterator(); listenersItr.hasNext();) {
            ((ProgressListener)listenersItr.next()).handleProgressEvent(progressEvent);
        }
    }


}