public interface TcapLegManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT_NAME_KEY
TCAP Leg Manager component name key, used in
FailedInstruction . |
static java.lang.String |
COMPONENT_TYPE_NAME
TCAP Leg Manager component type value, used in
FailedInstruction . |
Modifier and Type | Method and Description |
---|---|
com.opencloud.sentinel.sbb.SentinelActivityContextInterface |
asSentinelActivityContextInterface(javax.slee.ActivityContextInterface aci)
Get the sentinel aci interface that corresponds to an aci
|
TcapLeg |
createLeg(TcapApplicationContext appContext,
java.lang.String legName,
SasEndpointType endpointType)
Immediately create a leg.
|
TcapLeg |
createLeg(TcapApplicationContext appContext,
java.lang.String legName,
java.lang.String targetFeature,
SasEndpointType endpointType)
Immediately create a leg.
|
void |
detachFromAllLegs()
Immediately detach from all legs.
|
void |
detachFromLeg(TcapLeg leg)
Immediately remove the Leg from the leg manager.
|
void |
endSession()
Immediately clear all pending requests on all legs.
|
com.opencloud.sentinel.sbb.SentinelActivityContextInterface |
getAciForLeg(TcapLeg leg)
Get the ACI of the dialog associated with a leg.
|
Dialog |
getDialogForLeg(TcapLeg leg)
Get the dialog associated with a leg.
|
TcapLeg |
getLeg(Dialog tcapDialog)
Determine the leg associated with the specified session.
|
int |
getLegCount()
Get the number of legs for the Leg Manager is managing.
|
java.util.Collection<TcapLeg> |
getLegs()
Return a Collection of legs for Leg Manager instance.
|
TcapApplicationContext |
getTcapApplicationContext(java.lang.String protocolName,
java.lang.String asn1Module,
java.lang.String apiName)
Return a TcapApplicationContext object for a protocol, ans1 module, api, or null if not such TcapApplicationContext is known.
|
TcapLeg |
importAsNewLeg(javax.slee.ActivityContextInterface aci,
java.lang.String legName,
SasEndpointType endpointType)
Immediately create a new leg and a dialog.
|
TcapLeg |
importAsNewLeg(Dialog tcapDialog,
java.lang.String legName,
SasEndpointType endpointType)
Immediately creates a new leg.
|
void |
releaseLeg(TcapLeg leg)
Immediately unlinks the leg if it is linked, clears any pending instructions and adds the releaseLeg
instruction.
|
static final java.lang.String COMPONENT_TYPE_NAME
FailedInstruction
.static final java.lang.String COMPONENT_NAME_KEY
FailedInstruction
.com.opencloud.sentinel.sbb.SentinelActivityContextInterface asSentinelActivityContextInterface(javax.slee.ActivityContextInterface aci)
aci
- the aciTcapLeg createLeg(TcapApplicationContext appContext, java.lang.String legName, SasEndpointType endpointType) throws DuplicateLegException, ProtocolException
appContext
- TcapApplicationContext
to be sent.legName
- the legName must be unique for this Sentinel SIP service instance.
The recommended format for the name is endpointType
- the type of SAS endpoint to use in call flows for this legDuplicateLegException
- If leg already exists with the supplied name.ProtocolException
- If TcapApplicationContext is not supported.TcapLeg createLeg(TcapApplicationContext appContext, java.lang.String legName, java.lang.String targetFeature, SasEndpointType endpointType) throws DuplicateLegException, ProtocolException
appContext
- TcapApplicationContext
to be sent.legName
- the legName must be unique for this Sentinel SIP service instance.
The recommended format for the name is targetFeature
- the name of a feature that should directly received any events on the new leg.endpointType
- the type of SAS endpoint to use in call flows for this legDuplicateLegException
- If leg already exists with the supplied name.ProtocolException
- If TcapApplicationContext is not supported.TcapLeg importAsNewLeg(javax.slee.ActivityContextInterface aci, java.lang.String legName, SasEndpointType endpointType) throws DuplicateLegException
aci
- ACI of new Leg. The ACI must have an activity of type MapDialog. The created Leg is accessed in
the next feature invocation using the legName.legName
- the legName must be unique for this Sentinel SIP service instance.
The recommended format for the legName is endpointType
- the type of SAS endpoint to use in call flows for this legDuplicateLegException
- If leg already exists with the supplied name.TcapLeg importAsNewLeg(Dialog tcapDialog, java.lang.String legName, SasEndpointType endpointType) throws DuplicateLegException
tcapDialog
- Dialog activity to be associated with the new Leg.legName
- the legName must be unique for this Sentinel SIP service instance.
The recommended format for the legname is endpointType
- the type of SAS endpoint to use in call flows for this legDuplicateLegException
- If a leg already exists with the supplied legName.void releaseLeg(TcapLeg leg)
The action taken when processing the releaseLeg instruction can be:
The appropriate action will depend on the current state of the leg. If there is a terminating message in the MessagesToSend queue of the leg, this will be used where possible.
When the LegManager has sent the Response on processing the releaseLeg instruction it will immediately remove the TcapLeg from the TcapLegManager registry.
Features which need a more fine-grained control over the release process should use a combination
of TcapLeg.sendClose(boolean)
, TcapLeg.sendUserAbort(DialogUserAbortTcapMessage)
,
detachFromLeg(TcapLeg leg)
.
leg
- TcapLeg to release.void detachFromLeg(TcapLeg leg)
leg
- TcapLeg to detach.void detachFromAllLegs()
detachFromLeg(TcapLeg)
.TcapLeg getLeg(Dialog tcapDialog)
tcapDialog
- Dialogcom.opencloud.sentinel.sbb.SentinelActivityContextInterface getAciForLeg(TcapLeg leg)
TcapLeg.getAci()
.leg
- the legDialog getDialogForLeg(TcapLeg leg)
TcapLeg.getTcapDialog()
.leg
- the legTcapApplicationContext getTcapApplicationContext(java.lang.String protocolName, java.lang.String asn1Module, java.lang.String apiName)
protocolName
- the protocol nameasn1Module
- the module nameapiName
- the api name.java.util.Collection<TcapLeg> getLegs()
int getLegCount()
void endSession()
During instruction processing end session will be performed on each leg.
Copyright © OpenCloud. All Rights Reserved.