JCAT
v0.3.1

javax.jcat
Interface JcatProvider

All Superinterfaces:
JccProvider

public interface JcatProvider
extends JccProvider

JcatProvider interface extends the JccProvider interface. This interface is expected to be used when advanced call control features are desired. JcatProvider has the same finite state machine as JccProvider.

A JcatProvider is associated with JcatCall, JcatConnection and JcatAddress which are extensions of corresponding JCC entities. In addition, a JcatProvider also has JcatTerminal objects and JcatTerminalConnection objects associated with it during a call.


Field Summary
 
Fields inherited from interface javax.csapi.cc.jcc.JccProvider
IN_SERVICE, OUT_OF_SERVICE, SHUTDOWN
 
Method Summary
 EventFilter createEventFilterRegistration(java.lang.String terminalNameRegex, int matchDisposition, int nomatchDisposition)
          This method returns a standard EventFilter which is implemented by the JCAT platform.
 java.util.Set getCalls(JcatAddress address)
          Returns a Set of JcatCall objects in which the JcatAddress participates.
 java.util.Set getTerminals(java.lang.String nameRegex)
          Returns a Set of JcatTerminal objects administered by the JcatProvider who's name satisfies the regular expression.
 
Methods inherited from interface javax.csapi.cc.jcc.JccProvider
addCallListener, addCallLoadControlListener, addConnectionListener, addProviderListener, createCall, createEventFilterAddressRange, createEventFilterAddressRegEx, createEventFilterAnd, createEventFilterCauseCode, createEventFilterDestAddressRange, createEventFilterDestAddressRegEx, createEventFilterEventSet, createEventFilterMidCallEvent, createEventFilterMinimunCollectedAddressLength, createEventFilterOr, createEventFilterOrigAddressRange, createEventFilterOrigAddressRegEx, getAddress, getName, getState, removeCallListener, removeCallLoadControlListener, removeConnectionListener, removeProviderListener, setCallLoadControl, shutdown
 

Method Detail

getCalls

public java.util.Set getCalls(JcatAddress address)
Returns a Set of JcatCall objects in which the JcatAddress participates. The call are currently associated with the JcatProvider. When a JcatCall moves into the JccCall.INVALID state, the JcatProvider loses its reference to this JcatCall. Therefore, all Calls returned by this method must either be in the JccCall.ACTIVE state. This method returns an empty Set if zero calls match the request.

Parameters:
address - The address that participates in the calls

getTerminals

public java.util.Set getTerminals(java.lang.String nameRegex)
Returns a Set of JcatTerminal objects administered by the JcatProvider who's name satisfies the regular expression.

Parameters:
nameRegex - denotes the regular expression (for the purpose of this specification, the platform will use the Perl5 regular expressions).

createEventFilterRegistration

public EventFilter createEventFilterRegistration(java.lang.String terminalNameRegex,
                                                 int matchDisposition,
                                                 int nomatchDisposition)
                                          throws ResourceUnavailableException,
                                                 InvalidArgumentException
This method returns a standard EventFilter which is implemented by the JCAT platform. For all events that require filtering by this EventFilter, apply the following:

Parameters:
terminalNameRegex - denotes the regular expression (for the purpose of this specification, the platform will use the Perl5 regular expressions).
matchDisposition - indicates the disposition of the JcatAddressEvent.TERMINAL_REGISTERED event with equal cause code. This should be one of the legal dispositions namely, EventFilter.EVENT_BLOCK, EventFilter.EVENT_DISCARD or EventFilter.EVENT_NOTIFY.
nomatchDisposition - indicates the disposition the JcatAddressEvent.TERMINAL_REGISTERED event with other cause code. This should be one of the legal dispositions namely, EventFilter.EVENT_BLOCK, EventFilter.EVENT_DISCARD or EventFilter.EVENT_NOTIFY.
Returns:
EventFilter standard EventFilter provided by the JCAT platform to enable filtering of events based on the application's requirements.
Throws:
ResourceUnavailableException - An internal resource for completing this call is unavailable.
InvalidArgumentException - One or more of the provided argument is not valid
Since:
1.0

JCAT
v0.3.1

August, 2003
If you have any comments or queries, please mail them to JSR-122-EG@JCP.ORG

Copyright - 2001, 2003 Sun Microsystems