org.restlet.ext.sip
Class SipResponse

java.lang.Object
  extended by org.restlet.Message
      extended by org.restlet.Response
          extended by org.restlet.ext.sip.SipResponse

public class SipResponse
extends Response

Response part of a SIP transaction.

Author:
Jerome Louvel

Constructor Summary
SipResponse(Request request)
          Constructor.
 
Method Summary
 Address getAlertInfo()
          Returns the alternative ring tone for the UAC.
 List<EventType> getAllowedEventTypes()
          Returns the list of supported event packages.
 List<Address> getCalleeInfo()
          Returns the description of the current callee.
 String getCallId()
          Returns the identifier of the call.
 String getCommandSequence()
          Returns the identifier of the command.
 List<ContactInfo> getContacts()
          Returns the data about the contacts.
 Address getErrorInfo()
          Returns the pointer to additional information about the error response.
 Event getEvent()
          Returns the description of an event notification.
 Address getFrom()
          Returns the description of the request's initiator.
 String getMimeVersion()
          Returns the version of the MIME protocol used to construct the message.
 String getMinExpires()
          Returns the minimum refresh interval supported for soft-state elements.
 String getOrganization()
          Returns the name of the organization to which the SIP element issuing the message belongs.
 List<Address> getRecordedRoutes()
          Returns the list of routes completed by proxies to force future requests to go through the proxy.
 Address getReplyTo()
          Returns a logical return URI.
 List<SipRecipientInfo> getSipRecipientsInfo()
          Returns the intermediary recipients information.
 Availability getSipRetryAfter()
           
 Tag getSipTag()
          Returns the tag of the returned representation.
 List<OptionTag> getSupported()
          Returns the extensions supported by the UAS.
 Address getTo()
          Returns the logical recipient of the request.
 String getTransactionId()
          Returns the transaction identifier.
 List<OptionTag> getUnsupported()
          Returns the extensions not supported by the UAS.
 void setAlertInfo(Address alertInfo)
          Sets the alternative ring tone for the UAC.
 void setAllowedEventTypes(List<EventType> allowedEventTypes)
          Sets the list of supported event packages.
 void setCalleeInfo(List<Address> calleeInfo)
          Sets the description of the current callee.
 void setCallId(String callId)
          Sets the identifier of the call.
 void setCommandSequence(String commandSequence)
          Sets the identifier of the command.
 void setContacts(List<ContactInfo> contact)
          Sets the data about the contact.
 void setErrorInfo(Address errorInfo)
          Sets the pointer to additional information about the error response.
 void setEvent(Event event)
          Sets the description of an event notification.
 void setFrom(Address from)
          Sets the description of the request's initiator.
 void setMimeVersion(String mimeVersion)
          Sets the version of the MIME protocol used to construct the message.
 void setMinExpires(String minExpires)
          Sets the minimum refresh interval supported for soft-state elements.
 void setOrganization(String organization)
          Sets the name of the organization to which the SIP element issuing the message belongs.
 void setRecordedRoutes(List<Address> recordedRoutes)
          Sets the list of routes completed by proxies to force future requests to go through the proxy.
 void setReplyTo(Address replyTo)
          Sets a logical return URI.
 void setSipRecipientsInfo(List<SipRecipientInfo> recipientsInfo)
          Sets the intermediary recipients information.
 void setSipRetryAfter(Availability retryAfter)
          Sets the delay after which a request should be retried.
 void setSipTag(Tag sipTag)
          Sets the tag of the returned representation.
 void setSupported(List<OptionTag> supported)
          Sets the extensions supported by the UAS.
 void setTo(Address to)
          Sets the logical recipient of the request.
 void setUnsupported(List<OptionTag> unsupported)
          Sets the extensions not supported by the UAS.
 
Methods inherited from class org.restlet.Response
abort, commit, getAge, getAllowedMethods, getAuthenticationInfo, getChallengeRequests, getCookieSettings, getCurrent, getDimensions, getLocationRef, getProxyChallengeRequests, getRequest, getRetryAfter, getServerInfo, getStatus, isAutoCommitting, isCommitted, isConfidential, isFinal, isProvisional, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAge, setAllowedMethods, setAuthenticationInfo, setAutoCommitting, setChallengeRequests, setCommitted, setCookieSettings, setCurrent, setDimensions, setLocationRef, setLocationRef, setProxyChallengeRequests, setRequest, setRetryAfter, setServerInfo, setStatus, setStatus, setStatus, setStatus, toString
 
Methods inherited from class org.restlet.Message
getAttributes, getCacheDirectives, getDate, getEntity, getEntityAsText, getOnError, getOnSent, getRecipientsInfo, getWarnings, isEntityAvailable, release, setAttributes, setCacheDirectives, setDate, setEntity, setEntity, setOnError, setOnSent, setRecipientsInfo, setWarnings
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SipResponse

public SipResponse(Request request)
Constructor.

Parameters:
request - The associated request.
Method Detail

getAlertInfo

public Address getAlertInfo()
Returns the alternative ring tone for the UAC.

Returns:
The alternative ring tone for the UAC.

getAllowedEventTypes

public List<EventType> getAllowedEventTypes()
Returns the list of supported event packages.

Returns:
The list of supported event packages.

getCalleeInfo

public List<Address> getCalleeInfo()
Returns the description of the current callee.

Returns:
The description of the current callee.

getCallId

public String getCallId()
Returns the identifier of the call.

Returns:
The identifier of the call.

getCommandSequence

public String getCommandSequence()
Returns the identifier of the command.

Returns:
The identifier of the command.

getContacts

public List<ContactInfo> getContacts()
Returns the data about the contacts.

Returns:
The data about the contacts.

getErrorInfo

public Address getErrorInfo()
Returns the pointer to additional information about the error response.

Returns:
The pointer to additional information about the error response.

getEvent

public Event getEvent()
Returns the description of an event notification.

Returns:
The description of an event notification.

getFrom

public Address getFrom()
Returns the description of the request's initiator.

Returns:
The description of the request's initiator.

getMimeVersion

public String getMimeVersion()
Returns the version of the MIME protocol used to construct the message.

Returns:
The version of the MIME protocol used to construct the message.

getMinExpires

public String getMinExpires()
Returns the minimum refresh interval supported for soft-state elements.

Returns:
The minimum refresh interval supported for soft-state elements.

getOrganization

public String getOrganization()
Returns the name of the organization to which the SIP element issuing the message belongs.

Returns:
The name of the organization to which the SIP element issuing the message belongs.

getRecordedRoutes

public List<Address> getRecordedRoutes()
Returns the list of routes completed by proxies to force future requests to go through the proxy.

Returns:
The list of routes completed by proxies to force future requests to go through the proxy.

getReplyTo

public Address getReplyTo()
Returns a logical return URI.

Returns:
A logical return URI.

getSipRecipientsInfo

public List<SipRecipientInfo> getSipRecipientsInfo()
Returns the intermediary recipients information.

Returns:
The intermediary recipients information.

getSipRetryAfter

public Availability getSipRetryAfter()

getSipTag

public Tag getSipTag()
Returns the tag of the returned representation.

Returns:
The tag of the returned representation.

getSupported

public List<OptionTag> getSupported()
Returns the extensions supported by the UAS.

Returns:
The extensions supported by the UAS.

getTo

public Address getTo()
Returns the logical recipient of the request.

Returns:
The logical recipient of the request.

getTransactionId

public String getTransactionId()
Returns the transaction identifier. It uses the "branch" parameter of the Via header if possible or a hash of several other fields.

Returns:
The transaction identifier.

getUnsupported

public List<OptionTag> getUnsupported()
Returns the extensions not supported by the UAS.

Returns:
The extensions not supported by the UAS.

setAlertInfo

public void setAlertInfo(Address alertInfo)
Sets the alternative ring tone for the UAC.

Parameters:
alertInfo - The alternative ring tone for the UAC.

setAllowedEventTypes

public void setAllowedEventTypes(List<EventType> allowedEventTypes)
Sets the list of supported event packages.

Parameters:
allowedEventTypes - The list of supported event packages.

setCalleeInfo

public void setCalleeInfo(List<Address> calleeInfo)
Sets the description of the current callee.

Parameters:
calleeInfo - The description of the current callee.

setCallId

public void setCallId(String callId)
Sets the identifier of the call.

Parameters:
callId - The identifier of the call.

setCommandSequence

public void setCommandSequence(String commandSequence)
Sets the identifier of the command.

Parameters:
commandSequence - The identifier of the command.

setContacts

public void setContacts(List<ContactInfo> contact)
Sets the data about the contact.

Parameters:
contact - The data about the contact.

setErrorInfo

public void setErrorInfo(Address errorInfo)
Sets the pointer to additional information about the error response.

Parameters:
errorInfo - The pointer to additional information about the error response.

setEvent

public void setEvent(Event event)
Sets the description of an event notification.

Parameters:
event - The description of an event notification.

setFrom

public void setFrom(Address from)
Sets the description of the request's initiator.

Parameters:
from - The description of the request's initiator.

setMimeVersion

public void setMimeVersion(String mimeVersion)
Sets the version of the MIME protocol used to construct the message.

Parameters:
mimeVersion - The version of the MIME protocol used to construct the message.

setMinExpires

public void setMinExpires(String minExpires)
Sets the minimum refresh interval supported for soft-state elements.

Parameters:
minExpires - The minimum refresh interval supported for soft-state elements.

setOrganization

public void setOrganization(String organization)
Sets the name of the organization to which the SIP element issuing the message belongs.

Parameters:
organization - The name of the organization to which the SIP element issuing the message belongs.

setRecordedRoutes

public void setRecordedRoutes(List<Address> recordedRoutes)
Sets the list of routes completed by proxies to force future requests to go through the proxy.

Parameters:
recordedRoutes - The list of routes completed by proxies to force future requests to go through the proxy.

setReplyTo

public void setReplyTo(Address replyTo)
Sets a logical return URI.

Parameters:
replyTo - A logical return URI.

setSipRecipientsInfo

public void setSipRecipientsInfo(List<SipRecipientInfo> recipientsInfo)
Sets the intermediary recipients information.

Parameters:
recipientsInfo - The intermediary recipients information.

setSipRetryAfter

public void setSipRetryAfter(Availability retryAfter)
Sets the delay after which a request should be retried.

Parameters:
retryAfter - The delay after which a request should be retried.

setSipTag

public void setSipTag(Tag sipTag)
Sets the tag of the returned representation.

Parameters:
sipTag - The tag of the returned representation.

setSupported

public void setSupported(List<OptionTag> supported)
Sets the extensions supported by the UAS.

Parameters:
supported - The extensions supported by the UAS.

setTo

public void setTo(Address to)
Sets the logical recipient of the request.

Parameters:
to - The logical recipient of the request.

setUnsupported

public void setUnsupported(List<OptionTag> unsupported)
Sets the extensions not supported by the UAS.

Parameters:
unsupported - The extensions not supported by the UAS.


Copyright © 2005-2013 Restlet.