org.cafesip.sipexchange.common.inservice.shared
Class TriggerInfo

java.lang.Object
  org.cafesip.sipexchange.common.inservice.shared.TriggerInfo

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CalledAddressTermTrigger, CalledBusyTermTrigger, CalledNoAnswerTermTrigger, CalledNotAvailableTermTrigger, MakeCallOrigTrigger, ReceivedCallTermTrigger

public class TriggerInfo
extends java.lang.Object
implements java.io.Serializable

When SipExchange encounters a trigger condition while processing a call, it invokes a remote method on the SCP. An object is passed as a parameter with the invocation. The class that this object instantiates depends on the type of trigger and is referred to as the trigger class. All trigger classes extend this class as their base class.

The setter methods are used by the SipExchange server to populate this object. The getter methods can be used by the SCP to get the information about the invocation.

See Also:

Serialized Form

Field Summary

static java.lang.String	CALLED_ADDRESS_TERM_TRIGGER
static java.lang.String	CALLED_BUSY_TERM_TRIGGER
static java.lang.String	CALLED_NOANS_TERM_TRIGGER
static java.lang.String	CALLED_NOT_AVAIL_TERM_TRIGGER
static java.lang.String	MAKE_CALL_ORIG_TRIGGER
static java.lang.String	RECEIVED_CALL_TERM_TRIGGER

Constructor Summary

TriggerInfo()
A constructor for this class.

Method Summary

Domain	getCalledDomain() Getter for the called domain object.
Subscriber	getCalledSubscriber() Getter for the called subscriber object.
Domain	getCallingDomain() Getter for the calling domain object.
Subscriber	getCallingSubscriber() Getter for the calling subscriber object.
java.lang.String	getFeature() Getter for the feature name.
java.lang.String	getFrom()
java.lang.Object	getMessage() Getter for the message parameter.
java.lang.Object	getParam() Getter for the param object.
java.lang.String	getProtocol() Getter for the protocol parameter.
java.lang.String	getTo()
static java.lang.String	printTriggerInfo(TriggerInfo trigger) This method returns formatted information on a trigger.
void	setCalledDomain(Domain calledDomain) Setter for the called domain object.
void	setCalledSubscriber(Subscriber calledSubscriber) Setter for the called subscriber object.
void	setCallingDomain(Domain callingDomain) The setter for the calling domain object.
void	setCallingSubscriber(Subscriber callingSubscriber) Setter for the calling subscriber object.
void	setFeature(java.lang.String feature) Setter for the feature name.
void	setFrom(java.lang.String from)
void	setMessage(java.lang.Object message) Setter for the Message parameter.
void	setParam(java.lang.Object param) Setter for the param object.
void	setProtocol(java.lang.String protocol) Setter for the protocol parameter.
void	setTo(java.lang.String to)

Methods inherited from class java.lang.Object

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

Field Detail

MAKE_CALL_ORIG_TRIGGER

public static final java.lang.String MAKE_CALL_ORIG_TRIGGER

See Also:

Constant Field Values

RECEIVED_CALL_TERM_TRIGGER

public static final java.lang.String RECEIVED_CALL_TERM_TRIGGER

See Also:

Constant Field Values

CALLED_BUSY_TERM_TRIGGER

public static final java.lang.String CALLED_BUSY_TERM_TRIGGER

See Also:

Constant Field Values

CALLED_NOANS_TERM_TRIGGER

public static final java.lang.String CALLED_NOANS_TERM_TRIGGER

See Also:

Constant Field Values

CALLED_NOT_AVAIL_TERM_TRIGGER

public static final java.lang.String CALLED_NOT_AVAIL_TERM_TRIGGER

See Also:

Constant Field Values

CALLED_ADDRESS_TERM_TRIGGER

public static final java.lang.String CALLED_ADDRESS_TERM_TRIGGER

See Also:

Constant Field Values

Constructor Detail

TriggerInfo

public TriggerInfo()

A constructor for this class.

Method Detail

getMessage

public java.lang.Object getMessage()

Getter for the message parameter. The message is a serializable object that contains the SIP message that caused this trigger. In case of SIP, the message is a string containing the entire SIP message.

Returns:

the message object

getProtocol

public java.lang.String getProtocol()

Getter for the protocol parameter. The value is always "SIP".

Returns:

the protocol name.

setMessage

public void setMessage(java.lang.Object message)

Setter for the Message parameter.

Parameters:

message - the message to set.

setProtocol

public void setProtocol(java.lang.String protocol)

Setter for the protocol parameter.

Parameters:

protocol - the name of the protocol to set.

getCalledSubscriber

public Subscriber getCalledSubscriber()

Getter for the called subscriber object.

Returns:

a subscriber object, or null if the called party is not a subscriber.

setCalledSubscriber

public void setCalledSubscriber(Subscriber calledSubscriber)

Setter for the called subscriber object.

Parameters:

calledSubscriber - the subscriber object to set.

getCallingSubscriber

public Subscriber getCallingSubscriber()

Getter for the calling subscriber object.

Returns:

a subscriber object, or null if the calling party is not a subscriber.

setCallingSubscriber

public void setCallingSubscriber(Subscriber callingSubscriber)

Setter for the calling subscriber object.

Parameters:

callingSubscriber - the subscriber object to set.

getFeature

public java.lang.String getFeature()

Getter for the feature name.

Returns:

the feature name.

setFeature

public void setFeature(java.lang.String feature)

Setter for the feature name.

Parameters:

feature - name of the feature to set.

getCalledDomain

public Domain getCalledDomain()

Getter for the called domain object. The called domain object contains the domain information about the domain to which the called address belongs to.

Returns:

the called domain object, or null, if the called domain is not managed by the SipExchange server.

setCalledDomain

public void setCalledDomain(Domain calledDomain)

Setter for the called domain object.

Parameters:

calledDomain - the domain object to set.

getCallingDomain

public Domain getCallingDomain()

Getter for the calling domain object. The calling domain object contains the domain information about the domain to which the calling address belongs to.

Returns:

the calling domain object, or null, if the calling domain is not managed by the SipExchange server.

setCallingDomain

public void setCallingDomain(Domain callingDomain)

The setter for the calling domain object.

Parameters:

callingDomain - the domain object to set.

getParam

public java.lang.Object getParam()

Getter for the param object.

Returns:

the param object if set, else it returns null.

setParam

public void setParam(java.lang.Object param)

Setter for the param object.

Parameters:

param - the param object to set.

printTriggerInfo

public static java.lang.String printTriggerInfo(TriggerInfo trigger)

This method returns formatted information on a trigger. You can use this routine to print trigger information for debugging and informational purposes.

Parameters:

trigger - trigger object

Returns:

formatted output containing the trigger information

getFrom

public java.lang.String getFrom()

Returns:

Returns the from.

setFrom

public void setFrom(java.lang.String from)

Parameters:

from - The from to set.

getTo

public java.lang.String getTo()

Returns:

Returns the to.

setTo

public void setTo(java.lang.String to)

Parameters:

to - The to to set.