gshell-support/gshell-artifact/src/main/java/org/apache/geronimo/gshell/artifact/transfer/TransferEvent.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.geronimo.gshell.artifact.transfer;

/**
 * Artifact transfer event.
 *
 * @version $Rev$ $Date$
 */
public interface TransferEvent
{
    /**
     * Constant to be used when the content-length is not known.
     */
    int UNKNOWN_LENGTH = -1;

    /**
     * Transfer request type.
     */
    enum RequestType {
        UPLOAD, DOWNLOAD
    }

    /**
     * Transfer request type.
     */
    RequestType getRequestType();

    /**
     * Content location.
     */
    String getLocation();

    /**
     * The maximum length of the content.
     */
    long getContentLength();

    /**
     * The length of bytes received for this event.
     */
    long getLength();

    /**
     * Failure cause.
     */
    Throwable getFailureCause();
}