org.asteriskjava.manager.internal.ResponseEventsImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asterisk-java Show documentation
The free Java library for Asterisk PBX integration.
There is a newer version: 3.41.0
/*
 *  Copyright 2004-2006 Stefan Reuter
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package org.asteriskjava.manager.internal;

import org.asteriskjava.lock.LockableList;
import org.asteriskjava.lock.Locker.LockCloser;
import org.asteriskjava.manager.ResponseEvents;
import org.asteriskjava.manager.event.ResponseEvent;
import org.asteriskjava.manager.response.ManagerResponse;

import java.util.ArrayList;
import java.util.Collection;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;

/**
 * Implementation of the ResponseEvents interface.
 *
 * @author srt
 * @version $Id$
 * @since 0.2
 */
public class ResponseEventsImpl implements ResponseEvents {
    private ManagerResponse response;
    private final LockableList events;
    private boolean complete;
    private final CountDownLatch latch = new CountDownLatch(1);

    /**
     * Creates a new instance.
     */
    public ResponseEventsImpl() {
        this.events = new LockableList<>(new ArrayList<>());
        this.complete = false;
    }

    // implementation of the ResponseEvents interface

    public ManagerResponse getResponse() {
        return response;
    }

    public Collection getEvents() {
        return events;
    }

    public boolean isComplete() {
        return complete;
    }

    // helper methods to populate the ResponseEvents object

    /**
     * Sets the ManagerResponse received.
     *
     * @param response the ManagerResponse received.
     */
    public void setRepsonse(ManagerResponse response) {
        this.response = response;
    }

    /**
     * Adds a ResponseEvent that has been received.
     *
     * @param event the ResponseEvent that has been received.
     */
    public void addEvent(ResponseEvent event) {
        try (LockCloser closer = events.withLock()) {
            events.add(event);
        }
    }

    /**
     * Indicates if all events have been received.
     *
     * @param complete true if all events have been received,
     *                 false otherwise.
     */
    public void setComplete(boolean complete) {
        this.complete = complete;
    }

    /**
     * @param timeout - milliseconds
     * @return
     * @throws InterruptedException
     */
    public boolean await(long timeout) throws InterruptedException {
        return latch.await(timeout, TimeUnit.MILLISECONDS);
    }

    public void countDown() {
        latch.countDown();
    }

    @Override
    public String toString() {
        return "ResponseEventsImpl [response=" + response + ",\nevents=" + events + ",\ncomplete=" + complete + "]";
    }
}