org.restlet.ext.sip

Class SipRequest

java.lang.Object

org.restlet.Message

org.restlet.Request

org.restlet.ext.sip.SipRequest

Direct Known Subclasses:

SipInboundRequest

Deprecated.

Will be removed to focus on Web APIs.

@Deprecated
public class SipRequest
extends Request

Request part of a SIP transaction.

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
SipRequest() Deprecated. Constructor.
SipRequest(Method method, Reference resourceRef) Deprecated. Constructor.
SipRequest(Method method, Reference resourceRef, Representation entity) Deprecated. Constructor.
SipRequest(Method method, String resourceUri) Deprecated. Constructor.
SipRequest(Method method, String resourceUri, Representation entity) Deprecated. Constructor.
SipRequest(SipRequest request) Deprecated. Copy constructor.

Method Summary

Modifier and Type	Method and Description
Address	getAlertInfo() Deprecated. Returns the alternative ring tone for the UAS.
List<EventType>	getAllowedEventTypes() Deprecated. Returns the list of supported event packages.
List<Address>	getCallerInfo() Deprecated. Returns the description of the current caller.
String	getCallId() Deprecated. Returns the identifier of the call.
String	getCommandSequence() Deprecated. Returns the identifier of the command.
List<ContactInfo>	getContacts() Deprecated. Returns the data about the contacts.
long	getCreation() Deprecated. Returns the creation time.
Event	getEvent() Deprecated. Returns the description of an event notification.
Address	getFrom() Deprecated. Returns the description of the request's initiator.
List<String>	getInReplyTo() Deprecated. Returns The list of references to call-ids.
long	getLastActivity() Deprecated. Returns the date of last activity on this transaction object.
int	getMaxIdleTimeMs() Deprecated. Returns the timeout in milliseconds.
String	getMimeVersion() Deprecated. Returns the version of the MIME protocol used to construct the message.
String	getOrganization() Deprecated. Returns the name of the organization to which the SIP element issuing the message belongs.
Priority	getPriority() Deprecated. Returns the urgency of the request as perceived by the client.
List<OptionTag>	getProxyRequires() Deprecated. Returns the proxy-sensitive features that the proxy must support.
List<Address>	getRecordedRoutes() Deprecated. Returns the list of routes completed by proxies to force future requests to go through the proxy.
Address	getReferTo() Deprecated. Returns the reference that the recipient of a SipMethod.REFER method should contact.
Address	getReplyTo() Deprecated. Returns a logical return URI.
List<OptionTag>	getRequires() Deprecated. Returns the sensitive features that the server must support.
List<Address>	getRoutes() Deprecated. Returns the set of proxies used to force routing for a request.
Tag	getSipIfMatch() Deprecated. Returns the identifier of the specific event state that the request is refreshing.
List<SipRecipientInfo>	getSipRecipientsInfo() Deprecated. Returns the intermediary recipients information.
String	getSubject() Deprecated. Returns the subject of the call.
Subscription	getSubscriptionState() Deprecated. Returns the state of the subscription.
List<OptionTag>	getSupported() Deprecated. Returns the extensions supported by the UAC.
Address	getTo() Deprecated. Returns the logical recipient of the request.
String	getTransaction() Deprecated. Returns the transaction identifier.
boolean	hasTimedOut() Deprecated. Indicates if the transaction has timed out due to lack of activity.
boolean	isHandled() Deprecated. Indicates that the request has been handled, typically after receiving a final response.
void	setAlertInfo(Address alertInfo) Deprecated. Sets the alternative ring tone for the UAS.
void	setAllowedEventTypes(List<EventType> allowedEventTypes) Deprecated. Sets the list of supported event packages.
void	setCallerInfo(List<Address> callerInfo) Deprecated. Sets the description of the current caller.
void	setCallId(String callId) Deprecated. Sets the identifier of the call.
void	setCommandSequence(String commandSequence) Deprecated. Sets the identifier of the command.
void	setContacts(List<ContactInfo> contact) Deprecated. Sets the data about the contacts.
void	setEvent(Event event) Deprecated. Sets the description of an event notification.
void	setFrom(Address from) Deprecated. Sets the description of the request's initiator.
void	setHandled(boolean handled) Deprecated. Indicates that the request has been handled, typically after receiving a final response.
void	setInReplyTo(List<String> inReplyTo) Deprecated. Sets the list of references to call-ids.
void	setMimeVersion(String mimeVersion) Deprecated. Sets the version of the MIME protocol used to construct the message.
void	setOrganization(String organization) Deprecated. Sets the name of the organization to which the SIP element issuing the message belongs.
void	setPriority(Priority priority) Deprecated. Sets the urgency of the request as perceived by the client.
void	setProxyRequires(List<OptionTag> proxyRequires) Deprecated. Sets the proxy-sensitive features that the proxy must support.
void	setRecordedRoutes(List<Address> recordedRoutes) Deprecated. Sets the list of routes completed by proxies to force future requests to go through the proxy.
void	setReferTo(Address referTo) Deprecated. Sets the reference that the recipient of a SipMethod.REFER method should contact.
void	setReplyTo(Address replyTo) Deprecated. Sets a logical return URI.
void	setRequires(List<OptionTag> requires) Deprecated. Sets the sensitive features that the server must support.
void	setRoutes(List<Address> routes) Deprecated. Sets the set of proxies used to force routing for a request.
void	setSipIfMatch(Tag sipIfMatch) Deprecated. Sets the identifier of the specific event state that the request is refreshing.
void	setSipRecipientsInfo(List<SipRecipientInfo> recipientsInfo) Deprecated. Sets the intermediary recipients information.
void	setSubject(String subject) Deprecated. Sets the subject of the call.
void	setSubscriptionState(Subscription subscription) Deprecated. Sets the state of the subscription.
void	setSupported(List<OptionTag> supported) Deprecated. Sets the extensions supported by the UAC.
void	setTo(Address to) Deprecated. Sets the logical recipient of the request.
void	updateLastActivity() Deprecated. Indicates that a new activity on this transaction has been detected.

Methods inherited from class org.restlet.Request

abort, commit, getAccessControlRequestHeaders, getAccessControlRequestMethod, getChallengeResponse, getClientInfo, getConditions, getCookies, getCurrent, getHostRef, getMaxForwards, getMethod, getOnResponse, getOriginalRef, getProtocol, getProxyChallengeResponse, getRanges, getReferrerRef, getResourceRef, getRootRef, isAsynchronous, isConfidential, isEntityAvailable, isExpectingResponse, isLoggable, isSynchronous, setAccessControlRequestHeaders, setAccessControlRequestMethod, setChallengeResponse, setClientInfo, setConditions, setCookies, setHostRef, setHostRef, setLoggable, setMaxForwards, setMethod, setOnResponse, setOriginalRef, setProtocol, setProxyChallengeResponse, setRanges, setReferrerRef, setReferrerRef, setResourceRef, setResourceRef, setRootRef, toString

Methods inherited from class org.restlet.Message

bufferEntity, flushBuffers, getAttributes, getCacheDirectives, getDate, getEntity, getEntityAsText, getHeaders, getOnError, getOnSent, getRecipientsInfo, getWarnings, 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

SipRequest

public SipRequest()

Deprecated.

Constructor.

SipRequest

public SipRequest(Method method,
                  Reference resourceRef)

Deprecated.

Constructor.

Parameters:

method - The call's method.

resourceRef - The resource reference.

SipRequest

public SipRequest(Method method,
                  Reference resourceRef,
                  Representation entity)

Deprecated.

Constructor.

Parameters:

method - The call's method.

resourceRef - The resource reference.

entity - The entity.

SipRequest

public SipRequest(Method method,
                  String resourceUri)

Deprecated.

Constructor.

Parameters:

method - The call's method.

resourceUri - The resource URI.

SipRequest

public SipRequest(Method method,
                  String resourceUri,
                  Representation entity)

Deprecated.

Constructor.

Parameters:

method - The call's method.

resourceUri - The resource URI.

entity - The entity.

SipRequest

public SipRequest(SipRequest request)

Deprecated.

Copy constructor.

Parameters:

request - The request to copy.

Method Detail

getAlertInfo

public Address getAlertInfo()

Deprecated.

Returns the alternative ring tone for the UAS.

Returns:

The alternative ring tone for the UAS.

getAllowedEventTypes

public List<EventType> getAllowedEventTypes()

Deprecated.

Returns the list of supported event packages.

Returns:

The list of supported event packages.

getCallerInfo

public List<Address> getCallerInfo()

Deprecated.

Returns the description of the current caller.

Returns:

The description of the current caller.

getCallId

public String getCallId()

Deprecated.

Returns the identifier of the call.

Returns:

The identifier of the call.

getCommandSequence

public String getCommandSequence()

Deprecated.

Returns the identifier of the command.

Returns:

The identifier of the command.

getContacts

public List<ContactInfo> getContacts()

Deprecated.

Returns the data about the contacts.

Returns:

The data about the contacts.

getCreation

public long getCreation()

Deprecated.

Returns the creation time.

Returns:

The creation time.

getEvent

public Event getEvent()

Deprecated.

Returns the description of an event notification.

Returns:

The description of an event notification.

getFrom

public Address getFrom()

Deprecated.

Returns the description of the request's initiator.

Returns:

The description of the request's initiator.

getInReplyTo

public List<String> getInReplyTo()

Deprecated.

Returns The list of references to call-ids.

Returns:

The list of references to call-ids.

getLastActivity

public long getLastActivity()

Deprecated.

Returns the date of last activity on this transaction object.

Returns:

The date of last activity on this transaction object.

getMaxIdleTimeMs

public int getMaxIdleTimeMs()

Deprecated.

Returns the timeout in milliseconds.

Returns:

The timeout in milliseconds.

getMimeVersion

public String getMimeVersion()

Deprecated.

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

Returns:

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

getOrganization

public String getOrganization()

Deprecated.

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.

getPriority

public Priority getPriority()

Deprecated.

Returns the urgency of the request as perceived by the client.

Returns:

The urgency of the request as perceived by the client.

getProxyRequires

public List<OptionTag> getProxyRequires()

Deprecated.

Returns the proxy-sensitive features that the proxy must support.

Returns:

The proxy-sensitive features that the proxy must support.

getRecordedRoutes

public List<Address> getRecordedRoutes()

Deprecated.

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.

getReferTo

public Address getReferTo()

Deprecated.

Returns the reference that the recipient of a SipMethod.REFER method should contact.

Returns:

The reference that the recipient of a SipMethod.REFER method should contact.

getReplyTo

public Address getReplyTo()

Deprecated.

Returns a logical return URI.

Returns:

A logical return URI.

getRequires

public List<OptionTag> getRequires()

Deprecated.

Returns the sensitive features that the server must support.

Returns:

The sensitive features that the server must support.

getRoutes

public List<Address> getRoutes()

Deprecated.

Returns the set of proxies used to force routing for a request.

Returns:

The set of proxies used to force routing for a request.

getSipIfMatch

public Tag getSipIfMatch()

Deprecated.

Returns the identifier of the specific event state that the request is refreshing.

Returns:

The identifier of the specific event state that the request is refreshing.

getSipRecipientsInfo

public List<SipRecipientInfo> getSipRecipientsInfo()

Deprecated.

Returns the intermediary recipients information.

Returns:

The intermediary recipients information.

getSubject

public String getSubject()

Deprecated.

Returns the subject of the call.

Returns:

The subject of the call.

getSubscriptionState

public Subscription getSubscriptionState()

Deprecated.

Returns the state of the subscription.

Returns:

The state of the subscription.

getSupported

public List<OptionTag> getSupported()

Deprecated.

Returns the extensions supported by the UAC.

Returns:

The extensions supported by the UAC.

getTo

public Address getTo()

Deprecated.

Returns the logical recipient of the request.

Returns:

The logical recipient of the request.

getTransaction

public String getTransaction()

Deprecated.

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.

hasTimedOut

public boolean hasTimedOut()

Deprecated.

Indicates if the transaction has timed out due to lack of activity.

Returns:

True if the transaction has timed out due to lack of activity.

isHandled

public boolean isHandled()

Deprecated.

Indicates that the request has been handled, typically after receiving a final response.

Returns:

True if the request has been handled.

setAlertInfo

public void setAlertInfo(Address alertInfo)

Deprecated.

Sets the alternative ring tone for the UAS.

Parameters:

alertInfo - The alternative ring tone for the UAS.

setAllowedEventTypes

public void setAllowedEventTypes(List<EventType> allowedEventTypes)

Deprecated.

Sets the list of supported event packages.

Parameters:

allowedEventTypes - The list of supported event packages.

setCallerInfo

public void setCallerInfo(List<Address> callerInfo)

Deprecated.

Sets the description of the current caller.

Parameters:

callerInfo - The description of the current caller.

setCallId

public void setCallId(String callId)

Deprecated.

Sets the identifier of the call.

Parameters:

callId - The identifier of the call.

setCommandSequence

public void setCommandSequence(String commandSequence)

Deprecated.

Sets the identifier of the command.

Parameters:

commandSequence - The identifier of the command.

setContacts

public void setContacts(List<ContactInfo> contact)

Deprecated.

Sets the data about the contacts.

Parameters:

contact - The data about the contacts.

setEvent

public void setEvent(Event event)

Deprecated.

Sets the description of an event notification.

Parameters:

event - The description of an event notification.

setFrom

public void setFrom(Address from)

Deprecated.

Sets the description of the request's initiator.

Parameters:

from - The description of the request's initiator.

setHandled

public void setHandled(boolean handled)

Deprecated.

Indicates that the request has been handled, typically after receiving a final response.

Parameters:

handled - True if the request has been handled.

setInReplyTo

public void setInReplyTo(List<String> inReplyTo)

Deprecated.

Sets the list of references to call-ids.

Parameters:

inReplyTo - The list of references to call-ids.

setMimeVersion

public void setMimeVersion(String mimeVersion)

Deprecated.

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.

setOrganization

public void setOrganization(String organization)

Deprecated.

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.

setPriority

public void setPriority(Priority priority)

Deprecated.

Sets the urgency of the request as perceived by the client.

Parameters:

priority - The urgency of the request as perceived by the client.

setProxyRequires

public void setProxyRequires(List<OptionTag> proxyRequires)

Deprecated.

Sets the proxy-sensitive features that the proxy must support.

Parameters:

proxyRequires - The proxy-sensitive features that the proxy must support.

setRecordedRoutes

public void setRecordedRoutes(List<Address> recordedRoutes)

Deprecated.

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.

setReferTo

public void setReferTo(Address referTo)

Deprecated.

Sets the reference that the recipient of a SipMethod.REFER method should contact.

Parameters:

referTo - The reference that the recipient of a SipMethod.REFER method should contact.

setReplyTo

public void setReplyTo(Address replyTo)

Deprecated.

Sets a logical return URI.

Parameters:

replyTo - A logical return URI.

setRequires

public void setRequires(List<OptionTag> requires)

Deprecated.

Sets the sensitive features that the server must support.

Parameters:

requires - The sensitive features that the server must support.

setRoutes

public void setRoutes(List<Address> routes)

Deprecated.

Sets the set of proxies used to force routing for a request.

Parameters:

routes - The set of proxies used to force routing for a request.

setSipIfMatch

public void setSipIfMatch(Tag sipIfMatch)

Deprecated.

Sets the identifier of the specific event state that the request is refreshing.

Parameters:

sipIfMatch - The identifier of the specific event state that the request is refreshing.

setSipRecipientsInfo

public void setSipRecipientsInfo(List<SipRecipientInfo> recipientsInfo)

Deprecated.

Sets the intermediary recipients information.

Parameters:

recipientsInfo - The intermediary recipients information.

setSubject

public void setSubject(String subject)

Deprecated.

Sets the subject of the call.

Parameters:

subject - the subject of the call.

setSubscriptionState

public void setSubscriptionState(Subscription subscription)

Deprecated.

Sets the state of the subscription.

Parameters:

subscription - The state of the subscription.

setSupported

public void setSupported(List<OptionTag> supported)

Deprecated.

Sets the extensions supported by the UAC.

Parameters:

supported - The extensions supported by the UAC.

setTo

public void setTo(Address to)

Deprecated.

Sets the logical recipient of the request.

Parameters:

to - The logical recipient of the request.

updateLastActivity

public void updateLastActivity()

Deprecated.

Indicates that a new activity on this transaction has been detected.