|
JCAT v0.3.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Like a JccAddress, a JcatAddress represents a user's directory number. This directory number may be based on
an E.164 addressing scheme or some other addressing scheme. For an IP-based network, the address
might represent an IP address or a specific string (e.g., "758-1000@telcordia.com"), as
indicated by JccAddress.getType()
. At a minimum an address is unique within a Call Agent's local domain.
A JcatAddress object has a string name which corresponds to the directory number. This name is first
assigned when the Address object is created and does not change throughout the lifetime of the
object. The operation JccAddress.getName()
returns the name of the JcatAddress object.
getTerminals()
operation.
An association between a JcatAddress and a JcatTerminal indicates that the JcatTerminal is addressable using that JcatAddress. In many instances, a telephone set (represented by a JcatTerminal object) has only one directory number (represented by a JcatAddress object) associated with it. In more complex configurations, telephone sets may have several directory numbers associated with them. Likewise, a directory number may appear on more than one telephone set.
JcatAddress objects are related to JcatCall objects via the JcatConnection object; this is the
same as in case of the JccConnection objects. The JcatConnection object
has a state which describes the current relationship between the JcatCall and the JcatAddress. Each
JcatAddress object may be part of more than one call, and in each case, is represented by a
separate JcatConnection object. The getConnections()
operation returns all connection
objects currently associated with the address.
A JcatAddress is associated with a JcatCall until the JcatConnection moves into the
JccConnection.DISCONNECTED
state. At that time, the JcatConnection is no longer reported via the
getConnections()
operation. This behavior is similar to that for JccConnection objects.
addAddressListener(JcatAddressListener,EventFilter)
operation. Applications receive events on a listener until the listener is removed via the
removeAddressListener(JcatAddressListener)
operation or until the JcatAddress
is not longer observable. In these instances, each JcatAddressListener instance receives a
JcatAddressEvent.ADDRESS_EVENT_TRANSMISSION_ENDED
as its final event.
JcatTerminal
,
JcatCall
,
JcatAddressListener
Field Summary |
Fields inherited from interface javax.csapi.cc.jcc.JccAddress |
AESA, E164, E164_MOBILE, GT, H323, IP, MULTICAST, NOT_PRESENT, NSAP, SIP, SMTP, SSN, UNDEFINED, UNICAST, URL, X400 |
Method Summary | |
void |
addAddressListener(JcatAddressListener addrlistener,
EventFilter eventFilter)
Adds a listener to the address. |
void |
deregisterTerminal(JcatTerminal term)
This method is used to deregister a JcatTerminal with a JcatAddress |
java.util.Set |
getConnections()
Returns all the connection objects associated with this address. |
boolean |
getDisplayAllowed()
Indication whether getDisplayText() is suppossed to be displayed. |
java.lang.String |
getDisplayText()
Gets the text that can be displayed on the terminal. |
java.util.Set |
getTerminals()
Returns a set of JcatTerminals associated with this JcatAddress object. |
void |
registerTerminal(JcatTerminal term)
This method is used to register a JcatTerminal with a JcatAddress |
void |
removeAddressListener(JcatAddressListener addrlistener)
Removes the given listener from the JcatAddress. |
void |
setDisplayText(java.lang.String text,
boolean displayAllowed)
Displays the specified string on the terminal. |
Methods inherited from interface javax.csapi.cc.jcc.JccAddress |
getName, getProvider, getType |
Method Detail |
public void addAddressListener(JcatAddressListener addrlistener, EventFilter eventFilter)
removeAddressListener(JcatAddressListener)
operation or until the address is no longer observable. In these instances, a
JcatAddressEvent.ADDRESS_EVENT_TRANSMISSION_ENDED
is delivered to the listener
as its final event. The listener will receive no events after
ADDRESS_EVENT_TRANSMISSION_ENDED unless the listener is explicitly re-added
via this operation.
If an application attempts to add an instance of a listener already present on this address, this attempt will silently fail.
addrlistener
- JcatAddressListener which will receive state changes in this
JcatAddress.eventFilter
- EventFilter determines if the JcatAddressEvent.TERMINAL_REGISTERED
is to be delivered to the specified listener.public void registerTerminal(JcatTerminal term) throws InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException
term
- This parameter contains the terminal which is to be registered with
this address.
InvalidPartyException
- The specified terminal provided is not valid.
MethodNotSupportedException
- This operation is not supported by the implementation.
PrivilegeViolationException
- The application does not have the proper authority to invoke this operation.public void deregisterTerminal(JcatTerminal term) throws InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException
term
- This parameter contains the terminal which is to be deregistered with
this address.
InvalidPartyException
- The specified terminal provided is not valid.
MethodNotSupportedException
- This operation is not supported by the implementation.
PrivilegeViolationException
- The application does not have the proper authority to invoke this operation.public java.util.Set getTerminals()
public void removeAddressListener(JcatAddressListener addrlistener)
JcatAddressEvent.ADDRESS_EVENT_TRANSMISSION_ENDED
event. If a listener is not part of the address, then this operation fails silently.
addrlistener
- JcatAddressListener which was registered to receive state changes
in this JcatAddress.public java.util.Set getConnections()
public void setDisplayText(java.lang.String text, boolean displayAllowed) throws InvalidArgumentException
text
- the string to be displayeddisplayAllowed
- is displaying the text is allowed
InvalidArgumentException
- This exception is thrown if one of the parameter is invalid, e.g. typically
if the text to be displayed cannot be displayed due to its length or because of invalid characters.public java.lang.String getDisplayText()
getDisplayAllowed()
returns truepublic boolean getDisplayAllowed()
getDisplayText()
is suppossed to be displayed.
getDisplayText()
is suppossed to be displayed
|
JCAT v0.3.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright - 2001, 2003 Sun Microsystems