Java Doc for SessionDescription.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » sdp » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » Java Advanced Imaging » javax.sdp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.sdp.SessionDescription

SessionDescription
public interface SessionDescription extends Serializable,Cloneable(Code)
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.
author:
   deruelle
version:
   1.0




Method Summary
public  Objectclone()
     Public clone declaration.
public  StringgetAttribute(String name)
     Returns the value of the specified attribute.
public  VectorgetAttributes(boolean create)
     Returns the set of attributes for this Description as a Vector of Attribute objects in the order they were parsed.
public  intgetBandwidth(String name)
     Returns the integer value of the specified bandwidth name.
public  VectorgetBandwidths(boolean create)
     Returns the Bandwidth of the specified type.
public  ConnectiongetConnection()
     Returns the connection information associated with this object.
public  VectorgetEmails(boolean create)
     Returns an email address to contact for further information about the session.
public  InfogetInfo()
     Returns value of the info field (i=) of this object.
public  KeygetKey()
     Returns the key data.
public  VectorgetMediaDescriptions(boolean create)
     Adds a MediaDescription to the session description.
public  OrigingetOrigin()
     Returns information about the originator of the session.
public  VectorgetPhones(boolean create)
     Returns a phone number to contact for further information about the session.
public  SessionNamegetSessionName()
     Returns the name of the session.
public  VectorgetTimeDescriptions(boolean create)
     Returns a TimeField indicating the start, stop, repetition and time zone information of the session.
public  URIgetURI()
     Returns a uri to the location of more details about the session.
public  VersiongetVersion()
     Returns the version of SDP in use.
public  VectorgetZoneAdjustments(boolean create)
    
public  voidremoveAttribute(String name)
     Removes the attribute specified by the value parameter.
public  voidremoveBandwidth(String name)
     Removes the specified bandwidth type.
public  voidsetAttribute(String name, String value)
     Sets the value of the specified attribute.
public  voidsetAttributes(Vector Attributes)
     Adds the specified Attribute to this Description object.
public  voidsetBandwidth(String name, int value)
     Sets the value of the specified bandwidth type.
public  voidsetBandwidths(Vector bandwidths)
     set the value of the Bandwidth with the specified type.
public  voidsetConnection(Connection conn)
     Set the connection data for this entity.
public  voidsetEmails(Vector emails)
     Sets a an email address to contact for further information about the session.
public  voidsetInfo(Info i)
     Sets the i= field of this object.
public  voidsetKey(Key key)
     Sets encryption key information.
public  voidsetMediaDescriptions(Vector mediaDescriptions)
     Removes all MediaDescriptions from the session description.
public  voidsetOrigin(Origin origin)
     Sets information about the originator of the session.
public  voidsetPhones(Vector phones)
     Sets a phone number to contact for further information about the session.
public  voidsetSessionName(SessionName sessionName)
     Sets the name of the session.
public  voidsetTimeDescriptions(Vector times)
     Sets a TimeField indicating the start, stop, repetition and time zone information of the session.
public  voidsetURI(URI uri)
     Sets the uri to the location of more details about the session.
public  voidsetVersion(Version v)
     Sets the version of SDP in use.
public  voidsetZoneAdjustments(Vector zoneAdjustments)
     Sets the time zone adjustment for the TimeField.



Method Detail
clone
public Object clone() throws CloneNotSupportedException(Code)
Public clone declaration.
throws:
  CloneNotSupportedException - if clone method is not supported Object



getAttribute
public String getAttribute(String name) throws SdpParseException(Code)
Returns the value of the specified attribute.
Parameters:
  name - name - the name of the attribute
throws:
  SdpParseException - the value of the named attribute



getAttributes
public Vector getAttributes(boolean create)(Code)
Returns the set of attributes for this Description as a Vector of Attribute objects in the order they were parsed.
Parameters:
  create - create - specifies whether to return null or a new empty Vector in case noattributes exists for this Description attributes for this Description



getBandwidth
public int getBandwidth(String name) throws SdpParseException(Code)
Returns the integer value of the specified bandwidth name.
Parameters:
  name - name - the name of the bandwidth type
throws:
  SdpParseException - the value of the named bandwidth



getBandwidths
public Vector getBandwidths(boolean create)(Code)
Returns the Bandwidth of the specified type.
Parameters:
  create - type - type of the Bandwidth to return the Bandwidth or null if undefined



getConnection
public Connection getConnection()(Code)
Returns the connection information associated with this object. This may be null for SessionDescriptions if all Media objects have a connection object and may be null for Media objects if the corresponding session connection is non-null. connection



getEmails
public Vector getEmails(boolean create) throws SdpParseException(Code)
Returns an email address to contact for further information about the session. This corresponds to the e= field of the SDP data.
Parameters:
  create - boolean to set
throws:
  SdpException - the email address.



getInfo
public Info getInfo()(Code)
Returns value of the info field (i=) of this object. info



getKey
public Key getKey()(Code)
Returns the key data. key



getMediaDescriptions
public Vector getMediaDescriptions(boolean create) throws SdpException(Code)
Adds a MediaDescription to the session description. These correspond to the m= fields of the SDP data.
Parameters:
  create - boolean to set
throws:
  SdpException - media - the field to add.



getOrigin
public Origin getOrigin()(Code)
Returns information about the originator of the session. This corresponds to the o= field of the SDP data. the originator data.



getPhones
public Vector getPhones(boolean create) throws SdpException(Code)
Returns a phone number to contact for further information about the session. This corresponds to the p= field of the SDP data.
Parameters:
  create - boolean to set
throws:
  SdpException - the phone number.



getSessionName
public SessionName getSessionName()(Code)
Returns the name of the session. This corresponds to the s= field of the SDP data. the session name.



getTimeDescriptions
public Vector getTimeDescriptions(boolean create) throws SdpException(Code)
Returns a TimeField indicating the start, stop, repetition and time zone information of the session. This corresponds to the t= field of the SDP data.
Parameters:
  create - boolean to set
throws:
  SdpException - the Time Field.



getURI
public URI getURI()(Code)
Returns a uri to the location of more details about the session. This corresponds to the u= field of the SDP data. the uri.



getVersion
public Version getVersion()(Code)
Returns the version of SDP in use. This corresponds to the v= field of the SDP data. the integer version (-1 if not set).



getZoneAdjustments
public Vector getZoneAdjustments(boolean create) throws SdpException(Code)
Returns the time zone adjustments for the Session
Parameters:
  create - boolean to set
throws:
  SdpException - a Hashtable containing the zone adjustments, where the key is the Adjusted TimeZone and the value is the offset.



removeAttribute
public void removeAttribute(String name)(Code)
Removes the attribute specified by the value parameter.
Parameters:
  name - name - the name of the attribute



removeBandwidth
public void removeBandwidth(String name)(Code)
Removes the specified bandwidth type.
Parameters:
  name - name - the name of the bandwidth type



setAttribute
public void setAttribute(String name, String value) throws SdpException(Code)
Sets the value of the specified attribute.
Parameters:
  name - name - the name of the attribute.
Parameters:
  value - value - the value of the named attribute.
throws:
  SdpException - if the name or the value is null



setAttributes
public void setAttributes(Vector Attributes) throws SdpException(Code)
Adds the specified Attribute to this Description object.
Parameters:
  Attributes - attribute - the attribute to add
throws:
  SdpException - if the vector is null



setBandwidth
public void setBandwidth(String name, int value) throws SdpException(Code)
Sets the value of the specified bandwidth type.
Parameters:
  name - name - the name of the bandwidth type.
Parameters:
  value - value - the value of the named bandwidth type.
throws:
  SdpException - if the name is null



setBandwidths
public void setBandwidths(Vector bandwidths) throws SdpException(Code)
set the value of the Bandwidth with the specified type.
Parameters:
  bandwidths - to set
throws:
  SdpException - if the vector is null



setConnection
public void setConnection(Connection conn) throws SdpException(Code)
Set the connection data for this entity.
Parameters:
  conn - to set
throws:
  SdpException - if the parameter is null



setEmails
public void setEmails(Vector emails) throws SdpException(Code)
Sets a an email address to contact for further information about the session. This corresponds to the e= field of the SDP data.
Parameters:
  emails - email - the email address.
throws:
  SdpException - if the vector is null



setInfo
public void setInfo(Info i) throws SdpException(Code)
Sets the i= field of this object.
Parameters:
  i - s - new i= value; if null removes the field
throws:
  SdpException - if the info is null



setKey
public void setKey(Key key) throws SdpException(Code)
Sets encryption key information. This consists of a method and an encryption key included inline.
Parameters:
  key - key - the encryption key data; depending on method may be null
throws:
  SdpException - if the parameter is null



setMediaDescriptions
public void setMediaDescriptions(Vector mediaDescriptions) throws SdpException(Code)
Removes all MediaDescriptions from the session description.
Parameters:
  mediaDescriptions - to set
throws:
  SdpException - if the parameter is null



setOrigin
public void setOrigin(Origin origin) throws SdpException(Code)
Sets information about the originator of the session. This corresponds to the o= field of the SDP data.
Parameters:
  origin - origin - the originator data.
throws:
  SdpException - if the origin is null



setPhones
public void setPhones(Vector phones) throws SdpException(Code)
Sets a phone number to contact for further information about the session. This corresponds to the p= field of the SDP data.
Parameters:
  phones - phone - the phone number.
throws:
  SdpException - if the vector is null



setSessionName
public void setSessionName(SessionName sessionName) throws SdpException(Code)
Sets the name of the session. This corresponds to the s= field of the SDP data.
Parameters:
  sessionName - name - the session name.
throws:
  SdpException - if the sessionName is null



setTimeDescriptions
public void setTimeDescriptions(Vector times) throws SdpException(Code)
Sets a TimeField indicating the start, stop, repetition and time zone information of the session. This corresponds to the t= field of the SDP data.
Parameters:
  times - time - the TimeField.
throws:
  SdpException - if the vector is null



setURI
public void setURI(URI uri) throws SdpException(Code)
Sets the uri to the location of more details about the session. This corresponds to the u= field of the SDP data.
Parameters:
  uri - uri - the uri.
throws:
  SdpException - if the uri is null



setVersion
public void setVersion(Version v) throws SdpException(Code)
Sets the version of SDP in use. This corresponds to the v= field of the SDP data.
Parameters:
  v - version - the integer version.
throws:
  SdpException - if the version is null



setZoneAdjustments
public void setZoneAdjustments(Vector zoneAdjustments) throws SdpException(Code)
Sets the time zone adjustment for the TimeField.
Parameters:
  zoneAdjustments - zoneAdjustments - a Hashtable containing the zoneadjustments, where the keyis the Adjusted Time Zone and the value is the offset.
throws:
  SdpException - if the vector is null



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.