JBoss.orgCommunity Documentation
Mobicents ISUP Stack API is transaction oriented. Transaction are used to exchanged messages which contain parameter with some trunk specific information.
Below are listed interface with short explanation.
Common part of transactions is defined as follows:
package org.mobicents.protocols.ss7.isup;
import org.mobicents.protocols.ss7.isup.message.ISUPMessage;
public interface ISUPTransaction {
/**
* Get unique transaction key associated with this transaction
* @return
*/
public TransactionKey getTransactionKey();
/**
* Determine if this transaction is server.
* @return
*/
public boolean isServerTransaction();
/**
* Get original message which started this transaction
* @return
*/
public ISUPMessage getOriginalMessage();
/**
* Determine if transaction has terminated properly.
* @return
*/
public boolean isTerminated();
/**
* Determine if transaction has timeout.
* @return
*/
public boolean isTimedout();
}
Above interface declares
getTransactionKey
method. It returns transaction key which is unique for certain
transaction.
Client transaction is defined as follows:
package org.mobicents.protocols.ss7.isup;
import java.io.IOException;
public interface ISUPClientTransaction extends ISUPTransaction {
/**
* Send request for which this transaction has been created.
* @throws ParameterRangeInvalidException
* @throws IOException
*/
public void sendRequest() throws ParameterRangeInvalidException, IOException;
/**
* State of this transaction
* @return
*/
public ISUPClientTransactionState getState();
}
Server transaction is defined accordingly to its role:
package org.mobicents.protocols.ss7.isup;
import java.io.IOException;
import org.mobicents.protocols.ss7.isup.message.ISUPMessage;
public interface ISUPServerTransaction extends ISUPTransaction{
/**
* Send answer via this transaction.
* @param msg
* @throws ParameterRangeInvalidException
* @throws IllegalArgumentException
* @throws IOException
*/
public void sendAnswer(ISUPMessage msg) throws ParameterRangeInvalidException
,IllegalArgumentException, IOException;
/**
* Get state of this transaction.
* @return
*/
public ISUPServerTransactionState getState();
}
ISUP stack declares separate factories for messages and their parameters. However both interfaces are too big to have any use if mentioned in documentation. Please refer to source for details.
ISUP stack relies on MTP to provide transport. Stack interface is defined as follows:
package org.mobicents.protocols.ss7.isup;
public interface ISUPStack {
public ISUPProvider getIsupProvider();
public void stop();
public void start();
}
Stack declares provider which allows user to access stack facilities, send messages statelesly and register listener. Provider is defined as follows:
package org.mobicents.protocols.ss7.isup;
import java.io.IOException;
import org.mobicents.protocols.ss7.isup.message.ISUPMessage;
public interface ISUPProvider {
/**
* Stateles message send over MTP. No state is maintained.
*
* @param msg
* @throws ParameterRangeInvalidException
* @throws IOException
*/
public void sendMessage(ISUPMessage msg) throws ParameterRangeInvalidException, IOException;
public void addListener(ISUPListener listener);
public void removeListener(ISUPListener listener);
public ISUPParameterFactory getParameterFactory();
public ISUPMessageFactory getMessageFactory();
/**
* Create new client transaction if it does not exist.
* @param msg
* @return
* @throws TransactionAlredyExistsException
* @throws IllegalArgumentException
*/
public ISUPClientTransaction createClientTransaction(ISUPMessage msg)
throws TransactionAlredyExistsException, IllegalArgumentException;
/**
* Create new server transaction if it does not exist.
* @param msg
* @return
* @throws TransactionAlredyExistsException
* @throws IllegalArgumentException
*/
public ISUPServerTransaction createServerTransaction(ISUPMessage msg)
throws TransactionAlredyExistsException, IllegalArgumentException;
}
Provider allows to register listener. Listener contains set of call backs useful for ISUP user. It is defined as follows:
package org.mobicents.protocols.ss7.isup;
import org.mobicents.protocols.ss7.isup.message.ISUPMessage;
/**
*
* @author kulikov
* @author baranowb
*/
public interface ISUPListener {
/**
* Called once stack receives proper ISUP message. Message holds reference to ongoing transaction if it exists.
* @param message
*/
public void onMessage(ISUPMessage message);
// etc
/**
* Called once transaction times out. Transaction times out if there
* is no answer received within configured time.
*/
public void onTransactionTimeout(ISUPClientTransaction tx);
/**
* Called once transaction times out. Transaction times out if there
* is no answer received within configured time.
*/
public void onTransactionTimeout(ISUPServerTransaction tx);
/**
* Called once transaction ends its lifecycle.
*/
public void onTransactionEnded(ISUPClientTransaction tx);
/**
* Called once transaction ends its lifecycle.
*/
public void onTransactionEnded(ISUPServerTransaction tx);
//transport methods
/**
* Method called when transport provider is not able to send/rcv messages,
* any calls to send methods after this callback will throw exception
*/
public void onTransportDown();
/**
* Method called when transport provider is able to send/rcv messages,
* any calls to send methods after this callback are welcome.
*/
public void onTransportUp();
}
Each messsage defines different setters and getters - since each message type has different set of parameters. However all messages defined by Mobicents ISUP Stack have common part:
package org.mobicents.protocols.ss7.isup.message;
public interface ISUPMessage extends ISUPComponent {
/**
* Get mandatory field, CIC.
* @return
*/
public CircuitIdentificationCode getCircuitIdentificationCode();
/**
* Set mandatory field, CIC.
* @return
*/
public void setCircuitIdentificationCode(CircuitIdentificationCode cic);
/**
* Returns message code. See Q.763 Table 4. It simply return value of static
* constant, where value of parameter is value of MESSAGE_CODE
*
* @return
*/
public MessageType getMessageType();
/**
* Adds parameter to this message.
* @param param
* @throws ParameterRangeInvalidException - thrown if parameter is not part of message.
*/
public void addParameter(ISUPParameter param) throws ParameterRangeInvalidException;
/**
* Returns parameter with passed code.
* @param parameterCode
* @return
* @throws ParameterRangeInvalidException - thrown if code does not match any parameter.
*/
public ISUPParameter getParameter(int parameterCode) throws ParameterRangeInvalidException;
/**
* Removes parameter from this message.
* @param parameterCode
* @throws ParameterRangeInvalidException
*/
public void removeParameter(int parameterCode) throws ParameterRangeInvalidException;
/**
* Return reference to transaction if it exists.
* @return
*/
public ISUPTransaction getTransaction();
/**
* @return * true - if all requried parameters are set * false - otherwise *
*/
public boolean hasAllMandatoryParameters();
}
ISUP stack depends on MTP to provide transport. Please refer to MTP documentation for configuration options supported. Below is list of ISUP specific configuration properties:
Table 4.1. ISUP Configuration Properties
Property Name | Description | Property Type | Default Value |
---|---|---|---|
isup.client.timeout |
Value of timeout in milisecond. It controls timeout of client
transaction. This value must be lower than
isup.general.timeout
| java.lang.Long | 30.000 |
isup.general.timeout | Value of timeout in millisecond. It controls how long transaction object lingers in stack before its released - in case no action is performed. | java.lang.Long | 120.000 |
Note that ISUP requires M3UA MTP provider. Configuration parameters must include configuration for it. Refer to example.
package org.mobicents.protocols.ss7.isup.impl;
import java.io.IOException;
import org.mobicents.protocols.ss7.isup.ISUPClientTransaction;
import org.mobicents.protocols.ss7.isup.ISUPListener;
import org.mobicents.protocols.ss7.isup.ISUPMessageFactory;
import org.mobicents.protocols.ss7.isup.ISUPParameterFactory;
import org.mobicents.protocols.ss7.isup.ISUPProvider;
import org.mobicents.protocols.ss7.isup.ISUPServerTransaction;
import org.mobicents.protocols.ss7.isup.ISUPStack;
import org.mobicents.protocols.ss7.isup.ParameterRangeInvalidException;
import org.mobicents.protocols.ss7.isup.TransactionAlredyExistsException;
import org.mobicents.protocols.ss7.isup.message.AddressCompleteMessage;
import org.mobicents.protocols.ss7.isup.message.AnswerMessage;
import org.mobicents.protocols.ss7.isup.message.ISUPMessage;
import org.mobicents.protocols.ss7.isup.message.InitialAddressMessage;
import org.mobicents.protocols.ss7.isup.message.parameter.CalledPartyNumber;
import org.mobicents.protocols.ss7.isup.message.parameter.CallingPartyCategory;
import org.mobicents.protocols.ss7.isup.message.parameter.CircuitIdentificationCode;
import org.mobicents.protocols.ss7.isup.message.parameter.ForwardCallIndicators;
import org.mobicents.protocols.ss7.isup.message.parameter.NatureOfConnectionIndicators;
import org.mobicents.protocols.ss7.isup.message.parameter.TransmissionMediumRequirement;
public class ClientIAM implements ISUPListener {
private MTPProvider mtpProvider;
private ISUPStack isupStack;
private ISUPProvider provider;
private ISUPMessageFactory factory;
private ISUPParameterFactory parameterFactory;
private ISUPClientTransaction ctx;
public ClientIAM(MTPProvider mtpProvider) {
super();
Properties props = new Properties();
props.setProperty("mtp.drive","m3ua");
props.setProperty("mtp.opc","123");
props.setProperty("mtp.apc","321");
props.setProperty("mtp.address.local","192.168.1.1:123");
props.setProperty("mtp.address.remote","192.168.1.12:321");
//no need to set timeout, default value is ok;
this.isupStack = new ISUPStackImpl();
this.isupStack.configure(props);
this.isupStack.start();
this.provider = this.isupStack.getIsupProvider();
this.factory = this.provider.getMessageFactory();
this.parameterFactory = this.provider.getParameterFactory();
}
public void start() throws IllegalArgumentException, TransactionAlredyExistsException
, ParameterRangeInvalidException, IOException {
InitialAddressMessage iam = this.factory.createIAM();
// create obligatory params!
NatureOfConnectionIndicators nais = this.parameterFactory.createNatureOfConnectionIndicators();
nais.setContinuityCheckIndicator(
NatureOfConnectionIndicators._CCI_PERFORMED_ON_PREVIOUS_CIRCUIT);
nais.setEchoControlDeviceIndicator(NatureOfConnectionIndicators._ECDI_INCLUDED);
nais.setSatelliteIndicator(NatureOfConnectionIndicators._SI_TWO_SATELLITE);
ForwardCallIndicators fcis = this.parameterFactory.createForwardCallIndicators();
fcis.setEndToEndInformationIndicator(true);
fcis.setEndToEndMethodIndicator(fcis._ETEMI_PASSALONG);
fcis.setInterworkingIndicator(false);
fcis.setIsdnAccessIndicator(true);
CallingPartyCategory cpg = this.parameterFactory.createCallingPartyCategory();
// ?
cpg.setCallingPartyCategory((byte) 1);
TransmissionMediumRequirement tmr = this.
parameterFactory.createTransmissionMediumRequirement();
tmr.setTransimissionMediumRequirement(tmr._MEDIUM_14x64_KBIT_UNRESTRICTED);
CalledPartyNumber cpn = this.parameterFactory.createCalledPartyNumber();
cpn.setAddress("123455");
cpn.setNumberingPlanIndicator(cpn._NPI_ISDN);
cpn.setNatureOfAddresIndicator(cpn._NAI_NATIONAL_SN);
cpn.setInternalNetworkNumberIndicator(cpn._INN_ROUTING_ALLOWED);
iam.setNatureOfConnectionIndicators(nais);
iam.setForwardCallIndicators(fcis);
iam.setCallingPartCategory(cpg);
iam.setTransmissionMediumRequirement(tmr);
iam.setCalledPartyNumber(cpn);
CircuitIdentificationCode cic = this.parameterFactory.createCircuitIdentificationCode();
cic.setCIC(12);
iam.setCircuitIdentificationCode(cic);
ctx = this.provider.createClientTransaction(iam);
ctx.sendRequest();
}
/*
* (non-Javadoc)
*
* @see
* org.mobicents.protocols.ss7.isup.ISUPListener#onMessage(org.mobicents
* .protocols.ss7.isup.message.ISUPMessage)
*/
public void onMessage(ISUPMessage message) {
switch (message.getMessageType().getCode()) {
case AddressCompleteMessage.MESSAGE_CODE:
//ACM is send back as first
break;
case AnswerMessage.MESSAGE_CODE:
//second, this terminates transaction
break;
default:
}
}
/*
* (non-Javadoc)
*
* @see
* org.mobicents.protocols.ss7.isup.ISUPListener#onTransactionEnded(org.
* mobicents.protocols.ss7.isup.ISUPClientTransaction)
*/
public void onTransactionEnded(ISUPClientTransaction tx) {
}
/*
* (non-Javadoc)
*
* @see
* org.mobicents.protocols.ss7.isup.ISUPListener#onTransactionEnded(org.
* mobicents.protocols.ss7.isup.ISUPServerTransaction)
*/
public void onTransactionEnded(ISUPServerTransaction tx) {
}
/*
* (non-Javadoc)
*
* @see
* org.mobicents.protocols.ss7.isup.ISUPListener#onTransactionTimeout(org
* .mobicents.protocols.ss7.isup.ISUPClientTransaction)
*/
public void onTransactionTimeout(ISUPClientTransaction tx) {
}
/*
* (non-Javadoc)
*
* @see
* org.mobicents.protocols.ss7.isup.ISUPListener#onTransactionTimeout(org
* .mobicents.protocols.ss7.isup.ISUPServerTransaction)
*/
public void onTransactionTimeout(ISUPServerTransaction tx) {
}
/*
* (non-Javadoc)
*
* @see org.mobicents.protocols.ss7.isup.ISUPListener#onTransportDown()
*/
public void onTransportDown() {
// TODO Auto-generated method stub
}
/*
* (non-Javadoc)
*
* @see org.mobicents.protocols.ss7.isup.ISUPListener#onTransportUp()
*/
public void onTransportUp() {
// TODO Auto-generated method stub
}
}