org.restlet.ext.sip.internal

Class SipInboundRequest

java.lang.Object

org.restlet.Message

org.restlet.Request

org.restlet.ext.sip.SipRequest

org.restlet.ext.sip.internal.SipInboundRequest

All Implemented Interfaces:

InboundRequest

public class SipInboundRequest
extends SipRequest
implements InboundRequest

Request part of a SIP transaction.

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
SipInboundRequest(Context context, Connection<Server> connection, String methodName, String resourceUri, String protocol) Constructor.
SipInboundRequest(SipInboundRequest request) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	abort() Ask the connector to attempt to abort the related network connection, for example immediately closing the socket.
void	commit(Response response) Asks the server connector to immediately commit the given response associated to this request, making it ready to be sent back to the client.
Address	getAlertInfo() Returns the alternative ring tone for the UAS.
List<EventType>	getAllowedEventTypes() Returns the list of supported event packages.
List<CacheDirective>	getCacheDirectives() Returns the cache directives. Note that when used with HTTP connectors, this property maps to the "Cache-Control" header.
List<Address>	getCallerInfo() Returns the description of the current caller.
ChallengeResponse	getChallengeResponse() Returns the authentication response sent by a client to an origin server.
ClientInfo	getClientInfo() Returns the client-specific information.
Conditions	getConditions() Returns the condition data applying to this call.
Connection<Server>	getConnection() Returns the related connection.
List<ContactInfo>	getContacts() Returns the data about the contacts.
Series<Cookie>	getCookies() Returns the cookies provided by the client.
Event	getEvent() Returns the description of an event notification.
Series<Header>	getHeaders() Returns the HTTP headers.
List<String>	getInReplyTo() Returns The list of references to call-ids.
Priority	getPriority() Returns the urgency of the request as perceived by the client.
ChallengeResponse	getProxyChallengeResponse() Returns the authentication response sent by a client to a proxy.
List<OptionTag>	getProxyRequires() Returns the proxy-sensitive features that the proxy must support.
List<Range>	getRanges() Returns the ranges to return from the target resource's representation.
List<RecipientInfo>	getRecipientsInfo() Returns the intermediary recipient information. Note that when used with HTTP connectors, this property maps to the "Via" headers.
List<Address>	getRecordedRoutes() Returns the list of routes completed by proxies to force future requests to go through the proxy.
Reference	getReferrerRef() Returns the referrer reference if available.
Address	getReferTo() Returns the reference that the recipient of a SipMethod.REFER method should contact.
Address	getReplyTo() Returns a logical return URI.
List<OptionTag>	getRequires() Returns the sensitive features that the server must support.
List<Address>	getRoutes() Returns the set of proxies used to force routing for a request.
Tag	getSipIfMatch() Returns the identifier of the specific event state that the request is refreshing.
List<SipRecipientInfo>	getSipRecipientsInfo() Returns the intermediary recipients information.
Subscription	getSubscriptionState() Returns the state of the subscription.
List<OptionTag>	getSupported() Returns the extensions supported by the UAC.
Principal	getUserPrincipal() Returns the associated user principal.
List<Warning>	getWarnings() Returns the additional warnings information. Note that when used with HTTP connectors, this property maps to the "Warning" headers.
void	setAlertInfo(Address alertInfo) Sets the alternative ring tone for the UAS.
void	setAllowedEventTypes(List<EventType> allowedEventTypes) Sets the list of supported event packages.
void	setCallerInfo(List<Address> callerInfo) Sets the description of the current caller.
void	setChallengeResponse(ChallengeResponse response) Sets the authentication response sent by a client to an origin server.
void	setContacts(List<ContactInfo> contact) Sets the data about the contacts.
void	setEvent(Event event) Sets the description of an event notification.
void	setHeaders(Series<Header> headers) Put the headers in the request's attributes map.
void	setInReplyTo(List<String> inReplyTo) Sets the list of references to call-ids.
void	setPriority(Priority priority) Sets the urgency of the request as perceived by the client.
void	setProxyChallengeResponse(ChallengeResponse response) Sets the authentication response sent by a client to a proxy.
void	setProxyRequires(List<OptionTag> proxyRequires) Sets the proxy-sensitive features that the proxy must support.
void	setRecipientsInfo(List<RecipientInfo> recipientsInfo) Sets the modifiable list of intermediary recipients.
void	setRecordedRoutes(List<Address> recordedRoutes) Sets the list of routes completed by proxies to force future requests to go through the proxy.
void	setReferTo(Address referTo) Sets the reference that the recipient of a SipMethod.REFER method should contact.
void	setReplyTo(Address replyTo) Sets a logical return URI.
void	setRequires(List<OptionTag> requires) Sets the sensitive features that the server must support.
void	setRoutes(List<Address> routes) Sets the set of proxies used to force routing for a request.
void	setSipIfMatch(Tag sipIfMatch) Sets the identifier of the specific event state that the request is refreshing.
void	setSipRecipientsInfo(List<SipRecipientInfo> recipientsInfo) Sets the intermediary recipients information.
void	setSubscriptionState(Subscription subscription) Sets the state of the subscription.
void	setSupported(List<OptionTag> supported) Sets the extensions supported by the UAC.
void	setWarnings(List<Warning> warnings) Sets the additional warnings information.

Methods inherited from class org.restlet.ext.sip.SipRequest

getCallId, getCommandSequence, getCreation, getFrom, getLastActivity, getMaxIdleTimeMs, getMimeVersion, getOrganization, getSubject, getTo, getTransaction, hasTimedOut, isHandled, setCallId, setCommandSequence, setFrom, setHandled, setMimeVersion, setOrganization, setSubject, setTo, updateLastActivity

Methods inherited from class org.restlet.Request

getCurrent, getHostRef, getMaxForwards, getMethod, getOnResponse, getOriginalRef, getProtocol, getResourceRef, getRootRef, isAsynchronous, isConfidential, isEntityAvailable, isExpectingResponse, isLoggable, isSynchronous, setClientInfo, setConditions, setCookies, setHostRef, setHostRef, setLoggable, setMaxForwards, setMethod, setOnResponse, setOriginalRef, setProtocol, setRanges, setReferrerRef, setReferrerRef, setResourceRef, setResourceRef, setRootRef, toString

Methods inherited from class org.restlet.Message

getAttributes, getDate, getEntity, getEntityAsText, getOnError, getOnSent, release, setAttributes, setCacheDirectives, setDate, setEntity, setEntity, setOnError, setOnSent

Methods inherited from class java.lang.Object

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

Constructor Detail

SipInboundRequest

public SipInboundRequest(Context context,
                         Connection<Server> connection,
                         String methodName,
                         String resourceUri,
                         String protocol)

Constructor.

Parameters:

context - The context of the parent connector.

connection - The associated network connection.

methodName - The protocol method name.

resourceUri - The target resource URI.

protocol - The protocol name and version.

SipInboundRequest

public SipInboundRequest(SipInboundRequest request)

Copy constructor.

Parameters:

request - The request to copy.

Method Detail

abort

public boolean abort()

Description copied from class: Request

Ask the connector to attempt to abort the related network connection, for example immediately closing the socket.

Overrides:

abort in class Request

Returns:

True if the request was aborted.

commit

public void commit(Response response)

Description copied from class: Request

Asks the server connector to immediately commit the given response associated to this request, making it ready to be sent back to the client. Note that all server connectors don't necessarily support this feature.

Overrides:

commit in class Request

getAlertInfo

public Address getAlertInfo()

Description copied from class: SipRequest

Returns the alternative ring tone for the UAS.

Overrides:

getAlertInfo in class SipRequest

Returns:

The alternative ring tone for the UAS.

getAllowedEventTypes

public List<EventType> getAllowedEventTypes()

Description copied from class: SipRequest

Returns the list of supported event packages.

Overrides:

getAllowedEventTypes in class SipRequest

Returns:

The list of supported event packages.

getCacheDirectives

public List<CacheDirective> getCacheDirectives()

Description copied from class: Message

Returns the cache directives.

Note that when used with HTTP connectors, this property maps to the "Cache-Control" header.

Overrides:

getCacheDirectives in class Message

Returns:

The cache directives.

getCallerInfo

public List<Address> getCallerInfo()

Description copied from class: SipRequest

Returns the description of the current caller.

Overrides:

getCallerInfo in class SipRequest

Returns:

The description of the current caller.

getChallengeResponse

public ChallengeResponse getChallengeResponse()

Description copied from class: Request

Returns the authentication response sent by a client to an origin server. Note that when used with HTTP connectors, this property maps to the "Authorization" header.

Overrides:

getChallengeResponse in class Request

Returns:

The authentication response sent by a client to an origin server.

getClientInfo

public ClientInfo getClientInfo()

Returns the client-specific information.

Overrides:

getClientInfo in class Request

Returns:

The client-specific information.

getConditions

public Conditions getConditions()

Returns the condition data applying to this call.

Overrides:

getConditions in class Request

Returns:

The condition data applying to this call.

getConnection

public Connection<Server> getConnection()

Returns the related connection.

Specified by:

getConnection in interface InboundRequest

Returns:

The related connection.

getContacts

public List<ContactInfo> getContacts()

Description copied from class: SipRequest

Returns the data about the contacts.

Overrides:

getContacts in class SipRequest

Returns:

The data about the contacts.

getCookies

public Series<Cookie> getCookies()

Returns the cookies provided by the client.

Overrides:

getCookies in class Request

Returns:

The cookies provided by the client.

getEvent

public Event getEvent()

Description copied from class: SipRequest

Returns the description of an event notification.

Overrides:

getEvent in class SipRequest

Returns:

The description of an event notification.

getHeaders

public Series<Header> getHeaders()

Returns the HTTP headers.

Specified by:

getHeaders in interface InboundRequest

Returns:

The HTTP headers.

getInReplyTo

public List<String> getInReplyTo()

Description copied from class: SipRequest

Returns The list of references to call-ids.

Overrides:

getInReplyTo in class SipRequest

Returns:

The list of references to call-ids.

getPriority

public Priority getPriority()

Description copied from class: SipRequest

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

Overrides:

getPriority in class SipRequest

Returns:

The urgency of the request as perceived by the client.

getProxyChallengeResponse

public ChallengeResponse getProxyChallengeResponse()

Description copied from class: Request

Returns the authentication response sent by a client to a proxy. Note that when used with HTTP connectors, this property maps to the "Proxy-Authorization" header.

Overrides:

getProxyChallengeResponse in class Request

Returns:

The authentication response sent by a client to a proxy.

getProxyRequires

public List<OptionTag> getProxyRequires()

Description copied from class: SipRequest

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

Overrides:

getProxyRequires in class SipRequest

Returns:

The proxy-sensitive features that the proxy must support.

getRanges

public List<Range> getRanges()

Description copied from class: Request

Returns the ranges to return from the target resource's representation. Note that when used with HTTP connectors, this property maps to the "Range" header.

Overrides:

getRanges in class Request

Returns:

The ranges to return.

getRecipientsInfo

public List<RecipientInfo> getRecipientsInfo()

Description copied from class: Message

Returns the intermediary recipient information.

Note that when used with HTTP connectors, this property maps to the "Via" headers.

Overrides:

getRecipientsInfo in class Message

Returns:

The intermediary recipient information.

getRecordedRoutes

public List<Address> getRecordedRoutes()

Description copied from class: SipRequest

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

Overrides:

getRecordedRoutes in class SipRequest

Returns:

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

getReferrerRef

public Reference getReferrerRef()

Returns the referrer reference if available.

Overrides:

getReferrerRef in class Request

Returns:

The referrer reference.

getReferTo

public Address getReferTo()

Description copied from class: SipRequest

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

Overrides:

getReferTo in class SipRequest

Returns:

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

getReplyTo

public Address getReplyTo()

Description copied from class: SipRequest

Returns a logical return URI.

Overrides:

getReplyTo in class SipRequest

Returns:

A logical return URI.

getRequires

public List<OptionTag> getRequires()

Description copied from class: SipRequest

Returns the sensitive features that the server must support.

Overrides:

getRequires in class SipRequest

Returns:

The sensitive features that the server must support.

getRoutes

public List<Address> getRoutes()

Description copied from class: SipRequest

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

Overrides:

getRoutes in class SipRequest

Returns:

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

getSipIfMatch

public Tag getSipIfMatch()

Description copied from class: SipRequest

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

Overrides:

getSipIfMatch in class SipRequest

Returns:

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

getSipRecipientsInfo

public List<SipRecipientInfo> getSipRecipientsInfo()

Description copied from class: SipRequest

Returns the intermediary recipients information.

Overrides:

getSipRecipientsInfo in class SipRequest

Returns:

The intermediary recipients information.

getSubscriptionState

public Subscription getSubscriptionState()

Description copied from class: SipRequest

Returns the state of the subscription.

Overrides:

getSubscriptionState in class SipRequest

Returns:

The state of the subscription.

getSupported

public List<OptionTag> getSupported()

Description copied from class: SipRequest

Returns the extensions supported by the UAC.

Overrides:

getSupported in class SipRequest

Returns:

The extensions supported by the UAC.

getUserPrincipal

public Principal getUserPrincipal()

Returns the associated user principal.

Returns:

The associated user principal.

getWarnings

public List<Warning> getWarnings()

Description copied from class: Message

Returns the additional warnings information.

Note that when used with HTTP connectors, this property maps to the "Warning" headers.

Overrides:

getWarnings in class Message

Returns:

The additional warnings information.

setAlertInfo

public void setAlertInfo(Address alertInfo)

Description copied from class: SipRequest

Sets the alternative ring tone for the UAS.

Overrides:

setAlertInfo in class SipRequest

Parameters:

alertInfo - The alternative ring tone for the UAS.

setAllowedEventTypes

public void setAllowedEventTypes(List<EventType> allowedEventTypes)

Description copied from class: SipRequest

Sets the list of supported event packages.

Overrides:

setAllowedEventTypes in class SipRequest

Parameters:

allowedEventTypes - The list of supported event packages.

setCallerInfo

public void setCallerInfo(List<Address> callerInfo)

Description copied from class: SipRequest

Sets the description of the current caller.

Overrides:

setCallerInfo in class SipRequest

Parameters:

callerInfo - The description of the current caller.

setChallengeResponse

public void setChallengeResponse(ChallengeResponse response)

Description copied from class: Request

Sets the authentication response sent by a client to an origin server. Note that when used with HTTP connectors, this property maps to the "Authorization" header.

Overrides:

setChallengeResponse in class Request

Parameters:

response - The authentication response sent by a client to an origin server.

setContacts

public void setContacts(List<ContactInfo> contact)

Description copied from class: SipRequest

Sets the data about the contacts.

Overrides:

setContacts in class SipRequest

Parameters:

contact - The data about the contacts.

setEvent

public void setEvent(Event event)

Description copied from class: SipRequest

Sets the description of an event notification.

Overrides:

setEvent in class SipRequest

Parameters:

event - The description of an event notification.

setHeaders

public void setHeaders(Series<Header> headers)

Put the headers in the request's attributes map.

Specified by:

setHeaders in interface InboundRequest

Parameters:

headers -

setInReplyTo

public void setInReplyTo(List<String> inReplyTo)

Description copied from class: SipRequest

Sets the list of references to call-ids.

Overrides:

setInReplyTo in class SipRequest

Parameters:

inReplyTo - The list of references to call-ids.

setPriority

public void setPriority(Priority priority)

Description copied from class: SipRequest

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

Overrides:

setPriority in class SipRequest

Parameters:

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

setProxyChallengeResponse

public void setProxyChallengeResponse(ChallengeResponse response)

Description copied from class: Request

Sets the authentication response sent by a client to a proxy. Note that when used with HTTP connectors, this property maps to the "Proxy-Authorization" header.

Overrides:

setProxyChallengeResponse in class Request

Parameters:

response - The authentication response sent by a client to a proxy.

setProxyRequires

public void setProxyRequires(List<OptionTag> proxyRequires)

Description copied from class: SipRequest

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

Overrides:

setProxyRequires in class SipRequest

Parameters:

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

setRecipientsInfo

public void setRecipientsInfo(List<RecipientInfo> recipientsInfo)

Description copied from class: Message

Sets the modifiable list of intermediary recipients. Note that when used with HTTP connectors, this property maps to the "Via" headers. This method clears the current list and adds all entries in the parameter list.

Overrides:

setRecipientsInfo in class Message

Parameters:

recipientsInfo - A list of intermediary recipients.

setRecordedRoutes

public void setRecordedRoutes(List<Address> recordedRoutes)

Description copied from class: SipRequest

Sets the list of routes completed by proxies to force future requests to go through the proxy.

Overrides:

setRecordedRoutes in class SipRequest

Parameters:

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

setReferTo

public void setReferTo(Address referTo)

Description copied from class: SipRequest

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

Overrides:

setReferTo in class SipRequest

Parameters:

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

setReplyTo

public void setReplyTo(Address replyTo)

Description copied from class: SipRequest

Sets a logical return URI.

Overrides:

setReplyTo in class SipRequest

Parameters:

replyTo - A logical return URI.

setRequires

public void setRequires(List<OptionTag> requires)

Description copied from class: SipRequest

Sets the sensitive features that the server must support.

Overrides:

setRequires in class SipRequest

Parameters:

requires - The sensitive features that the server must support.

setRoutes

public void setRoutes(List<Address> routes)

Description copied from class: SipRequest

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

Overrides:

setRoutes in class SipRequest

Parameters:

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

setSipIfMatch

public void setSipIfMatch(Tag sipIfMatch)

Description copied from class: SipRequest

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

Overrides:

setSipIfMatch in class SipRequest

Parameters:

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

setSipRecipientsInfo

public void setSipRecipientsInfo(List<SipRecipientInfo> recipientsInfo)

Description copied from class: SipRequest

Sets the intermediary recipients information.

Overrides:

setSipRecipientsInfo in class SipRequest

Parameters:

recipientsInfo - The intermediary recipients information.

setSubscriptionState

public void setSubscriptionState(Subscription subscription)

Description copied from class: SipRequest

Sets the state of the subscription.

Overrides:

setSubscriptionState in class SipRequest

Parameters:

subscription - The state of the subscription.

setSupported

public void setSupported(List<OptionTag> supported)

Description copied from class: SipRequest

Sets the extensions supported by the UAC.

Overrides:

setSupported in class SipRequest

Parameters:

supported - The extensions supported by the UAC.

setWarnings

public void setWarnings(List<Warning> warnings)

Description copied from class: Message

Sets the additional warnings information. Note that when used with HTTP connectors, this property maps to the "Warning" headers. This method clears the current list and adds all entries in the parameter list.

Overrides:

setWarnings in class Message

Parameters:

warnings - The warnings.