net.java.sip.communicator.service.protocol.event
Class WhiteboardObjectDeliveryFailedEvent

java.lang.Object
  java.util.EventObject
      net.java.sip.communicator.service.protocol.event.WhiteboardObjectDeliveryFailedEvent

All Implemented Interfaces:

Serializable

public class WhiteboardObjectDeliveryFailedEvent
extends EventObject

WhiteboardObjectDeliveredEvents are used to report that delivery of a whiteboardObject has failed.

Author:

Julien Waechter, Emil Ivov

See Also:

Serialized Form

Field Summary

static int	INTERNAL_ERROR Set when delivery fails for implementation specific reasons.
static int	NETWORK_FAILURE Set when delivery fails due to a failure in network communications or a transport error.
static int	OFFLINE_MESSAGES_NOT_SUPPORTED Set when delivery fails because we're trying to send a whiteboard object to a contact that is currently offline and the server does not support offline whiteboard objects.
static int	PROVIDER_NOT_REGISTERED Set to indicate that delivery has failed because the provider was not registered.
static int	UNKNOWN_ERROR Set when no other error code can describe the exception that occurred.

Fields inherited from class java.util.EventObject

source

Constructor Summary

WhiteboardObjectDeliveryFailedEvent(WhiteboardSession source, WhiteboardObject obj, Contact to, int errorCode, Date timestamp)
Creates a WhiteboardObjectDeliveryFailedEvent indicating failure of delivery of the obj WhiteboardObject to the specified to contact.

Method Summary

Contact	getDestinationContact() Returns a reference to the Contact that the source (failed) WhiteboardObject was sent to.
int	getErrorCode() Returns an error code describing the reason for the failure of the white-board object delivery.
WhiteboardObject	getSourceWhiteboardObject() Returns the WhiteboardObject that triggered this event
Date	getTimestamp() A timestamp indicating the exact date when the event ocurred (in this case it is the moment when it was determined that whiteboardObject delivery has failed).

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_ERROR

public static final int UNKNOWN_ERROR

Set when no other error code can describe the exception that occurred.

See Also:

Constant Field Values

NETWORK_FAILURE

public static final int NETWORK_FAILURE

Set when delivery fails due to a failure in network communications or a transport error.

See Also:

Constant Field Values

PROVIDER_NOT_REGISTERED

public static final int PROVIDER_NOT_REGISTERED

Set to indicate that delivery has failed because the provider was not registered.

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Set when delivery fails for implementation specific reasons.

See Also:

Constant Field Values

OFFLINE_MESSAGES_NOT_SUPPORTED

public static final int OFFLINE_MESSAGES_NOT_SUPPORTED

Set when delivery fails because we're trying to send a whiteboard object to a contact that is currently offline and the server does not support offline whiteboard objects.

See Also:

Constant Field Values

Constructor Detail

WhiteboardObjectDeliveryFailedEvent

public WhiteboardObjectDeliveryFailedEvent(WhiteboardSession source,
                                           WhiteboardObject obj,
                                           Contact to,
                                           int errorCode,
                                           Date timestamp)

Creates a WhiteboardObjectDeliveryFailedEvent indicating failure of delivery of the obj WhiteboardObject to the specified to contact.

Parameters:

source - the WhiteboardSession where the failure has occcurred.

obj - the WhiteboardObject the white-board object.

to - the Contact that this WhiteboardObject was sent to.

errorCode - an errorCode indicating the reason for the failure.

timestamp - the exact Date when it was determined that delivery had failed.

Method Detail

getDestinationContact

public Contact getDestinationContact()

Returns a reference to the Contact that the source (failed) WhiteboardObject was sent to.

Returns:

a reference to the Contact that the source failed WhiteboardObject was sent to.

getErrorCode

public int getErrorCode()

Returns an error code describing the reason for the failure of the white-board object delivery.

Returns:

an error code describing the reason for the failure of the white-board object delivery.

getTimestamp

public Date getTimestamp()

A timestamp indicating the exact date when the event ocurred (in this case it is the moment when it was determined that whiteboardObject delivery has failed).

Returns:

a Date indicating when the event ocurred.

getSourceWhiteboardObject

public WhiteboardObject getSourceWhiteboardObject()

Returns the WhiteboardObject that triggered this event

Returns:

the WhiteboardObject that triggered this event.