RPFRetriever.java

/*
 * Copyright 2006-2009, 2017, 2020 United States Government, as represented by the
 * Administrator of the National Aeronautics and Space Administration.
 * All rights reserved.
 * 
 * The NASA World Wind Java (WWJ) platform is 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.
 * 
 * NASA World Wind Java (WWJ) also contains the following 3rd party Open Source
 * software:
 * 
 *     Jackson Parser – Licensed under Apache 2.0
 *     GDAL – Licensed under MIT
 *     JOGL – Licensed under  Berkeley Software Distribution (BSD)
 *     Gluegen – Licensed under Berkeley Software Distribution (BSD)
 * 
 * A complete listing of 3rd Party software notices and licenses included in
 * NASA World Wind Java (WWJ)  can be found in the WorldWindJava-v2.2 3rd-party
 * notices and licenses PDF found in code directory.
 */
package gov.nasa.worldwind.layers.rpf;

import gov.nasa.worldwind.WWObjectImpl;
import gov.nasa.worldwind.avlist.AVKey;
import gov.nasa.worldwind.formats.dds.DDSCompressor;
import gov.nasa.worldwind.retrieve.*;
import gov.nasa.worldwind.util.Logging;

import java.awt.image.*;
import java.net.URL;
import java.nio.ByteBuffer;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Level;

/**
 * @author dcollins
 * @version $Id: RPFRetriever.java 1171 2013-02-11 21:45:02Z dcollins $
 */
class RPFRetriever extends WWObjectImpl implements Retriever
{
    private volatile ByteBuffer byteBuffer;
    private volatile int contentLength = 0;
    private AtomicInteger contentLengthRead = new AtomicInteger(0);
    private volatile String state = RETRIEVER_STATE_NOT_STARTED;
    private volatile String contentType;
    private long submitTime;
    private long beginTime;
    private long endTime;
    private int connectTimeout = -1;
    private int readTimeout = -1;
    private int staleRequestLimit = -1;

    private final RPFGenerator.RPFServiceInstance service;
    private final URL url;
    private final RetrievalPostProcessor postProcessor;
    private int responseCode;

    public static final int RESPONSE_CODE_OK = 1;
    public static final int RESPONSE_CODE_NO_CONTENT = 2;

    protected String basicAuthenticationEncodedString;

    public RPFRetriever(RPFGenerator.RPFServiceInstance service, URL url, RetrievalPostProcessor postProcessor)
    {
        if (service == null)
        {
            String message = "Service is null";
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }
        if (url == null)
        {
            String message = Logging.getMessage("nullValue.URLIsNull");
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }
        if (postProcessor == null)
        {
            String message = Logging.getMessage("nullValue.PostProcessorIsNull");
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        this.service = service;
        this.url = url;
        this.postProcessor = postProcessor;
    }

    public final ByteBuffer getBuffer()
    {
        return this.byteBuffer;
    }

    public final int getContentLength()
    {
        return this.contentLength;
    }

    public final int getContentLengthRead()
    {
        return this.contentLengthRead.get();
    }

    protected void setContentLengthRead(int length)
    {
        this.contentLengthRead.set(length);
    }

    public final String getName()
    {
        return this.url.toString();
    }

    public final String getState()
    {
        return this.state;
    }

    public final String getContentType()
    {
        return this.contentType;
    }

    /**
     * {@inheritDoc}
     *
     * @return Always returns zero (no expiration).
     */
    public long getExpirationTime()
    {
        return 0;
    }

    public long getSubmitTime()
    {
        return this.submitTime;
    }

    public void setSubmitTime(long submitTime)
    {
        this.submitTime = submitTime;
    }

    public long getBeginTime()
    {
        return this.beginTime;
    }

    public void setBeginTime(long beginTime)
    {
        this.beginTime = beginTime;
    }

    public long getEndTime()
    {
        return this.endTime;
    }

    public void setEndTime(long endTime)
    {
        this.endTime = endTime;
    }

    public int getConnectTimeout()
    {
        return this.connectTimeout;
    }

    public void setConnectTimeout(int connectTimeout)
    {
        this.connectTimeout = connectTimeout;
    }

    public int getReadTimeout()
    {
        return this.readTimeout;
    }

    public void setReadTimeout(int readTimeout)
    {
        this.readTimeout = readTimeout;
    }

    public int getStaleRequestLimit()
    {
        return this.staleRequestLimit;
    }

    public void setStaleRequestLimit(int staleRequestLimit)
    {
        this.staleRequestLimit = staleRequestLimit;
    }

    @Override
    public void setBasicAuthentication(String basicAuthorizationString) {
        this.basicAuthenticationEncodedString = basicAuthorizationString;
    }

    public final RPFGenerator.RPFServiceInstance getService()
    {
        return this.service;
    }

    public final URL getURL()
    {
        return this.url;
    }

    public final RetrievalPostProcessor getPostProcessor()
    {
        return this.postProcessor;
    }

    public int getResponseCode()
    {
        return this.responseCode;
    }

    public final Retriever call() throws Exception
    {
        if (interrupted())
            return this;

        try
        {
            setState(RETRIEVER_STATE_STARTED);

            // Simulate connected state.
            if (!interrupted())
                setState(RETRIEVER_STATE_CONNECTING);

            if (!interrupted())
            {
                setState(RETRIEVER_STATE_READING);
                this.byteBuffer = read();
            }

            if (!interrupted())
                setState(RETRIEVER_STATE_SUCCESSFUL);
        }
        catch (Exception e)
        {
            setState(RETRIEVER_STATE_ERROR);
            Logging.logger().log(Level.SEVERE,
                Logging.getMessage("URLRetriever.ErrorAttemptingToRetrieve", this.url.toString()), e);
        }
        finally
        {
            end();
        }

        return this;
    }

    private void setState(String state)
    {
        String oldState = this.state;
        this.state = state;
        this.firePropertyChange(AVKey.RETRIEVER_STATE, oldState, this.state);
    }

    private boolean interrupted()
    {
        if (Thread.currentThread().isInterrupted())
        {
            setState(RETRIEVER_STATE_INTERRUPTED);
            String message = Logging.getMessage("URLRetriever.RetrievalInterruptedFor", this.url.toString());
            Logging.logger().fine(message);
            return true;
        }
        return false;
    }

    private void end() throws Exception
    {
        try
        {
            if (this.postProcessor != null)
            {
                this.byteBuffer = this.postProcessor.run(this);
            }
        }
        catch (Exception e)
        {
            setState(RETRIEVER_STATE_ERROR);
            Logging.logger().log(Level.SEVERE,
                Logging.getMessage("Retriever.ErrorPostProcessing", this.url.toString()), e);
            throw e;
        }
    }

    private ByteBuffer read() throws Exception
    {
        ByteBuffer buffer = this.doRead(this.service, this.url);
        if (buffer == null)
            this.contentLength = 0;
        return buffer;
    }

    protected ByteBuffer doRead(RPFGenerator.RPFServiceInstance service, URL url) throws Exception
    {
        ByteBuffer buffer = null;

        BufferedImage bufferedImage = service.serviceRequest(url);
        if (bufferedImage != null)
        {
            // TODO: format parameter should determine image type
            buffer = DDSCompressor.compressImage(bufferedImage);
            if (buffer != null)
            {
                int length = buffer.limit();
                this.contentType = "image/dds";
                this.contentLength = length;
                setContentLengthRead(length);
            }
        }

        // TODO: service should provide response code
        this.responseCode = buffer != null ? RESPONSE_CODE_OK : RESPONSE_CODE_NO_CONTENT;

        return buffer;
    }

    @Override
    public boolean equals(Object o)
    {
        if (this == o)
            return true;
        if (o == null || getClass() != o.getClass())
            return false;

        final RPFRetriever that = (RPFRetriever) o;

        // Retrievers are considered identical if they are for the same URL. This convention is used by the
        // retrieval service to filter out duplicate retreival requests.
        return !(url != null ? !url.toString().contentEquals(that.url.toString()) : that.url != null);
    }

    @Override
    public int hashCode()
    {
        int result;
        result = (url != null ? url.hashCode() : 0);
        return result;
    }

    @Override
    public String toString()
    {
        return this.getName() != null ? this.getName() : super.toString();
    }
}