public class SipRequest extends Request
Constructor and Description |
---|
SipRequest()
Constructor.
|
SipRequest(Method method,
Reference resourceRef)
Constructor.
|
SipRequest(Method method,
Reference resourceRef,
Representation entity)
Constructor.
|
SipRequest(Method method,
String resourceUri)
Constructor.
|
SipRequest(Method method,
String resourceUri,
Representation entity)
Constructor.
|
SipRequest(SipRequest request)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
Address |
getAlertInfo()
Returns the alternative ring tone for the UAS.
|
List<EventType> |
getAllowedEventTypes()
Returns the list of supported event packages.
|
List<Address> |
getCallerInfo()
Returns the description of the current caller.
|
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.
|
long |
getCreation()
Returns the creation time.
|
Event |
getEvent()
Returns the description of an event notification.
|
Address |
getFrom()
Returns the description of the request's initiator.
|
List<String> |
getInReplyTo()
Returns The list of references to call-ids.
|
long |
getLastActivity()
Returns the date of last activity on this transaction object.
|
int |
getMaxIdleTimeMs()
Returns the timeout in milliseconds.
|
String |
getMimeVersion()
Returns the version of the MIME protocol used to construct the message.
|
String |
getOrganization()
Returns the name of the organization to which the SIP element issuing the
message belongs.
|
Priority |
getPriority()
Returns the urgency of the request as perceived by the client.
|
List<OptionTag> |
getProxyRequires()
Returns the proxy-sensitive features that the proxy must support.
|
List<Address> |
getRecordedRoutes()
Returns the list of routes completed by proxies to force future requests
to go through the proxy.
|
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.
|
String |
getSubject()
Returns the subject of the call.
|
Subscription |
getSubscriptionState()
Returns the state of the subscription.
|
List<OptionTag> |
getSupported()
Returns the extensions supported by the UAC.
|
Address |
getTo()
Returns the logical recipient of the request.
|
String |
getTransaction()
Returns the transaction identifier.
|
boolean |
hasTimedOut()
Indicates if the transaction has timed out due to lack of activity.
|
boolean |
isHandled()
Indicates that the request has been handled, typically after receiving a
final response.
|
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 |
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 contacts.
|
void |
setEvent(Event event)
Sets the description of an event notification.
|
void |
setFrom(Address from)
Sets the description of the request's initiator.
|
void |
setHandled(boolean handled)
Indicates that the request has been handled, typically after receiving a
final response.
|
void |
setInReplyTo(List<String> inReplyTo)
Sets the list of references to call-ids.
|
void |
setMimeVersion(String mimeVersion)
Sets the version of the MIME protocol used to construct the message.
|
void |
setOrganization(String organization)
Sets the name of the organization to which the SIP element issuing the
message belongs.
|
void |
setPriority(Priority priority)
Sets the urgency of the request as perceived by the client.
|
void |
setProxyRequires(List<OptionTag> proxyRequires)
Sets the proxy-sensitive features that the proxy must support.
|
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 |
setSubject(String subject)
Sets the subject of the call.
|
void |
setSubscriptionState(Subscription subscription)
Sets the state of the subscription.
|
void |
setSupported(List<OptionTag> supported)
Sets the extensions supported by the UAC.
|
void |
setTo(Address to)
Sets the logical recipient of the request.
|
void |
updateLastActivity()
Indicates that a new activity on this transaction has been detected.
|
abort, commit, getChallengeResponse, getClientInfo, getConditions, getCookies, getCurrent, getHostRef, getMaxForwards, getMethod, getOnResponse, getOriginalRef, getProtocol, getProxyChallengeResponse, getRanges, getReferrerRef, getResourceRef, getRootRef, isAsynchronous, isConfidential, isEntityAvailable, isExpectingResponse, isLoggable, isSynchronous, setChallengeResponse, setClientInfo, setConditions, setCookies, setHostRef, setHostRef, setLoggable, setMaxForwards, setMethod, setOnResponse, setOriginalRef, setProtocol, setProxyChallengeResponse, setRanges, setReferrerRef, setReferrerRef, setResourceRef, setResourceRef, setRootRef, toString
getAttributes, getCacheDirectives, getDate, getEntity, getEntityAsText, getOnError, getOnSent, getRecipientsInfo, getWarnings, release, setAttributes, setCacheDirectives, setDate, setEntity, setEntity, setOnError, setOnSent, setRecipientsInfo, setWarnings
public SipRequest()
public SipRequest(Method method, Reference resourceRef)
method
- The call's method.resourceRef
- The resource reference.public SipRequest(Method method, Reference resourceRef, Representation entity)
method
- The call's method.resourceRef
- The resource reference.entity
- The entity.public SipRequest(Method method, String resourceUri)
method
- The call's method.resourceUri
- The resource URI.public SipRequest(Method method, String resourceUri, Representation entity)
method
- The call's method.resourceUri
- The resource URI.entity
- The entity.public SipRequest(SipRequest request)
request
- The request to copy.public Address getAlertInfo()
public List<EventType> getAllowedEventTypes()
public List<Address> getCallerInfo()
public String getCallId()
public String getCommandSequence()
public List<ContactInfo> getContacts()
public long getCreation()
public Event getEvent()
public Address getFrom()
public List<String> getInReplyTo()
public long getLastActivity()
public int getMaxIdleTimeMs()
public String getMimeVersion()
public String getOrganization()
public Priority getPriority()
public List<OptionTag> getProxyRequires()
public List<Address> getRecordedRoutes()
public Address getReferTo()
SipMethod.REFER
method should contact.SipMethod.REFER
method should contact.public Address getReplyTo()
public List<OptionTag> getRequires()
public List<Address> getRoutes()
public Tag getSipIfMatch()
public List<SipRecipientInfo> getSipRecipientsInfo()
public String getSubject()
public Subscription getSubscriptionState()
public List<OptionTag> getSupported()
public Address getTo()
public String getTransaction()
public boolean hasTimedOut()
public boolean isHandled()
public void setAlertInfo(Address alertInfo)
alertInfo
- The alternative ring tone for the UAS.public void setAllowedEventTypes(List<EventType> allowedEventTypes)
allowedEventTypes
- The list of supported event packages.public void setCallerInfo(List<Address> callerInfo)
callerInfo
- The description of the current caller.public void setCallId(String callId)
callId
- The identifier of the call.public void setCommandSequence(String commandSequence)
commandSequence
- The identifier of the command.public void setContacts(List<ContactInfo> contact)
contact
- The data about the contacts.public void setEvent(Event event)
event
- The description of an event notification.public void setFrom(Address from)
from
- The description of the request's initiator.public void setHandled(boolean handled)
handled
- True if the request has been handled.public void setInReplyTo(List<String> inReplyTo)
inReplyTo
- The list of references to call-ids.public void setMimeVersion(String mimeVersion)
mimeVersion
- The version of the MIME protocol used to construct the
message.public void setOrganization(String organization)
organization
- The name of the organization to which the SIP element issuing
the message belongs.public void setPriority(Priority priority)
priority
- The urgency of the request as perceived by the client.public void setProxyRequires(List<OptionTag> proxyRequires)
proxyRequires
- The proxy-sensitive features that the proxy must support.public void setRecordedRoutes(List<Address> recordedRoutes)
recordedRoutes
- The list of routes completed by proxies to force future
requests to go through the proxy.public void setReferTo(Address referTo)
SipMethod.REFER
method
should contact.referTo
- The reference that the recipient of a SipMethod.REFER
method should contact.public void setReplyTo(Address replyTo)
replyTo
- A logical return URI.public void setRequires(List<OptionTag> requires)
requires
- The sensitive features that the server must support.public void setRoutes(List<Address> routes)
routes
- The set of proxies used to force routing for a request.public void setSipIfMatch(Tag sipIfMatch)
sipIfMatch
- The identifier of the specific event state that the request is
refreshing.public void setSipRecipientsInfo(List<SipRecipientInfo> recipientsInfo)
recipientsInfo
- The intermediary recipients information.public void setSubject(String subject)
subject
- the subject of the call.public void setSubscriptionState(Subscription subscription)
subscription
- The state of the subscription.public void setSupported(List<OptionTag> supported)
supported
- The extensions supported by the UAC.public void setTo(Address to)
to
- The logical recipient of the request.public void updateLastActivity()
Copyright © 2005–2013. All rights reserved.