public class CstaProvider
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
CstaCustomXMLHandler |
customXMLHandler
The XML handler to send CSTA request with customized XML
The customXMLHandler can send a CSTA request to OSV with any XML format in a raw string.
|
Constructor and Description |
---|
CstaProvider()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
CstaDevice |
addDevice(java.lang.String serviceID)
Add one Device to Provider.
|
boolean |
connectToSystem(CstaConfiguration cfg)
Connect to system.
|
CstaGetConfigurationDataResponse |
CstaGetConfigurationData(java.lang.String ons,
java.lang.String cellDeviceGNF,
java.lang.String cellCarrier,
java.lang.String deviceModel,
java.lang.String deviceOS)
GetConfigurationData.
|
CstaGetLogicalDeviceInformationResponse |
CstaGetLogicalDeviceInformation(CstaDeviceID deviceId)
GetLogicalDeviceInformation.
|
CstaGetLogicalDeviceInformationResponse |
CstaGetLogicalDeviceInformationNID(CstaDeviceID networkInterfaceDeviceId)
GetLogicalDeviceInformationNID.
|
boolean |
CstaGetSwitchingFunctionDevices(CstaDeviceCategory category)
GetSwitchingFunctionDevices.
|
boolean |
CstaGetSwitchingFunctionDevices(CstaDeviceID deviceId,
CstaDeviceCategory category)
GetSwitchingFunctionDevices.
|
boolean |
disconnectFromSystem()
Disconnect from Csta Server.
|
boolean |
disconnectFromSystem(boolean dropConnection)
Disconnect from Csta Server.
|
boolean |
endHeartbeat()
End the heart beat.
|
CstaApplicationSession |
getApplicationSession() |
CstaMonitor |
getCstaMonitorByServiceID(java.lang.String serviceID)
Retrieve monitor by providing a service Id.
|
CstaMonitor[] |
getCstaMonitorList()
Retrieve current monitor list.
|
CstaRouteService |
getCstaRouteServiceByServiceID(java.lang.String serviceID)
Retrieve RouteService by providing a service Id.
|
CstaRouteService[] |
getCstaRouteServiceList()
Retrieve current registered RouteService list
|
CstaDevice |
getDevice(java.lang.String serviceID)
Get Device from Provider.
|
CstaMonitor |
MonitorStart(CstaDevice device)
MonitorStart Device.
|
CstaMonitor |
MonitorStart(CstaDevice device,
boolean silmTag)
MonitorStart Device.
|
CstaMonitor |
MonitorStart(CstaDevice device,
boolean silmTag,
boolean NID)
MonitorStart Device.
|
CstaMonitor |
MonitorStart(CstaDevice device,
boolean silmTag,
boolean NID,
CstaFilterEventList filter)
MonitorStart Device.
|
boolean |
MonitorStop(java.lang.String crossRefId)
MonitorStop Device.
|
boolean |
registerEventListener(CstaEventListener listener)
register a CstaEventObject EventListener on CstaProvider.
|
void |
removeDevice(java.lang.String serviceID)
Remove Device from Provider.
|
boolean |
removeEventListener(CstaEventListener listener)
remove a event listener from CstaProvider.
|
int |
ResetApplicationSessionTimer(int requestedSessionDuration) |
int |
ResetApplicationSessionTimer(int requestedSessionDuration,
int heartBeatTimer) |
CstaRouteService |
RouteRegister(CstaDevice device)
Register Routing Service on a CstaDevice.
|
boolean |
RouteRegisterCancel(java.lang.String routeRegisterReqID)
Cancel a registered Routing Service.
|
CstaApplicationSession |
StartApplicationSession(int sessionDuration) |
CstaApplicationSession |
StartApplicationSession(java.lang.String applicationID,
java.lang.String protocolVersion,
int sessionDuration) |
CstaApplicationSession |
StartApplicationSession(java.lang.String applicationID,
java.lang.String protocolVersion,
int sessionDuration,
int heartBeatTimer) |
boolean |
startHeartbeat(int delay,
int interval)
Start Heart beat between the CSTA Server and
CSTA-SDK.
|
void |
StopApplicationSession(java.lang.String definedEndReason,
java.lang.String appEndReason) |
public CstaCustomXMLHandler customXMLHandler
public boolean registerEventListener(CstaEventListener listener)
listener
- the event listener.public boolean removeEventListener(CstaEventListener listener)
listener
- the listener that needs to be removed.public boolean connectToSystem(CstaConfiguration cfg) throws CstaException
cfg
- the configurationCstaException
- the CstaException that contains error cause and error messagepublic boolean disconnectFromSystem() throws CstaException
CstaException
- the csta exceptionpublic boolean disconnectFromSystem(boolean dropConnection) throws CstaException
CstaException
- the csta exceptionpublic CstaMonitor MonitorStart(CstaDevice device) throws CstaException
device
- the deviceCstaException
- the csta exceptionpublic CstaMonitor MonitorStart(CstaDevice device, boolean silmTag) throws CstaException
device
- the devicesilmTag
- true "SILM" will be presented false notCstaException
- the csta exceptionpublic CstaMonitor MonitorStart(CstaDevice device, boolean silmTag, boolean NID) throws CstaException
device
- the devicesilmTag
- true "SILM" will be presented false notNID
- true: monitorStart on a network interface device, false: monitorStart on a subscriberCstaException
- the csta exceptionpublic CstaMonitor MonitorStart(CstaDevice device, boolean silmTag, boolean NID, CstaFilterEventList filter) throws CstaException
device
- the devicesilmTag
- true "SILM" will be presented false notNID
- true: monitorStart on a network interface device, false: monitorStart on a subscriberfilterMap:
- bitmap of events to filter out from the monitored deviceCstaException
- the csta exceptionpublic boolean MonitorStop(java.lang.String crossRefId) throws CstaException
crossRefId
- the cross ref idCstaException
- the csta exceptionpublic CstaDevice addDevice(java.lang.String serviceID)
serviceID
- the service idpublic void removeDevice(java.lang.String serviceID)
serviceID
- the service idpublic CstaDevice getDevice(java.lang.String serviceID)
serviceID
- the service idpublic boolean startHeartbeat(int delay, int interval)
delay
- measured in seconds, can be in any rangeinterval
- measured in seconds in range from 30s to 300spublic boolean endHeartbeat()
public CstaMonitor getCstaMonitorByServiceID(java.lang.String serviceID)
serviceID
- the service idpublic CstaMonitor[] getCstaMonitorList()
public CstaRouteService RouteRegister(CstaDevice device) throws CstaException
device
- the CstaDeviceCstaException
- the csta exceptionpublic boolean RouteRegisterCancel(java.lang.String routeRegisterReqID) throws CstaException
routeRegisterReqID
- CstaException
public CstaRouteService getCstaRouteServiceByServiceID(java.lang.String serviceID)
serviceID
- the service idpublic CstaRouteService[] getCstaRouteServiceList()
public CstaApplicationSession StartApplicationSession(int sessionDuration) throws CstaException
CstaException
public CstaApplicationSession StartApplicationSession(java.lang.String applicationID, java.lang.String protocolVersion, int sessionDuration) throws CstaException
CstaException
public CstaApplicationSession StartApplicationSession(java.lang.String applicationID, java.lang.String protocolVersion, int sessionDuration, int heartBeatTimer) throws CstaException
CstaException
public CstaApplicationSession getApplicationSession()
public int ResetApplicationSessionTimer(int requestedSessionDuration) throws CstaException
CstaException
public int ResetApplicationSessionTimer(int requestedSessionDuration, int heartBeatTimer) throws CstaException
CstaException
public void StopApplicationSession(java.lang.String definedEndReason, java.lang.String appEndReason) throws CstaException
CstaException
public boolean CstaGetSwitchingFunctionDevices(CstaDeviceID deviceId, CstaDeviceCategory category) throws CstaException
device
- requestedDeviceCategory
- CstaException
- the csta exceptionpublic boolean CstaGetSwitchingFunctionDevices(CstaDeviceCategory category) throws CstaException
requestedDeviceCategory
- CstaException
- the csta exceptionpublic CstaGetLogicalDeviceInformationResponse CstaGetLogicalDeviceInformation(CstaDeviceID deviceId) throws CstaException
deviceId
- CstaException
- the csta exceptionpublic CstaGetLogicalDeviceInformationResponse CstaGetLogicalDeviceInformationNID(CstaDeviceID networkInterfaceDeviceId) throws CstaException
networkInterfaceDeviceId
- CstaException
- the csta exceptionpublic CstaGetConfigurationDataResponse CstaGetConfigurationData(java.lang.String ons, java.lang.String cellDeviceGNF, java.lang.String cellCarrier, java.lang.String deviceModel, java.lang.String deviceOS) throws CstaException
ons
- cellDeviceGNF
- cellCarrier
- deviceModel
- deviceOS
- CstaException
- the csta exception