org.apache.maven.wagon.events

Class TransferEvent


public class TransferEvent
extends WagonEvent

TransferEvent is used to notify TransferListeners about progress in transfer of resources form/to the respository
Version:
$Id: TransferEvent.java 162476 2005-04-19 02:49:45Z brett $
Author:
Michal Maczka

Field Summary

static int
REQUEST_GET
Indicates GET transfer (from the repository)
static int
REQUEST_PUT
Indicates PUT transfer (to the repository)
static int
TRANSFER_COMPLETED
A transfer is completed.
static int
TRANSFER_ERROR
An error occured during transfer
static int
TRANSFER_INITIATED
A transfer was attempted, but has not yet commenced.
static int
TRANSFER_PROGRESS
A transfer is in progress.
static int
TRANSFER_STARTED
A transfer was started.

Fields inherited from class org.apache.maven.wagon.events.WagonEvent

repository, timestamp

Constructor Summary

TransferEvent(Wagon wagon, Resource resource, Exception exception, int requestType)
TransferEvent(Wagon wagon, Resource resource, int eventType, int requestType)

Method Summary

int
getEventType()
Exception
getException()
File
getLocalFile()
int
getRequestType()
Returns the request type.
Resource
getResource()
void
setEventType(int eventType)
void
setLocalFile(File localFile)
void
setRequestType(int requestType)
Sets the request type
void
setResource(Resource resource)

Methods inherited from class org.apache.maven.wagon.events.WagonEvent

getTimestamp, getWagon, setTimestamp

Field Details

REQUEST_GET

public static final int REQUEST_GET
Indicates GET transfer (from the repository)
Field Value:
5

REQUEST_PUT

public static final int REQUEST_PUT
Indicates PUT transfer (to the repository)
Field Value:
6

TRANSFER_COMPLETED

public static final int TRANSFER_COMPLETED
A transfer is completed.
Field Value:
2

TRANSFER_ERROR

public static final int TRANSFER_ERROR
An error occured during transfer
Field Value:
4

TRANSFER_INITIATED

public static final int TRANSFER_INITIATED
A transfer was attempted, but has not yet commenced.
Field Value:
0

TRANSFER_PROGRESS

public static final int TRANSFER_PROGRESS
A transfer is in progress.
Field Value:
3

TRANSFER_STARTED

public static final int TRANSFER_STARTED
A transfer was started.
Field Value:
1

Constructor Details

TransferEvent

public TransferEvent(Wagon wagon,
                     Resource resource,
                     Exception exception,
                     int requestType)

TransferEvent

public TransferEvent(Wagon wagon,
                     Resource resource,
                     int eventType,
                     int requestType)

Method Details

getEventType

public int getEventType()
Returns:
Returns the eventType.

getException

public Exception getException()
Returns:
Returns the exception.

getLocalFile

public File getLocalFile()
Returns:
Returns the local file.

getRequestType

public int getRequestType()
Returns the request type.
Returns:
Returns the request type. The Request type is one of TransferEvent.REQUEST_GET or TransferEvent.REQUEST_PUT

getResource

public Resource getResource()
Returns:
Returns the resource.

setEventType

public void setEventType(int eventType)
Parameters:
eventType - The eventType to set.

setLocalFile

public void setLocalFile(File localFile)
Parameters:
localFile - The local file to set.

setRequestType

public void setRequestType(int requestType)
Sets the request type
Parameters:
requestType - The requestType to set. The Request type value should be either TransferEvent.REQUEST_GET or TransferEvent.REQUEST_PUT.

setResource

public void setResource(Resource resource)
Parameters:
resource - The resource to set.