org.cafesip.sipexchange.inservice.shared
Class TerminateResponse

java.lang.Object
  org.cafesip.sipexchange.inservice.shared.Response
      org.cafesip.sipexchange.inservice.shared.TerminateResponse

All Implemented Interfaces:

java.io.Serializable

public class TerminateResponse
extends Response
implements java.io.Serializable

An object belonging to this class is returned by the SCP to the SipExchange server in response to an invocation to indicate that the call session must be terminated.

The setter methods are used by the SCP to populate this object. The getter methods can be used by the SipExchange to get the information about the status code, reason, etc.

See Also:

Serialized Form

Constructor Summary

TerminateResponse()
A constructor for this class.

Method Summary

java.lang.String	getReason() A getter for the reason phrase.
int	getStatusCode() Getter for the status code.
void	setReason(java.lang.String reason) Setter for the reason phrase.
void	setStatusCode(int statusCode) Setter for the status code.

Methods inherited from class org.cafesip.sipexchange.inservice.shared.Response

getCdrs, setCdrs

Methods inherited from class java.lang.Object

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

Constructor Detail

TerminateResponse

public TerminateResponse()

A constructor for this class.

Method Detail

getStatusCode

public int getStatusCode()

Getter for the status code. This status code must match the SIP status code and is sent to the called party in a SIP terminating response message.

Returns:

the status code.

setStatusCode

public void setStatusCode(int statusCode)

Setter for the status code. The SCP must set a valid SIP status code.

Parameters:

statusCode - the status code value to set.

getReason

public java.lang.String getReason()

A getter for the reason phrase. If populated by the SCP, this string is passed as a SIP reason phrase with the SIP terminating response message.

Returns:

the reason phrase.

setReason

public void setReason(java.lang.String reason)

Setter for the reason phrase. It is optional for the SCP to set a reason phrase.

Parameters:

reason - reason phrase to set.