Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.restcomm.protocols.ss7.map.MAPDialogImpl Maven / Gradle / Ivy
/*
* Mobius Software LTD
* Copyright 2019, Mobius Software LTD and individual contributors
* by the @authors tag.
*
* This program is free software: you can redistribute it and/or modify
* under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation; either version 3 of
* the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see
*/
package org.restcomm.protocols.ss7.map;
import java.io.Externalizable;
import org.restcomm.protocols.ss7.commonapp.api.primitives.AddressString;
import org.restcomm.protocols.ss7.commonapp.api.primitives.MAPExtensionContainer;
import org.restcomm.protocols.ss7.map.api.MAPApplicationContext;
import org.restcomm.protocols.ss7.map.api.MAPDialog;
import org.restcomm.protocols.ss7.map.api.MAPException;
import org.restcomm.protocols.ss7.map.api.MAPMessage;
import org.restcomm.protocols.ss7.map.api.MAPServiceBase;
import org.restcomm.protocols.ss7.map.api.dialog.MAPDialogState;
import org.restcomm.protocols.ss7.map.api.dialog.MAPUserAbortChoice;
import org.restcomm.protocols.ss7.map.api.dialog.Reason;
import org.restcomm.protocols.ss7.map.api.errors.MAPErrorCode;
import org.restcomm.protocols.ss7.map.api.errors.MAPErrorMessage;
import org.restcomm.protocols.ss7.map.api.errors.MAPErrorMessageParameterless;
import org.restcomm.protocols.ss7.map.dialog.MAPUserAbortInfoImpl;
import org.restcomm.protocols.ss7.map.dialog.MAPUserObject;
import org.restcomm.protocols.ss7.sccp.parameter.SccpAddress;
import org.restcomm.protocols.ss7.tcap.api.MessageType;
import org.restcomm.protocols.ss7.tcap.api.TCAPException;
import org.restcomm.protocols.ss7.tcap.api.TCAPSendException;
import org.restcomm.protocols.ss7.tcap.api.tc.component.InvokeClass;
import org.restcomm.protocols.ss7.tcap.api.tc.dialog.Dialog;
import org.restcomm.protocols.ss7.tcap.api.tc.dialog.events.TCBeginRequest;
import org.restcomm.protocols.ss7.tcap.api.tc.dialog.events.TCContinueRequest;
import org.restcomm.protocols.ss7.tcap.api.tc.dialog.events.TCEndRequest;
import org.restcomm.protocols.ss7.tcap.asn.ApplicationContextName;
import org.restcomm.protocols.ss7.tcap.asn.TcapFactory;
import org.restcomm.protocols.ss7.tcap.asn.comp.Problem;
/**
*
* MAP-DialoguePDU ::= CHOICE { map-open [0] MAP-OpenInfo, map-accept [1] MAP-AcceptInfo, map-close [2] MAP-CloseInfo,
* map-refuse [3] MAP-RefuseInfo, map-userAbort [4] MAP-UserAbortInfo, map-providerAbort [5] MAP-ProviderAbortInfo}
*
* @author amit bhayani
* @author baranowb
* @author sergey vetyutnev
* @author yulianoifa
*/
public abstract class MAPDialogImpl implements MAPDialog {
private static final long serialVersionUID = 1L;
protected Dialog tcapDialog = null;
protected MAPProviderImpl mapProviderImpl = null;
protected MAPServiceBase mapService = null;
// Application Context of this Dialog
protected MAPApplicationContext appCntx;
protected AddressString destReference;
protected AddressString origReference;
protected MAPExtensionContainer extContainer = null;
protected AddressString receivedOrigReference;
protected AddressString receivedDestReference;
protected MAPExtensionContainer receivedExtensionContainer;
protected MAPDialogState state = MAPDialogState.IDLE;
// private Set incomingInvokeList = new HashSet();
protected boolean eriStyle;
protected AddressString eriMsisdn;
protected AddressString eriVlrNo;
private boolean returnMessageOnError = false;
protected MessageType tcapMessageType;
protected DelayedAreaState delayedAreaState;
private final MAPStackConfigurationManagement mapCfg;
protected MAPDialogImpl(MAPApplicationContext appCntx, Dialog tcapDialog, MAPProviderImpl mapProviderImpl,
MAPServiceBase mapService, AddressString origReference, AddressString destReference) {
this.appCntx = appCntx;
this.tcapDialog = tcapDialog;
this.mapProviderImpl = mapProviderImpl;
this.mapService = mapService;
this.destReference = destReference;
this.origReference = origReference;
this.mapCfg = this.mapProviderImpl.getMapCfg();
setUserObject(getUserObject());
}
public void setReturnMessageOnError(boolean val) {
returnMessageOnError = val;
setUserObject(getUserObject());
}
public boolean getReturnMessageOnError() {
return returnMessageOnError;
}
@Override
public Boolean isDoNotSendProtcolVersion() {
return tcapDialog.isDoNotSendProtcolVersion();
}
@Override
public void setDoNotSendProtocolVersion(Boolean doNotSendProtocolVersion) {
tcapDialog.setDoNotSendProtocolVersion(doNotSendProtocolVersion);
}
/**
*
* @return - local sccp address.
*/
public SccpAddress getLocalAddress() {
return this.tcapDialog.getLocalAddress();
}
public void setLocalAddress(SccpAddress localAddress) {
this.tcapDialog.setLocalAddress(localAddress);
}
/**
*
* @return - sccp address of calling party
*/
public SccpAddress getRemoteAddress() {
return this.tcapDialog.getRemoteAddress();
}
public void setRemoteAddress(SccpAddress remoteAddress) {
this.tcapDialog.setRemoteAddress(remoteAddress);
}
public MessageType getTCAPMessageType() {
return tcapMessageType;
}
public int getNetworkId() {
return this.tcapDialog.getNetworkId();
}
public void setNetworkId(int networkId) {
this.tcapDialog.setNetworkId(networkId);
}
public void keepAlive() {
this.tcapDialog.keepAlive();
}
public Long getLocalDialogId() {
return tcapDialog.getLocalDialogId();
}
public Long getRemoteDialogId() {
return tcapDialog.getRemoteDialogId();
}
public MAPServiceBase getService() {
return this.mapService;
}
public Dialog getTcapDialog() {
return tcapDialog;
}
public void release() {
this.setState(MAPDialogState.EXPUNGED);
if (this.tcapDialog != null)
this.tcapDialog.release();
}
public void setExtentionContainer(MAPExtensionContainer extContainer) {
this.extContainer = extContainer;
}
/**
* Adding the new incoming invokeId into incomingInvokeList list
*
* @param invokeId
* @return false: failure - this invokeId already present in the list
*/
// public boolean addIncomingInvokeId(Long invokeId) {
// if (this.incomingInvokeList.contains(invokeId))
// return false;
// else {
// this.incomingInvokeList.add(invokeId);
// return true;
// }
// }
//
// public void removeIncomingInvokeId(Long invokeId) {
// this.incomingInvokeList.remove(invokeId);
// }
//
// public Boolean checkIncomingInvokeIdExists(Long invokeId) {
// return this.incomingInvokeList.contains(invokeId);
// }
public AddressString getReceivedOrigReference() {
return receivedOrigReference;
}
public MAPExtensionContainer getReceivedExtensionContainer() {
return receivedExtensionContainer;
}
public AddressString getReceivedDestReference() {
return receivedDestReference;
}
public void abort(MAPUserAbortChoice userAbortChoise) throws MAPException {
MAPUserAbortInfoImpl mapUserAbortInfoImpl=new MAPUserAbortInfoImpl();
mapUserAbortInfoImpl.setUserAbortChoise(userAbortChoise);
mapUserAbortInfoImpl.setExtensionContainer(this.extContainer);
// Dialog is not started or has expunged - we need not send
// TC-U-ABORT,
// only Dialog removing
if (this.getState() == MAPDialogState.EXPUNGED || this.getState() == MAPDialogState.IDLE) {
this.setState(MAPDialogState.EXPUNGED);
return;
}
MAPDialogState oldState=this.getState();
this.setState(MAPDialogState.EXPUNGED);
try
{
this.mapProviderImpl.fireTCAbortUser(this.getTcapDialog(), mapUserAbortInfoImpl,this.getReturnMessageOnError());
this.extContainer = null;
}
catch(Exception ex)
{
this.state = oldState;
setUserObject(getUserObject());
}
}
public void refuse(Reason reason) throws MAPException {
// Dialog must be in the InitialReceived state
if (this.getState() != MAPDialogState.INITIAL_RECEIVED) {
throw new MAPException("Refuse can be called in the Dialog InitialReceived state");
}
MAPDialogState oldState = this.getState();
this.setState(MAPDialogState.EXPUNGED);
try
{
this.mapProviderImpl.fireTCAbortRefused(this.getTcapDialog(), reason, this.extContainer,
this.getReturnMessageOnError());
this.extContainer = null;
}
catch(Exception ex)
{
this.state = oldState;
setUserObject(getUserObject());
}
}
public void close(boolean prearrangedEnd) throws MAPException {
switch (this.tcapDialog.getState()) {
case InitialReceived:
ApplicationContextName acn = this.mapProviderImpl.getTCAPProvider().getDialogPrimitiveFactory()
.createApplicationContextName(this.appCntx.getOID());
MAPDialogState oldState=this.getState();
this.setState(MAPDialogState.EXPUNGED);
if (prearrangedEnd) {
// we do not send any data in a prearrangedEnd case
if (this.tcapDialog != null)
this.tcapDialog.release();
} else {
try
{
this.mapProviderImpl.fireTCEnd(this.getTcapDialog(), true, prearrangedEnd, acn, this.extContainer,
this.getReturnMessageOnError());
this.extContainer = null;
}
catch(Exception ex)
{
this.state = oldState;
setUserObject(getUserObject());
}
}
break;
case Active:
oldState=this.getState();
this.setState(MAPDialogState.EXPUNGED);
if (prearrangedEnd) {
// we do not send any data in a prearrangedEnd case
if (this.tcapDialog != null)
this.tcapDialog.release();
} else {
try
{
this.mapProviderImpl.fireTCEnd(this.getTcapDialog(), false, prearrangedEnd, null, null,
this.getReturnMessageOnError());
}
catch(Exception ex)
{
this.state = oldState;
setUserObject(getUserObject());
}
}
break;
case Idle:
throw new MAPException("Awaiting TC-BEGIN to be sent, can not send another dialog initiating primitive!");
case InitialSent: // we have sent TC-BEGIN already, need to wait
if (prearrangedEnd) {
// we do not send any data in a prearrangedEnd case
if (this.tcapDialog != null)
this.tcapDialog.release();
this.setState(MAPDialogState.EXPUNGED);
return;
} else {
throw new MAPException("Awaiting TC-BEGIN response, can not send another dialog initiating primitive!");
}
case Expunged: // dialog has been terminated on TC level, cant send
throw new MAPException("Dialog has been terminated, can not send primitives!");
}
}
public void closeDelayed(boolean prearrangedEnd) throws MAPException {
if (this.delayedAreaState == null) {
this.close(prearrangedEnd);
} else {
if (prearrangedEnd) {
switch (this.delayedAreaState) {
case No:
case Continue:
case End:
this.delayedAreaState = MAPDialogImpl.DelayedAreaState.PrearrangedEnd;
break;
default:
break;
}
} else {
switch (this.delayedAreaState) {
case No:
case Continue:
this.delayedAreaState = MAPDialogImpl.DelayedAreaState.End;
break;
default:
break;
}
}
}
}
public void send() throws MAPException {
switch (this.tcapDialog.getState()) {
case Idle:
ApplicationContextName acn = this.mapProviderImpl.getTCAPProvider().getDialogPrimitiveFactory()
.createApplicationContextName(this.appCntx.getOID());
this.setState(MAPDialogState.INITIAL_SENT);
this.mapProviderImpl.fireTCBegin(this.getTcapDialog(), acn, destReference, origReference,
this.extContainer, this.eriStyle, this.eriMsisdn, this.eriVlrNo, this.getReturnMessageOnError());
this.extContainer = null;
break;
case Active:
// Its Active send TC-CONTINUE
this.mapProviderImpl
.fireTCContinue(this.getTcapDialog(), false, null, null, this.getReturnMessageOnError());
break;
case InitialReceived:
// Its first Reply to TC-Begin
ApplicationContextName acn1 = this.mapProviderImpl.getTCAPProvider().getDialogPrimitiveFactory()
.createApplicationContextName(this.appCntx.getOID());
MAPDialogState oldState = this.getState();
this.setState(MAPDialogState.ACTIVE);
try
{
this.mapProviderImpl.fireTCContinue(this.getTcapDialog(), true, acn1, this.extContainer,
this.getReturnMessageOnError());
this.extContainer = null;
}
catch(Exception ex)
{
this.setState(oldState);
throw ex;
}
break;
case InitialSent: // we have sent TC-BEGIN already, need to wait
throw new MAPException("Awaiting TC-BEGIN response, can not send another dialog initiating primitive!");
case Expunged: // dialog has been terminated on TC level, cant send
throw new MAPException("Dialog has been terminated, can not send primitives!");
}
}
public void sendDelayed() throws MAPException {
if (this.delayedAreaState == null) {
this.send();
} else {
switch (this.delayedAreaState) {
case No:
this.delayedAreaState = MAPDialogImpl.DelayedAreaState.Continue;
break;
default:
break;
}
}
}
public MAPApplicationContext getApplicationContext() {
return appCntx;
}
public MAPDialogState getState() {
return state;
}
protected void setState(MAPDialogState newState) {
if (this.state == MAPDialogState.EXPUNGED) {
return;
}
this.state = newState;
setUserObject(getUserObject());
}
public void processInvokeWithoutAnswer(Integer invokeId) {
this.tcapDialog.processInvokeWithoutAnswer(invokeId);
}
public Integer sendDataComponent(Integer invokeId,Integer linkedId,InvokeClass invokeClass,Long customTimeout,Integer operationCode,MAPMessage param,Boolean isRequest,Boolean isLastResponse) throws MAPException {
try {
if(param!=null)
mapProviderImpl.getMAPStack().newMessageSent(param.getMessageType().name(), getNetworkId());
if(operationCode!=null && (param!=null || isRequest))
return this.tcapDialog.sendData(invokeId, linkedId, invokeClass, customTimeout, TcapFactory.createLocalOperationCode(operationCode), param, isRequest, isLastResponse);
else
return this.tcapDialog.sendData(invokeId, linkedId, invokeClass, customTimeout, null, param, isRequest, isLastResponse);
} catch (TCAPSendException | TCAPException e) {
throw new MAPException(e.getMessage(), e);
}
}
public void sendErrorComponent(Integer invokeId, MAPErrorMessage mem) throws MAPException {
try {
if(mem!=null)
mapProviderImpl.getMAPStack().newErrorSent(MAPErrorCode.translate(mem.getErrorCode()), getNetworkId());
if(mem instanceof MAPErrorMessageParameterless)
this.tcapDialog.sendError(invokeId, TcapFactory.createLocalErrorCode(mem.getErrorCode()), null);
else
this.tcapDialog.sendError(invokeId, TcapFactory.createLocalErrorCode(mem.getErrorCode()), mem);
} catch (TCAPSendException e) {
throw new MAPException(e.getMessage(), e);
}
}
public void sendRejectComponent(Integer invokeId, Problem problem) throws MAPException {
try {
this.tcapDialog.sendReject(invokeId, problem);
} catch (TCAPSendException e) {
throw new MAPException(e.getMessage(), e);
}
}
public void resetInvokeTimer(Integer invokeId) throws MAPException {
try {
this.getTcapDialog().resetTimer(invokeId);
} catch (TCAPException e) {
throw new MAPException("TCAPException occure: " + e.getMessage(), e);
}
}
public boolean cancelInvocation(Integer invokeId) throws MAPException {
try {
return this.getTcapDialog().cancelInvocation(invokeId);
} catch (TCAPException e) {
throw new MAPException("TCAPException occure: " + e.getMessage(), e);
}
}
public Externalizable getUserObject() {
Externalizable tcapObject = this.tcapDialog.getUserObject();
if(tcapObject == null)
return null;
else if(!(tcapObject instanceof MAPUserObject))
return tcapObject;
return ((MAPUserObject)this.tcapDialog.getUserObject()).getRealObject();
}
public void setUserObject(Externalizable userObject) {
this.tcapDialog.setUserObject(new MAPUserObject(state, returnMessageOnError, appCntx, userObject));
}
public int getMaxUserDataLength() {
return this.getTcapDialog().getMaxUserDataLength();
}
/**
* Return the MAP message length (in bytes) that will be after encoding if TC-BEGIN or TC-CONTINUE cases This value must not
* exceed getMaxUserDataLength() value
*
* @return
*/
public int getMessageUserDataLengthOnSend() throws MAPException {
try {
switch (this.tcapDialog.getState()) {
case Idle:
ApplicationContextName acn = this.mapProviderImpl.getTCAPProvider().getDialogPrimitiveFactory()
.createApplicationContextName(this.appCntx.getOID());
TCBeginRequest tb = this.mapProviderImpl.encodeTCBegin(this.getTcapDialog(), acn, destReference,
origReference, this.extContainer, this.eriStyle, this.eriMsisdn, this.eriVlrNo);
return tcapDialog.getDataLength(tb);
case Active:
// Its Active send TC-CONTINUE
TCContinueRequest tc = this.mapProviderImpl.encodeTCContinue(this.getTcapDialog(), false, null, null);
return tcapDialog.getDataLength(tc);
case InitialReceived:
// Its first Reply to TC-Begin
ApplicationContextName acn1 = this.mapProviderImpl.getTCAPProvider().getDialogPrimitiveFactory()
.createApplicationContextName(this.appCntx.getOID());
tc = this.mapProviderImpl.encodeTCContinue(this.getTcapDialog(), true, acn1, this.extContainer);
return tcapDialog.getDataLength(tc);
default:
break;
}
} catch (TCAPSendException e) {
throw new MAPException("TCAPSendException when getMessageUserDataLengthOnSend", e);
}
throw new MAPException("Bad TCAP Dialog state: " + this.tcapDialog.getState());
}
/**
* Return the MAP message length (in bytes) that will be after encoding if TC-END case This value must not exceed
* getMaxUserDataLength() value
*
* @param prearrangedEnd
* @return
*/
public int getMessageUserDataLengthOnClose(boolean prearrangedEnd) throws MAPException {
if (prearrangedEnd)
// we do not send any data in prearrangedEnd dialog termination
return 0;
try {
switch (this.tcapDialog.getState()) {
case InitialReceived:
ApplicationContextName acn = this.mapProviderImpl.getTCAPProvider().getDialogPrimitiveFactory()
.createApplicationContextName(this.appCntx.getOID());
TCEndRequest te = this.mapProviderImpl.encodeTCEnd(this.getTcapDialog(), true, prearrangedEnd, acn,
this.extContainer);
return tcapDialog.getDataLength(te);
case Active:
te = this.mapProviderImpl.encodeTCEnd(this.getTcapDialog(), false, prearrangedEnd, null, null);
return tcapDialog.getDataLength(te);
default:
break;
}
} catch (TCAPSendException e) {
throw new MAPException("TCAPSendException when getMessageUserDataLengthOnSend", e);
}
throw new MAPException("Bad TCAP Dialog state: " + this.tcapDialog.getState());
}
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("MAPDialog: LocalDialogId=").append(this.getLocalDialogId()).append(" RemoteDialogId=")
.append(this.getRemoteDialogId()).append(" MAPDialogState=").append(this.getState())
.append(" MAPApplicationContext=").append(this.appCntx).append(" TCAPDialogState=")
.append(this.tcapDialog.getState());
return sb.toString();
}
public void addEricssonData(AddressString eriMsisdn, AddressString vlrNo) {
this.eriStyle = true;
this.eriMsisdn = eriMsisdn;
this.eriVlrNo = vlrNo;
}
protected enum DelayedAreaState {
No, Continue, End, PrearrangedEnd;
}
public long getStartTimeDialog() {
return this.tcapDialog.getStartTimeDialog();
}
public long getIdleTaskTimeout() {
return tcapDialog.getIdleTaskTimeout();
}
public void setIdleTaskTimeout(long idleTaskTimeoutMs) {
tcapDialog.setIdleTaskTimeout(idleTaskTimeoutMs);
}
@Override
public int getShortTimer() {
return mapCfg.getShortTimer();
}
@Override
public int getMediumTimer() {
return mapCfg.getMediumTimer();
}
@Override
public int getLongTimer() {
return mapCfg.getLongTimer();
}
}