NIST SIP Parser and Stack (v1.2) API

javax.sdp
Interface Origin

All Superinterfaces:
Cloneable, Field, Serializable

public interface Origin
extends Field

An Origin represents the o= fields contained within a SessionDescription. The Origin field identifies the originator of the session. This is not necessarily the same entity who is involved in the session. The Origin contains: the name of the user originating the session, a unique session identifier, and a unique version for the session. These fields should uniquely identify the session. The Origin also includes: the network type, address type, and address of the originator. Please refer to IETF RFC 2327 for a description of SDP.

Version:
1.0
Author:
deruelle

Method Summary
 String getAddress()
          Returns the type of the network for this Connection.
 String getAddressType()
          Returns the type of the address for this Connection.
 String getNetworkType()
          Returns the type of the network for this Connection
 long getSessionId()
          Returns the unique identity of the session.
 long getSessionVersion()
          Returns the unique version of the session.
 String getUsername()
          Returns the name of the session originator.
 void setAddress(String addr)
          Sets the type of the address for this Connection.
 void setAddressType(String type)
          Returns the type of the network for this Connection.
 void setNetworkType(String type)
          Sets the type of the network for this Connection.
 void setSessionId(long id)
          Sets the unique identity of the session.
 void setSessionVersion(long version)
          Sets the unique version of the session.
 void setUsername(String user)
          Sets the name of the session originator.
 
Methods inherited from interface javax.sdp.Field
clone, getTypeChar
 

Method Detail

getUsername

public String getUsername()
                   throws SdpParseException
Returns the name of the session originator.

Returns:
the string username.
Throws:
SdpParseException

setUsername

public void setUsername(String user)
                 throws SdpException
Sets the name of the session originator.

Parameters:
user - the string username.
Throws:
SdpException - if the parameter is null

getSessionId

public long getSessionId()
                  throws SdpParseException
Returns the unique identity of the session.

Returns:
the session id.
Throws:
SdpParseException

setSessionId

public void setSessionId(long id)
                  throws SdpException
Sets the unique identity of the session.

Parameters:
id - the session id.
Throws:
SdpException - if the id is <0

getSessionVersion

public long getSessionVersion()
                       throws SdpParseException
Returns the unique version of the session.

Returns:
the session version.
Throws:
SdpException
SdpParseException

setSessionVersion

public void setSessionVersion(long version)
                       throws SdpException
Sets the unique version of the session.

Parameters:
version - the session version.
Throws:
SdpException - if the version is <0

getAddress

public String getAddress()
                  throws SdpParseException
Returns the type of the network for this Connection.

Returns:
the string network type.
Throws:
SdpParseException

getAddressType

public String getAddressType()
                      throws SdpParseException
Returns the type of the address for this Connection.

Returns:
the string address type.
Throws:
SdpParseException

getNetworkType

public String getNetworkType()
                      throws SdpParseException
Returns the type of the network for this Connection

Returns:
the string network type.
Throws:
SdpParseException

setAddress

public void setAddress(String addr)
                throws SdpException
Sets the type of the address for this Connection.

Parameters:
addr - string address type.
Throws:
SdpException - if the addr is null

setAddressType

public void setAddressType(String type)
                    throws SdpException
Returns the type of the network for this Connection.

Parameters:
type - the string network type.
Throws:
SdpException - if the type is null

setNetworkType

public void setNetworkType(String type)
                    throws SdpException
Sets the type of the network for this Connection.

Parameters:
type - the string network type.
Throws:
SdpException - if the type is null

NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.