org.glassfish.cafe.api.bean
Enum CommunicationEvent.Type

java.lang.Object
  java.lang.Enum<CommunicationEvent.Type>
      org.glassfish.cafe.api.bean.CommunicationEvent.Type

All Implemented Interfaces:

Serializable, Comparable<CommunicationEvent.Type>

Enclosing class:

CommunicationEvent

public static enum CommunicationEvent.Type
extends Enum<CommunicationEvent.Type>

Type or classification of a CommunicationEvent.

Author:

binod

Enum Constant Summary

ABORTED
Indicates that Communication has been aborted by the initiator.

ERROR
An unexpected error occurred in the Communication.

ESTABLISHED
An event indicating that the Communication is established.

FAILED
Indicates that Communication has failed.

FINISHED
Communication ended.

INITIALIZATION
Communication is being initialized.

MEDIA
Generic event that act as a capture all for any media event in the media server other than those explicitly captured using MEDIASTARTED or MEDIAENDED events.

MEDIAENDED
Indication that media ended from the media server.

MESSAGEARRIVED
An IM message arrived during an IMConversation.

MESSAGEINDICATION
A Message Indication arrived during an IMConversation.

STARTED
Communication has started.

Method Summary

static CommunicationEvent.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommunicationEvent.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABORTED

public static final CommunicationEvent.Type ABORTED

Indicates that Communication has been aborted by the initiator.

ERROR

public static final CommunicationEvent.Type ERROR

An unexpected error occurred in the Communication.

ESTABLISHED

public static final CommunicationEvent.Type ESTABLISHED

An event indicating that the Communication is established. For example, this happens, when the call is established in case of Conversation or when the first party establishes media in a conference. Similarly for an IMConversation, ESTABLISHED event will happen when atleast one message from both parties arrive.

FAILED

public static final CommunicationEvent.Type FAILED

Indicates that Communication has failed. Typically this happens due to an error message from one of the parties that lead to the failure of the Communication.

FINISHED

public static final CommunicationEvent.Type FINISHED

Communication ended.

INITIALIZATION

public static final CommunicationEvent.Type INITIALIZATION

Communication is being initialized. Application can change the behavior of the Communication in this event. For example, application would execute CommunicationSession.createConference(String, Conversation) to convert the call to a conference.

STARTED

public static final CommunicationEvent.Type STARTED

Communication has started.

MESSAGEARRIVED

public static final CommunicationEvent.Type MESSAGEARRIVED

An IM message arrived during an IMConversation.

MESSAGEINDICATION

public static final CommunicationEvent.Type MESSAGEINDICATION

A Message Indication arrived during an IMConversation.

See Also:

MessageIndication

MEDIAENDED

public static final CommunicationEvent.Type MEDIAENDED

Indication that media ended from the media server.

MEDIA

public static final CommunicationEvent.Type MEDIA

Generic event that act as a capture all for any media event in the media server other than those explicitly captured using MEDIASTARTED or MEDIAENDED events.

Method Detail

values

public static CommunicationEvent.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommunicationEvent.Type c : CommunicationEvent.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommunicationEvent.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null