org.cafesip.sipexchange.inservice.shared
Class Subscriber

java.lang.Object
  org.cafesip.sipexchange.inservice.shared.Subscriber

All Implemented Interfaces:

java.io.Serializable

public class Subscriber
extends java.lang.Object
implements java.io.Serializable

This class is used to provide information about a subscriber. An object of this type is instantiated by the SipExchange server and populated based on a subscriber's entry in the subscriber database. This object is created both for the calling and the called subscriber and is sent as a part of a service controller information.

The setter methods in this class is used by the SipExchange server to set the parameters and the getter methods are used by the SCP to retrieve the information. For further details on the invocation,

See Also:

TriggerInfo, Serialized Form

Constructor Summary

Subscriber(java.lang.String userid, java.lang.String name, java.lang.String email, java.lang.String phone1, java.lang.String phone2, java.lang.String phone3, java.lang.String webUrl, java.lang.String additionalInfo, java.lang.String domain, java.util.Collection roles, java.util.Properties properties, java.util.ArrayList triggers)
A constructor for this class.

Method Summary

java.lang.String	getAdditionalInfo() This method is for future use.
java.lang.String	getDomain() Getter method for getting the domain the subscriber belongs to.
java.lang.String	getEmail() This method is for future use.
java.lang.String	getName() This method is for future use.
java.lang.String	getPhone1() This method is for future use.
java.lang.String	getPhone2() This method is for future use.
java.lang.String	getPhone3() This method is for future use.
java.util.Properties	getProperties() Getter method for the properties associated with the subscribers.
java.util.Collection	getRoles() Getter method for the roles associated with this user.
java.util.ArrayList	getTriggers() Getter method for the triggers associaeted with this subscriber.
java.lang.String	getUserid() Getter method for the user id.
java.lang.String	getWebUrl() This method is for future use.
void	setAdditionalInfo(java.lang.String additionalInfo) This method is for future use.
void	setDomain(java.lang.String domain) Setter method for the domain name.
void	setEmail(java.lang.String email) This method is for future use.
void	setName(java.lang.String name) This method is for future use.
void	setPhone1(java.lang.String phone1) This method is for future use.
void	setPhone2(java.lang.String phone2) This method is for future use.
void	setPhone3(java.lang.String phone3) This method is for future use.
void	setProperties(java.util.Properties properties) Setter method for the properties associated with this subscriber.
void	setRoles(java.util.Collection roles) Setter method for setting the roles.
void	setTriggers(java.util.ArrayList triggers) Setter methods for the triggers associated with this subscriber.
void	setUserid(java.lang.String userid) Setter method for the user id.
void	setWebUrl(java.lang.String webUrl) This method is for future use.

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscriber

public Subscriber(java.lang.String userid,
                  java.lang.String name,
                  java.lang.String email,
                  java.lang.String phone1,
                  java.lang.String phone2,
                  java.lang.String phone3,
                  java.lang.String webUrl,
                  java.lang.String additionalInfo,
                  java.lang.String domain,
                  java.util.Collection roles,
                  java.util.Properties properties,
                  java.util.ArrayList triggers)

A constructor for this class.

Method Detail

getAdditionalInfo

public java.lang.String getAdditionalInfo()

This method is for future use. Do not use this method.

Returns:

the additional information string.

setAdditionalInfo

public void setAdditionalInfo(java.lang.String additionalInfo)

This method is for future use. Do not use this method.

Parameters:

additionalInfo -

getDomain

public java.lang.String getDomain()

Getter method for getting the domain the subscriber belongs to.

Returns:

the domain name.

setDomain

public void setDomain(java.lang.String domain)

Setter method for the domain name.

Parameters:

domain - domain name to set.

getEmail

public java.lang.String getEmail()

This method is for future use. Do not use this method.

Returns:

email

setEmail

public void setEmail(java.lang.String email)

This method is for future use. Do not use this method.

Parameters:

email -

getName

public java.lang.String getName()

This method is for future use. Do not use this method.

Returns:

full name of the user.

setName

public void setName(java.lang.String name)

This method is for future use. Do not use this method.

Parameters:

name -

getPhone1

public java.lang.String getPhone1()

This method is for future use. Do not use this method.

Returns:

the home phone number.

setPhone1

public void setPhone1(java.lang.String phone1)

This method is for future use. Do not use this method.

Parameters:

phone1 -

getPhone2

public java.lang.String getPhone2()

This method is for future use. Do not use this method.

Returns:

the work phone number.

setPhone2

public void setPhone2(java.lang.String phone2)

This method is for future use. Do not use this method.

Parameters:

phone2 -

getPhone3

public java.lang.String getPhone3()

This method is for future use. Do not use this method.

Returns:

the mobile phone number.

setPhone3

public void setPhone3(java.lang.String phone3)

This method is for future use. Do not use this method.

Parameters:

phone3 -

getUserid

public java.lang.String getUserid()

Getter method for the user id. If the user's SIP address is sip:amit@cafesip.org, the user id is amit.

Returns:

the user id.

setUserid

public void setUserid(java.lang.String userid)

Setter method for the user id.

Parameters:

userid - user id string to set.

getWebUrl

public java.lang.String getWebUrl()

This method is for future use. Do not use this method.

Returns:

the subscriber's URL.

setWebUrl

public void setWebUrl(java.lang.String webUrl)

This method is for future use. Do not use this method.

Parameters:

webUrl -

getRoles

public java.util.Collection getRoles()

Getter method for the roles associated with this user.

Returns:

a collection of role name strings.

setRoles

public void setRoles(java.util.Collection roles)

Setter method for setting the roles.

Parameters:

roles - roles for the subscriber.

getProperties

public java.util.Properties getProperties()

Getter method for the properties associated with the subscribers. Each subscriber may have a set of general-purpose properties associated with the user. These properties may be used by the SCP for any reasons.

Returns:

the properties associated with the subscriber.

setProperties

public void setProperties(java.util.Properties properties)

Setter method for the properties associated with this subscriber.

Parameters:

properties - properties object to set.

getTriggers

public java.util.ArrayList getTriggers()

Getter method for the triggers associaeted with this subscriber. The returned collection contains elements of the type org.cafesip.sipexchange.inservice.shared.Trigger.

Returns:

the triggers associated with this user.

setTriggers

public void setTriggers(java.util.ArrayList triggers)

Setter methods for the triggers associated with this subscriber.

Parameters:

triggers - to set.