org.cafesip.sipexchange.inservice.shared
Class Domain

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

All Implemented Interfaces:

java.io.Serializable

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

This class is used to provide information about a domain where the calling and/or a called subscriber belongs to. This information is available on the domain database. Once a trigger is encountered, the SipExchange server instantiates an object of this type, one for the domain where the calling user belongs to and one for the domain where the called subscriber belongs to. This information is sent as a part of the invocation to the SCP.

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

Domain(java.lang.String name, java.lang.String description, java.util.Properties properties, java.util.ArrayList triggers)
A constructor for this class.

Method Summary

java.lang.String	getDescription() This method is for future use.
java.lang.String	getName() Getter method for the domain name.
java.util.Properties	getProperties() Getter method for the properties associated with the domain.
java.util.ArrayList	getTriggers() Getter method for the triggers associaeted with this domain.
void	setDescription(java.lang.String description) This method is for future use.
void	setName(java.lang.String name) Setter method for the domain name.
void	setProperties(java.util.Properties properties) Setter method for the properties associated with this domain.
void	setTriggers(java.util.ArrayList triggers) Setter methods for the triggers associated with this domain.

Methods inherited from class java.lang.Object

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

Constructor Detail

Domain

public Domain(java.lang.String name,
              java.lang.String description,
              java.util.Properties properties,
              java.util.ArrayList triggers)

A constructor for this class.

Method Detail

getDescription

public java.lang.String getDescription()

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

Returns:

description

setDescription

public void setDescription(java.lang.String description)

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

Parameters:

description - description entered for this domain.

getName

public java.lang.String getName()

Getter method for the domain name.

Returns:

the domain name.

setName

public void setName(java.lang.String name)

Setter method for the domain name.

Parameters:

name - the domain to set.

getProperties

public java.util.Properties getProperties()

Getter method for the properties associated with the domain. Each domain may have a set of general-purpose properties associated with the domain. 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 domain.

Parameters:

properties - properties object to set.

getTriggers

public java.util.ArrayList getTriggers()

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

Returns:

the triggers associated with this domain.

setTriggers

public void setTriggers(java.util.ArrayList triggers)

Setter methods for the triggers associated with this domain.

Parameters:

triggers - to set.