local.ua
Class UserAgentProfile

java.lang.Object
  |
  +--org.zoolu.tools.Configure
        |
        +--local.ua.UserAgentProfile

public class UserAgentProfile

extends org.zoolu.tools.Configure

UserProfile maintains the user configuration

Field Summary

int	accept_time Automatic answer time in seconds; time<0 corresponds to manual answer mode.
boolean	audio Whether using audio
int	audio_avp Audio avp
java.lang.String	audio_codec Audio codec
int	audio_frame_size Audio frame size
int	audio_port Audio port
int	audio_sample_rate Audio sample rate
int	audio_sample_size Audio sample size
java.lang.String	bin_rat RAT command-line executable
java.lang.String	bin_vic VIC command-line executable
java.lang.String	call_to Automatic call a remote user secified by the 'call_to' value.
java.lang.String	contact_url Contact URL.
static java.lang.String	contacts_file Path for the 'contacts.lst' file where save and load the VisualUA contacts By default, it is used the "config/contacts.lst" folder
boolean	do_register Whether registering with the registrar server
boolean	do_unregister Whether unregistering the contact address
boolean	do_unregister_all Whether unregistering all contacts beafore registering the contact address
int	expires Expires time (in seconds).
java.lang.String	from_url User's AOR (Address Of Record), used also as From URL.
int	hangup_time Automatic hangup time (call duartion) in seconds; time<=0 corresponds to manual hangup mode.
long	keepalive_time Rate of keep-alive packets sent toward the registrar server (in milliseconds).
boolean	no_offer No offer in the invite
boolean	no_prompt Do not use prompt
java.lang.String	passwd User's passwd.
int	re_invite_time Automatic re-inviting time in seconds; time<0 corresponds to no auto re-invite mode.
java.lang.String	realm User's realm.
java.lang.String	recv_file Audio file to be recorded
boolean	recv_only Whether playing in receive only mode
java.lang.String	redirect_to Redirect incoming call to the secified url.
java.lang.String	send_file Audio file to be played
boolean	send_only Whether playing in send only mode
boolean	send_tone Whether playing a test tone in send only mode
int	transfer_time Automatic call transfer time in seconds; time<0 corresponds to no auto transfer mode.
java.lang.String	transfer_to Transfer calls to the secified url.
static java.lang.String	ua_jar Path for the 'ua.jar' lib, used to retrive various UA media (gif, wav, etc.)
boolean	use_jmf Whether using JMF for audio/video streaming
boolean	use_rat Whether using RAT (Robust Audio Tool) as audio sender/receiver
boolean	use_vic Whether using VIC (Video Conferencing Tool) as video sender/receiver
java.lang.String	username User's name (used to build the contact_url if not explitely defined)
boolean	video Whether using video
int	video_avp Video avp
int	video_port Video port

Fields inherited from class org.zoolu.tools.Configure

NONE

Constructor Summary

UserAgentProfile()
Costructs a void UserProfile

UserAgentProfile(java.lang.String file)
Costructs a new UserAgentProfile

Method Summary

void	initContactAddress(org.zoolu.sip.provider.SipProvider sip_provider) Sets contact_url and from_url with transport information.
protected void	parseLine(java.lang.String line) Parses a single line (loaded from the config file)
protected java.lang.String	toLines() Converts the entire object into lines (to be saved into the config file)

Methods inherited from class org.zoolu.tools.Configure

loadFile, saveFile

Methods inherited from class java.lang.Object

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

Field Detail

from_url

public java.lang.String from_url

User's AOR (Address Of Record), used also as From URL.

The AOR is the SIP address used to register with the user's registrar server (if requested).
The address of the registrar is taken from the hostport field of the AOR, i.e. the value(s) host[:port] after the '@' character.

If not defined (default), it equals the contact_url attribute.

contact_url

public java.lang.String contact_url

Contact URL. If not defined (default), it is formed by sip:local_user@host_address:host_port

username

public java.lang.String username

User's name (used to build the contact_url if not explitely defined)

realm

public java.lang.String realm

User's realm.

passwd

public java.lang.String passwd

User's passwd.

ua_jar

public static java.lang.String ua_jar

Path for the 'ua.jar' lib, used to retrive various UA media (gif, wav, etc.) By default, it is used the "lib/ua.jar" folder

contacts_file

public static java.lang.String contacts_file

Path for the 'contacts.lst' file where save and load the VisualUA contacts By default, it is used the "config/contacts.lst" folder

do_register

public boolean do_register

Whether registering with the registrar server

do_unregister

public boolean do_unregister

Whether unregistering the contact address

do_unregister_all

public boolean do_unregister_all

Whether unregistering all contacts beafore registering the contact address

expires

public int expires

Expires time (in seconds).

keepalive_time

public long keepalive_time

Rate of keep-alive packets sent toward the registrar server (in milliseconds). Set keepalive_time=0 to disable the sending of keep-alive datagrams.

call_to

public java.lang.String call_to

Automatic call a remote user secified by the 'call_to' value. Use value 'NONE' for manual calls (or let it undefined).

accept_time

public int accept_time

Automatic answer time in seconds; time<0 corresponds to manual answer mode.

hangup_time

public int hangup_time

Automatic hangup time (call duartion) in seconds; time<=0 corresponds to manual hangup mode.

transfer_time

public int transfer_time

Automatic call transfer time in seconds; time<0 corresponds to no auto transfer mode.

re_invite_time

public int re_invite_time

Automatic re-inviting time in seconds; time<0 corresponds to no auto re-invite mode.

redirect_to

public java.lang.String redirect_to

Redirect incoming call to the secified url. Use value 'NONE' for not redirecting incoming calls (or let it undefined).

transfer_to

public java.lang.String transfer_to

Transfer calls to the secified url. Use value 'NONE' for not transferring calls (or let it undefined).

no_offer

public boolean no_offer

No offer in the invite

no_prompt

public boolean no_prompt

Do not use prompt

audio

public boolean audio

Whether using audio

video

public boolean video

Whether using video

recv_only

public boolean recv_only

Whether playing in receive only mode

send_only

public boolean send_only

Whether playing in send only mode

send_tone

public boolean send_tone

Whether playing a test tone in send only mode

send_file

public java.lang.String send_file

Audio file to be played

recv_file

public java.lang.String recv_file

Audio file to be recorded

audio_port

public int audio_port

Audio port

audio_avp

public int audio_avp

Audio avp

audio_codec

public java.lang.String audio_codec

Audio codec

audio_sample_rate

public int audio_sample_rate

Audio sample rate

audio_sample_size

public int audio_sample_size

Audio sample size

audio_frame_size

public int audio_frame_size

Audio frame size

video_port

public int video_port

Video port

video_avp

public int video_avp

Video avp

use_jmf

public boolean use_jmf

Whether using JMF for audio/video streaming

use_rat

public boolean use_rat

Whether using RAT (Robust Audio Tool) as audio sender/receiver

use_vic

public boolean use_vic

Whether using VIC (Video Conferencing Tool) as video sender/receiver

bin_rat

public java.lang.String bin_rat

RAT command-line executable

bin_vic

public java.lang.String bin_vic

VIC command-line executable

Constructor Detail

UserAgentProfile

public UserAgentProfile()

Costructs a void UserProfile

UserAgentProfile

public UserAgentProfile(java.lang.String file)

Costructs a new UserAgentProfile

Method Detail

initContactAddress

public void initContactAddress(org.zoolu.sip.provider.SipProvider sip_provider)

Sets contact_url and from_url with transport information.

This method actually sets contact_url and from_url only if they haven't still been explicitly initilized.

parseLine

protected void parseLine(java.lang.String line)

Parses a single line (loaded from the config file)

Overrides:

parseLine in class org.zoolu.tools.Configure

toLines

protected java.lang.String toLines()

Converts the entire object into lines (to be saved into the config file)

Overrides:

toLines in class org.zoolu.tools.Configure