org.mobicents.slee.resource.sip11.wrappers.DialogWrapper Maven / Gradle / Ivy
/*
* TeleStax, Open Source Cloud Communications
* Copyright 2011-2014, Telestax Inc 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 ongoingClientTransactions = new ConcurrentHashMap(1);
/**
* the wrapped dialog
*/
protected Dialog wrappedDialog;
/**
* the local tag of the dialog, for certain cases it is out of sync with wrapped dialog, because the wrapped dialog may be created without one assigned
*/
private String localTag;
/*
* the slee {@link Address} where events on this dialog are fired.
*/
protected javax.slee.Address eventFiringAddress;
/**
* tracer for this class
*/
private static Tracer tracer;
/**
*
*/
protected SipActivityHandle lastCancelableTransactionId;
/**
* used to delay the dialog .delete() when there are ongoing client txs
*/
private boolean pendingDelete = false;
/**
*
*/
public DialogWrapper(SipActivityHandle sipActivityHandle, SipResourceAdaptor ra) {
super(sipActivityHandle,ra);
if (tracer == null) {
tracer = ra.getTracer(DialogWrapper.class.getSimpleName());
}
}
public void setLocalTag(String localTag) {
this.localTag = localTag;
}
// Wrapper Methods
@Override
public javax.slee.Address getEventFiringAddress() {
if (eventFiringAddress == null) {
eventFiringAddress = new javax.slee.Address(AddressPlan.SIP, wrappedDialog.getLocalParty().toString());
}
return eventFiringAddress;
}
@Override
public boolean isAckTransaction() {
return false;
}
@Override
public boolean isDialog() {
return true;
}
// Dialog Activity Methods
/*
* (non-Javadoc)
* @see net.java.slee.resource.sip.DialogActivity#associateServerTransaction(javax.sip.ClientTransaction, javax.sip.ServerTransaction)
*/
public void associateServerTransaction(ClientTransaction ct, ServerTransaction st) {
if (ct == null) {
throw new NullPointerException("null client transaction");
}
if (st == null) {
throw new NullPointerException("null server transaction");
}
final ClientTransactionWrapper ctw = (ClientTransactionWrapper) ct;
final ServerTransactionWrapper stw = (ServerTransactionWrapper) st;
final DialogWrapper stDialog = (DialogWrapper) st.getDialog();
if (stDialog == null) {
throw new IllegalArgumentException("the specified server transaction has no dialog.");
}
ctw.setAssociatedServerTransaction(((ServerTransactionActivityHandle) stw.getActivityHandle()).getTxId(),true);
}
/*
* (non-Javadoc)
* @see net.java.slee.resource.sip.DialogActivity#getAssociatedServerTransactionId(javax.sip.ClientTransaction)
*/
public ServerTransaction getAssociatedServerTransaction(ClientTransaction ct) {
if(ct == null) {
throw new NullPointerException("Passed Client Transaction is null!");
}
final ClientTransactionWrapper ctw = (ClientTransactionWrapper) ct;
final String associatedServerTransactionId = ctw.getAssociatedServerTransactionId();
if (associatedServerTransactionId != null) {
SIPServerTransaction st = (SIPServerTransaction) ra.getProviderWrapper().getClusteredSipStack().findTransaction(associatedServerTransactionId, true);
return (ServerTransaction) ra.getTransactionWrapper(st);
}
else {
return null;
}
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#createRequest(java.lang.String)
*/
public Request createRequest(String methodName) throws SipException {
try{
final Request request = this.wrappedDialog.createRequest(methodName);
if (getState() == null) {
// adds load balancer to route if exists
ra.getProviderWrapper().addLoadBalancerToRoute(request);
}
return request;
}catch (Exception e) {
throw new SipException(e.getMessage(),e);
}
}
/*
*
* @see
* net.java.slee.resource.sip.DialogActivity#createRequest(javax.sip.message
* .Request)
*/
@SuppressWarnings("unchecked")
public Request createRequest(Request origRequest) throws SipException {
final SleeSipProviderImpl provider = ra.getProviderWrapper();
final SIPRequest request = (SIPRequest) origRequest.clone();
// note: no need to work on dialog tags, since remote tag remains the same and
// local tag will be ensured when sending
/*
* If the B2BUA decides to relay the received request, its associated
* UAC generates a new downstream SIP request with its new Via, Max-
* Forwards, Call-ID, CSeq, and Contact header fields, as described in
* RFC3261.
*/
final String transport = request.getTopmostViaHeader().getTransport();
final ListeningPointImpl listeningPointImpl = (ListeningPointImpl) provider.getListeningPoint(transport);
final ViaList viaList = new ViaList();
viaList.add((Via) listeningPointImpl.createViaHeader());
request.setVia(viaList);
try {
request.setHeader(provider.getHeaderFactory().createMaxForwardsHeader(70));
} catch (InvalidArgumentException e) {
throw new SipException("Failed to create max forwards header",e);
}
request.setHeader((Header) getCallId().clone());
// note: cseq will be set by dialog when sending
// set contact if the original response had it
URI requestURI = request.getRequestURI();
if (requestURI != null && requestURI.isSipURI()) {
SipURI sipURI = (SipURI) requestURI;
if (sipURI.getHost().equals(listeningPointImpl.getIPAddress()) && sipURI.getPort() == listeningPointImpl.getPort()) {
// set remote target as request uri
request.setRequestURI(getRemoteTarget().getURI());
}
}
if (origRequest.getHeader(ContactHeader.NAME) != null) {
request.setHeader(listeningPointImpl.createContactHeader());
}
/*
* Route header fields of the upstream request MAY be copied in the
* downstream request, except the topmost Route header if it is under
* the responsibility of the B2BUA. Additional Route header fields MAY
* also be added to the downstream request.
*/
if (getState() == null || !wrappedDialog.getRouteSet().hasNext()) {
// no route recorded
final RouteList routeList = request.getRouteHeaders();
if (routeList != null) {
final RouteHeader topRoute = routeList.get(0);
final URI topRouteURI = topRoute.getAddress().getURI();
if (topRouteURI.isSipURI()) {
final SipURI topRouteSipURI = (SipURI) topRouteURI;
if (topRouteSipURI.getHost().equals(listeningPointImpl.getIPAddress())
&& topRouteSipURI.getPort() == listeningPointImpl.getPort()) {
if (routeList.size() > 1) {
routeList.remove(0);
}
else {
request.removeHeader(RouteHeader.NAME);
}
}
}
}
// adds load balancer to route if exists
ra.getProviderWrapper().addLoadBalancerToRoute(request);
}
else {
// replace route in orig request with the one in dialog
request.removeHeader(RouteHeader.NAME);
final RouteList routeList = new RouteList();
for (Iterator it = wrappedDialog.getRouteSet(); it.hasNext();) {
Route route = it.next();
routeList.add(route);
}
if (!routeList.isEmpty()) {
request.addHeader(routeList);
}
}
/*
* Record-Route header fields of the upstream request are not copied in
* the new downstream request, as Record-Route is only meaningful for
* the upstream dialog.
*/
request.removeHeader(RecordRouteHeader.NAME);
return request;
}
/*
* (non-Javadoc)
* @see net.java.slee.resource.sip.DialogActivity#sendRequest(javax.sip.message.Request)
*/
public ClientTransaction sendRequest(Request request) throws SipException, TransactionUnavailableException {
ensureCorrectDialogLocalTag(request);
final ClientTransactionWrapper ctw = ra.getProviderWrapper().getNewDialogActivityClientTransaction(this,request);
if (request.getMethod().equals(Request.INVITE))
lastCancelableTransactionId = ctw.getActivityHandle();
if (tracer.isInfoEnabled()) {
tracer.info(String.valueOf(ctw)+" sending request:\n"+request);
}
wrappedDialog.sendRequest(ctw.getWrappedClientTransaction());
return ctw;
}
/**
*
* @param request
* @throws SipException
*/
protected void ensureCorrectDialogLocalTag(Request request) throws SipException {
// ensure we are using the right tag
final String localTag = getLocalTag();
if (localTag != null) {
try {
((FromHeader)request.getHeader(FromHeader.NAME)).setTag(localTag);
} catch (ParseException e) {
throw new SipException(e.getMessage(),e);
}
}
final String remoteTag = getRemoteTag();
if (remoteTag != null) {
try {
((ToHeader)request.getHeader(ToHeader.NAME)).setTag(remoteTag);
} catch (ParseException e) {
throw new SipException(e.getMessage(),e);
}
}
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#sendRequest(javax.sip.ClientTransaction)
*/
public void sendRequest(ClientTransaction ct) throws TransactionDoesNotExistException, SipException {
final Request request = ct.getRequest();
ensureCorrectDialogLocalTag(request);
if (tracer.isInfoEnabled()) {
tracer.info(String.valueOf(ct)+" sending request:\n"+request);
}
wrappedDialog.sendRequest(((ClientTransactionWrapper)ct).getWrappedClientTransaction());
}
/*
* FIXME untested
* (non-Javadoc)
* @see net.java.slee.resource.sip.DialogActivity#createResponse(javax.sip.ServerTransaction, javax.sip.message.Response)
*/
@SuppressWarnings("unchecked")
public Response createResponse(ServerTransaction origServerTransaction, Response receivedResponse) throws SipException {
final SleeSipProviderImpl provider = ra.getProviderWrapper();
Response forgedResponse = null;
try {
forgedResponse = provider.getMessageFactory().createResponse(receivedResponse.getStatusCode(), origServerTransaction.getRequest());
} catch (ParseException e) {
throw new SipException("Failed to forge message", e);
}
final DialogState dialogState = getState();
final String localTag = getLocalTag();
if ((dialogState == null || dialogState == DialogState.EARLY) && localTag != null && isServer()) {
// no tag set in the response, since the dialog creating transaction didn't had it
try {
((ToHeader)forgedResponse.getHeader(ToHeader.NAME)).setTag(localTag);
} catch (ParseException e) {
throw new SipException("Failed to set local tag", e);
}
}
// copy headers
ListIterator lit = receivedResponse.getHeaderNames();
String headerName = null;
ListIterator headersIterator = null;
while (lit.hasNext()) {
headerName = lit.next();
if (Utils.getHeadersToOmmitOnResponseCopy().contains(headerName)) {
continue;
} else {
forgedResponse.removeHeader(headerName);
headersIterator = receivedResponse.getHeaders(headerName);
while (headersIterator.hasNext()) {
forgedResponse.addLast((Header)headersIterator.next().clone());
}
}
}
// Copy content
final byte[] rawOriginal = receivedResponse.getRawContent();
if (rawOriginal != null && rawOriginal.length != 0) {
final byte[] copy = new byte[rawOriginal.length];
System.arraycopy(rawOriginal, 0, copy, 0, copy.length);
try {
forgedResponse.setContent(copy, (ContentTypeHeader) forgedResponse
.getHeader(ContentTypeHeader.NAME));
} catch (ParseException e) {
tracer.severe("Failed to set content on forged response. To copy value [" + new String(copy) + "] Type ["
+ receivedResponse.getHeader(ContentTypeHeader.NAME) + "]\n", e);
}
}
// set contact if the received response had it
if (receivedResponse.getHeader(ContactHeader.NAME) != null) {
final String transport = ((ViaHeader) forgedResponse.getHeader(ViaHeader.NAME)).getTransport();
forgedResponse.setHeader(((ListeningPointImpl)provider.getListeningPoint(transport)).createContactHeader());
}
return forgedResponse;
}
/*
* (non-Javadoc)
* @see net.java.slee.resource.sip.DialogActivity#sendCancel()
*/
public ClientTransaction sendCancel() throws SipException {
try {
final ClientTransaction inviteCTX = this.getClientTransaction(lastCancelableTransactionId);
final ClientTransactionWrapper cancelTransaction = ra.getProviderWrapper().getNewDialogActivityClientTransaction(this,inviteCTX.createCancel());
if (tracer.isInfoEnabled()) {
tracer.info(String.valueOf(cancelTransaction) + " sending request:\n"
+ cancelTransaction.getRequest());
}
cancelTransaction.getWrappedClientTransaction().sendRequest();
return cancelTransaction;
} catch (NullPointerException npe) {
throw new SipException("Failed to find client transaction or no INVITE transaction present",npe);
} catch (Exception e) {
throw new SipException("Failed to send CANCEL due to:", e);
}
}
// Dialog Methods
/*
* (non-Javadoc)
* @see javax.sip.Dialog#createAck(long)
*/
public Request createAck(long arg0) throws InvalidArgumentException, SipException {
return wrappedDialog.createAck(arg0);
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#createPrack(javax.sip.message.Response)
*/
public Request createPrack(Response arg0) throws DialogDoesNotExistException, SipException {
return this.wrappedDialog.createPrack(arg0);
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#createReliableProvisionalResponse(int)
*/
public Response createReliableProvisionalResponse(int arg0) throws InvalidArgumentException, SipException {
return wrappedDialog.createReliableProvisionalResponse(arg0);
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#delete()
*/
public void delete() {
if (pendingDelete = (ongoingClientTransactions != null && !ongoingClientTransactions.isEmpty())) {
// ongoing client txs, need those to end first
return;
}
final DialogState currentState = wrappedDialog != null ? wrappedDialog.getState() : null;
boolean stackDoesNotFiresDialogTerminatedEvent = !isEnding()
&& !wrappedDialog.isServer() && (currentState == null || currentState == DialogState.TERMINATED);
wrappedDialog.delete();
if (stackDoesNotFiresDialogTerminatedEvent) {
ra.processDialogTerminated(this);
}
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getCallId()
*/
public CallIdHeader getCallId() {
return this.wrappedDialog.getCallId();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getDialogId()
*/
public String getDialogId() {
// FIXME if localtag is set it is not good
return this.wrappedDialog.getDialogId();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getFirstTransaction()
*/
@Deprecated
public Transaction getFirstTransaction() {
return this.wrappedDialog.getFirstTransaction();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getLocalParty()
*/
public Address getLocalParty() {
return this.wrappedDialog.getLocalParty();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getRemoteParty()
*/
public Address getRemoteParty() {
return this.wrappedDialog.getRemoteParty();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getRemoteTarget()
*/
public Address getRemoteTarget() {
return this.wrappedDialog.getRemoteTarget();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getLocalSeqNumber()
*/
public long getLocalSeqNumber() {
return this.wrappedDialog.getLocalSeqNumber();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getLocalSequenceNumber()
*/
@Deprecated
public int getLocalSequenceNumber() {
return this.wrappedDialog.getLocalSequenceNumber();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getLocalTag()
*/
public String getLocalTag() {
if (localTag == null) {
if (wrappedDialog != null) {
localTag = wrappedDialog.getLocalTag();
}
}
return localTag;
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getRemoteSeqNumber()
*/
public long getRemoteSeqNumber() {
return this.wrappedDialog.getRemoteSeqNumber();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getRemoteSequenceNumber()
*/
@Deprecated
public int getRemoteSequenceNumber() {
return this.wrappedDialog.getRemoteSequenceNumber();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getRemoteTag()
*/
public String getRemoteTag() {
return this.wrappedDialog.getRemoteTag();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getRouteSet()
*/
@SuppressWarnings("unchecked")
public Iterator getRouteSet() {
return this.wrappedDialog.getRouteSet();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#getState()
*/
public DialogState getState() {
return this.wrappedDialog.getState();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#incrementLocalSequenceNumber()
*/
public void incrementLocalSequenceNumber() {
this.wrappedDialog.incrementLocalSequenceNumber();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#isSecure()
*/
public boolean isSecure() {
return wrappedDialog.isSecure();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#isServer()
*/
public boolean isServer() {
return wrappedDialog.isServer();
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#sendAck(javax.sip.message.Request)
*/
public void sendAck(Request arg0) throws SipException {
if (tracer.isInfoEnabled()) {
tracer.info(this+" sending ACK:\n"+arg0);
}
wrappedDialog.sendAck(arg0);
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#sendReliableProvisionalResponse(javax.sip.message.Response)
*/
public void sendReliableProvisionalResponse(Response arg0) throws SipException {
wrappedDialog.sendReliableProvisionalResponse(arg0);
}
/*
* (non-Javadoc)
* @see javax.sip.Dialog#terminateOnBye(boolean)
*/
public void terminateOnBye(boolean arg0) throws SipException {
wrappedDialog.terminateOnBye(arg0);
}
// ...
@Override
public String toString() {
return new StringBuilder("DialogWrapper[ handle = ").append(getActivityHandle())
.append(", state = ").append(getState())
.append(", clientTXs = ").append(ongoingClientTransactions == null ? "" : ongoingClientTransactions.keySet())
.append(" ]").toString();
}
// Own Methods
/**
*
* @param transaction
* @return
*/
public ClientTransaction getClientTransaction(SipActivityHandle transaction) {
return this.ongoingClientTransactions.get(transaction);
}
/**
*
* @param ctw
*/
public boolean addOngoingTransaction(ClientTransactionWrapper ctw) {
return ongoingClientTransactions.put(ctw.getActivityHandle(), ctw) == null;
}
/**
*
* @param ctw
*/
public void removeOngoingTransaction(ClientTransactionWrapper ctw) {
if (ongoingClientTransactions != null) {
if (ongoingClientTransactions.remove(ctw.getActivityHandle()) != null) {
if (pendingDelete) {
delete();
}
}
}
}
/* (non-Javadoc)
* @see org.mobicents.slee.resource.sip11.wrappers.Wrapper#clear()
*/
@Override
public void clear() {
super.clear();
if (wrappedDialog != null) {
wrappedDialog.setApplicationData(null);
wrappedDialog = null;
}
ongoingClientTransactions = null;
localTag = null;
lastCancelableTransactionId = null;
eventFiringAddress = null;
}
static final String[] EMPTY_STRING_ARRAY = {};
private void writeObject(ObjectOutputStream stream) throws IOException {
throw new IOException("serialization forbidden");
}
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException {
throw new IOException("serialization forbidden");
}
/**
* @return the wrappedDialog
*/
public Dialog getWrappedDialog() {
return wrappedDialog;
}
/**
* @param wrappedDialog the wrappedDialog to set
*/
public void setWrappedDialog(Dialog wrappedDialog) {
this.wrappedDialog = wrappedDialog;
if (wrappedDialog != null) {
wrappedDialog.setApplicationData(new DialogWithIdWrapperAppData(this));
}
}
/**
* Indicates if the dialog is UAC.
* @return
*/
public boolean isClientDialog() {
return false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy