|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SessionDescription
A SessionDescription represents the data defined by the Session Description Protocol (see IETF RFC 2327) and holds information about the originitor of a session, the media types that a client can support and the host and port on which the client will listen for that media. The SessionDescription also holds timing information for the session (e.g. start, end, repeat, time zone) and bandwidth supported for the session. Please refer to IETF RFC 2327 for a description of SDP.
Method Summary | |
---|---|
Object |
clone()
Public clone declaration. |
String |
getAttribute(String name)
Returns the value of the specified attribute. |
Vector |
getAttributes(boolean create)
Returns the set of attributes for this Description as a Vector of Attribute objects in the order they were parsed. |
int |
getBandwidth(String name)
Returns the integer value of the specified bandwidth name. |
Vector |
getBandwidths(boolean create)
Returns the Bandwidth of the specified type. |
Connection |
getConnection()
Returns the connection information associated with this object. |
Vector |
getEmails(boolean create)
Returns an email address to contact for further information about the session. |
Info |
getInfo()
Returns value of the info field (i=) of this object. |
Key |
getKey()
Returns the key data. |
Vector |
getMediaDescriptions(boolean create)
Adds a MediaDescription to the session description. |
Origin |
getOrigin()
Returns information about the originator of the session. |
Vector |
getPhones(boolean create)
Returns a phone number to contact for further information about the session. |
SessionName |
getSessionName()
Returns the name of the session. |
Vector |
getTimeDescriptions(boolean create)
Returns a TimeField indicating the start, stop, repetition and time zone information of the session. |
URI |
getURI()
Returns a uri to the location of more details about the session. |
Version |
getVersion()
Returns the version of SDP in use. |
Vector |
getZoneAdjustments(boolean create)
Returns the time zone adjustments for the Session |
void |
removeAttribute(String name)
Removes the attribute specified by the value parameter. |
void |
removeBandwidth(String name)
Removes the specified bandwidth type. |
void |
setAttribute(String name,
String value)
Sets the value of the specified attribute. |
void |
setAttributes(Vector Attributes)
Adds the specified Attribute to this Description object. |
void |
setBandwidth(String name,
int value)
Sets the value of the specified bandwidth type. |
void |
setBandwidths(Vector bandwidths)
set the value of the Bandwidth with the specified type. |
void |
setConnection(Connection conn)
Set the connection data for this entity. |
void |
setEmails(Vector emails)
Sets a an email address to contact for further information about the session. |
void |
setInfo(Info i)
Sets the i= field of this object. |
void |
setKey(Key key)
Sets encryption key information. |
void |
setMediaDescriptions(Vector mediaDescriptions)
Removes all MediaDescriptions from the session description. |
void |
setOrigin(Origin origin)
Sets information about the originator of the session. |
void |
setPhones(Vector phones)
Sets a phone number to contact for further information about the session. |
void |
setSessionName(SessionName sessionName)
Sets the name of the session. |
void |
setTimeDescriptions(Vector times)
Sets a TimeField indicating the start, stop, repetition and time zone information of the session. |
void |
setURI(URI uri)
Sets the uri to the location of more details about the session. |
void |
setVersion(Version v)
Sets the version of SDP in use. |
void |
setZoneAdjustments(Vector zoneAdjustments)
Sets the time zone adjustment for the TimeField. |
Method Detail |
---|
Object clone() throws CloneNotSupportedException
CloneNotSupportedException
- if clone method is not supportedVersion getVersion()
void setVersion(Version v) throws SdpException
v
- version - the integer version.
SdpException
- if the version is nullOrigin getOrigin()
void setOrigin(Origin origin) throws SdpException
origin
- origin - the originator data.
SdpException
- if the origin is nullSessionName getSessionName()
void setSessionName(SessionName sessionName) throws SdpException
sessionName
- name - the session name.
SdpException
- if the sessionName is nullInfo getInfo()
void setInfo(Info i) throws SdpException
i
- s - new i= value; if null removes the field
SdpException
- if the info is nullURI getURI()
void setURI(URI uri) throws SdpException
uri
- uri - the uri.
SdpException
- if the uri is nullVector getEmails(boolean create) throws SdpParseException
create
- boolean to set
SdpException
SdpParseException
void setEmails(Vector emails) throws SdpException
emails
- email - the email address.
SdpException
- if the vector is nullVector getPhones(boolean create) throws SdpException
create
- boolean to set
SdpException
void setPhones(Vector phones) throws SdpException
phones
- phone - the phone number.
SdpException
- if the vector is nullVector getTimeDescriptions(boolean create) throws SdpException
create
- boolean to set
SdpException
void setTimeDescriptions(Vector times) throws SdpException
times
- time - the TimeField.
SdpException
- if the vector is nullVector getZoneAdjustments(boolean create) throws SdpException
create
- boolean to set
SdpException
void setZoneAdjustments(Vector zoneAdjustments) throws SdpException
zoneAdjustments
- zoneAdjustments - a Hashtable containing the zone
adjustments, where the key
is the Adjusted Time Zone and the value is the offset.
SdpException
- if the vector is nullConnection getConnection()
void setConnection(Connection conn) throws SdpException
conn
- to set
SdpException
- if the parameter is nullVector getBandwidths(boolean create)
create
- type - type of the Bandwidth to return
void setBandwidths(Vector bandwidths) throws SdpException
bandwidths
- to set
SdpException
- if the vector is nullint getBandwidth(String name) throws SdpParseException
name
- name - the name of the bandwidth type
SdpParseException
void setBandwidth(String name, int value) throws SdpException
name
- name - the name of the bandwidth type.value
- value - the value of the named bandwidth type.
SdpException
- if the name is nullvoid removeBandwidth(String name)
name
- name - the name of the bandwidth typeKey getKey()
void setKey(Key key) throws SdpException
key
- key - the encryption key data; depending on method may be null
SdpException
- if the parameter is nullString getAttribute(String name) throws SdpParseException
name
- name - the name of the attribute
SdpParseException
Vector getAttributes(boolean create)
create
- create - specifies whether to return null or a new empty
Vector in case no
attributes exists for this Description
void removeAttribute(String name)
name
- name - the name of the attributevoid setAttribute(String name, String value) throws SdpException
name
- name - the name of the attribute.value
- value - the value of the named attribute.
SdpException
- if the name or the value is nullvoid setAttributes(Vector Attributes) throws SdpException
Attributes
- attribute - the attribute to add
SdpException
- if the vector is nullVector getMediaDescriptions(boolean create) throws SdpException
create
- boolean to set
SdpException
void setMediaDescriptions(Vector mediaDescriptions) throws SdpException
mediaDescriptions
- to set
SdpException
- if the parameter is null
|
NIST-SIP: The Reference Implementation for JAIN-SIP 1.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |