/**
* Creates and sends a SUBSCRIBE request to the subscription <tt>Address</tt>/Request URI of a
* specific <tt>Subscription</tt> in order to request receiving event notifications and adds the
* specified <tt>Subscription</tt> to the list of subscriptions managed by this instance. The
* added <tt>Subscription</tt> may later receive notifications to process the <tt>Request</tt>s
* and/or <tt>Response</tt>s which constitute the signaling session associated with it. If the
* attempt to create and send the SUBSCRIBE request fails, the specified <tt>Subscription</tt> is
* not added to the list of subscriptions managed by this instance.
*
* @param subscription a <tt>Subscription</tt> which specifies the properties of the SUBSCRIBE
* request to be created and sent, to be added to the list of subscriptions managed by this
* instance
* @throws OperationFailedException if we fail constructing or sending the subscription request.
*/
public void subscribe(Subscription subscription) throws OperationFailedException {
Dialog dialog = subscription.getDialog();
if ((dialog != null) && DialogState.TERMINATED.equals(dialog.getState())) dialog = null;
// create the subscription
ClientTransaction subscribeTransaction = null;
try {
subscribeTransaction =
(dialog == null)
? createSubscription(subscription, subscriptionDuration)
: createSubscription(subscription, dialog, subscriptionDuration);
} catch (OperationFailedException ex) {
ProtocolProviderServiceSipImpl.throwOperationFailedException(
"Failed to create the subscription", OperationFailedException.INTERNAL_ERROR, ex, logger);
}
// we register the contact to find him when the OK will arrive
CallIdHeader callIdHeader =
(CallIdHeader) subscribeTransaction.getRequest().getHeader(CallIdHeader.NAME);
String callId = callIdHeader.getCallId();
addSubscription(callId, subscription);
// send the message
try {
if (dialog == null) subscribeTransaction.sendRequest();
else dialog.sendRequest(subscribeTransaction);
} catch (SipException ex) {
// this contact will never been accepted or rejected
removeSubscription(callId, subscription);
ProtocolProviderServiceSipImpl.throwOperationFailedException(
"Failed to send the subscription", OperationFailedException.NETWORK_FAILURE, ex, logger);
}
}
/*
* Begin Third-Party Call Control.
*/
public void initiateCall() throws IOException {
try {
try {
busyTreatment = new TreatmentManager("busy.au", 0);
} catch (IOException e) {
Logger.println("Invalid busy treatment: " + e.getMessage());
}
Logger.writeFile("Call " + cp + ": Begin SIP third party call");
setState(CallState.INVITED);
InetSocketAddress isa = callHandler.getReceiveAddress();
if (isa == null) {
throw new IOException("can't get receiver socket!");
}
// send INVITE to the CallParticipant
clientTransaction = sipUtil.sendInvite(cp, isa);
if (clientTransaction == null) {
Logger.error("Error placing call: " + cp);
setState(CallState.ENDED, "Reason='Error placing call'");
throw new IOException("Error placing call: " + cp);
}
CallIdHeader callIdHeader =
(CallIdHeader) clientTransaction.getRequest().getHeader(CallIdHeader.NAME);
sipCallId = callIdHeader.getCallId();
sipServerCallback = SipServer.getSipServerCallback();
sipServerCallback.addSipListener(sipCallId, this);
} catch (java.text.ParseException e) {
Logger.println("Call " + cp + " Error placing call " + cp + ": " + e.getMessage());
setState(CallState.ENDED, "Reason='Error placing call " + cp + " " + e.getMessage() + "'");
throw new IOException("Error placing call " + cp + " " + e.getMessage());
} catch (InvalidArgumentException e) {
Logger.println("Call " + cp + " Error placing call " + cp + ": " + e.getMessage());
setState(CallState.ENDED, "Reason='Error placing call " + cp + " " + e.getMessage() + "'");
throw new IOException("Error placing call " + cp + " " + e.getMessage());
} catch (SipException e) {
Logger.println("Call " + cp + " Error placing call " + cp + ": " + e.getMessage());
setState(CallState.ENDED, "Reason='Error placing call " + cp + " " + e.getMessage() + "'");
throw new IOException("Error placing call " + cp + " " + e.getMessage());
}
}
/**
* handles a BYE request
*
* @param request the request
* @param transId the transaction Id
* @throws TransactionDoesNotExistException when the transaction record does not exist.
*/
private void handleBye(Request request, ServerTransaction st) {
try {
CallIdHeader callIdHeader = (CallIdHeader) request.getHeader("Call-Id");
String sipCallId = callIdHeader.getCallId();
if (sipCallId.equals(this.sipCallId)) {
receivedBye = true;
try {
Logger.writeFile("Call " + cp + " has hung up.");
// sipUtil.sendOK(clientTransaction, st, cp);
sipUtil.sendOK(request, st);
} catch (Exception e) {
/*
* We sometimes get a null ServerTransaction
*/
}
cancelRequest("hung up");
sipServerCallback.removeSipListener(sipCallId);
} else {
/*
* this should not happen since the message has been
* delegated to this sip agent.
*/
throw new TransactionDoesNotExistException(
cp + "BYE request received did not " + "match either party: " + request);
}
} catch (TransactionDoesNotExistException e) {
Logger.error("Call " + cp + " Transaction not found " + e.getMessage());
} catch (SipException e) {
Logger.exception("Call " + cp + " SIP Stack error", e);
cancelRequest("handleBye: SIP Stack error " + e.getMessage());
} catch (Exception e) {
Logger.exception("Call " + cp + " Unknown error ", e);
cancelRequest("handleBye: SIP Stack error " + e.getMessage());
}
}
/**
* handles the INVITED state.
*
* @param response the response
* @param clientTransaction the client transaction
* @throws SipException SIP stack related error
*/
private void handleCallParticipantInvited(Response response, ClientTransaction clientTransaction)
throws ParseException, SipException, InvalidArgumentException {
FromHeader fromHeader = (FromHeader) response.getHeader(FromHeader.NAME);
String displayName = fromHeader.getAddress().getDisplayName();
int statusCode = response.getStatusCode();
Logger.println(
"handleCallParticipantInvited "
+ cp
+ " status "
+ statusCode
+ " "
+ response.getReasonPhrase());
Logger.println("handleCallParticipantInvited , displayname " + displayName);
CallIdHeader callIdHeader = (CallIdHeader) response.getHeader(CallIdHeader.NAME);
if (sipCallId.equals(callIdHeader.getCallId())
&& displayName.equals(cp.getDisplayName())
&& (statusCode == Response.OK || statusCode == Response.SESSION_PROGRESS)
&& ((CSeqHeader) response.getHeader(CSeqHeader.NAME)).getMethod().equals(Request.INVITE)) {
if (statusCode == Response.SESSION_PROGRESS) {
/*
* For some calls, we never get an OK. Instead we just get
* SESSION_PROGRESS. In order to handle these calls, we treat
* SESSION_PROGRESS as OK. If an OK arrives later, we'll
* send an ACK. This flag allows us to enable or
* disable this workaround for each call.
*
* The problem with always treating SESSION_PROGRESS as OK
* is that in a conference everybody will hear the ringing sound
* which the remote call sends until the call is actually answered.
* This can be avoided if joinConfirmation is specified.
* The other problem is that if we treat SESSION_PROGRESS
* as though the call has been answered, then we'll start
* playing the treatment before a person really answers to
* hear the treatment.
*/
if (cp.getHandleSessionProgress() == false) {
Logger.writeFile("Call " + cp + " Ignoring SESSION_PROGRESS");
return;
}
Logger.writeFile("Call " + cp + " Treating SESSION_PROGRESS as OK");
}
if (response.getRawContent() == null) {
Logger.error("Call " + cp + " no SDP in OK Response!");
cancelRequest("SIP error! no SDP in OK Response!");
return;
}
this.clientTransaction = clientTransaction;
if (statusCode == Response.OK) {
gotOk = true;
Logger.writeFile("Call " + cp + " Got OK, call answered\n" + response);
}
ToHeader toHeader = (ToHeader) response.getHeader(ToHeader.NAME);
/*
* We got an OK response.
*
* send an ACK back to the CallParticipant
*/
if (statusCode == Response.OK) {
sipUtil.sendAck(clientTransaction);
ackSent = true;
}
if (callAnswered) {
Logger.writeFile("Call " + cp + " done processing OK");
return;
}
/*
* Remember the IP and port of where to send data to
* the CallParticipant.
*/
sdpBody = new String(response.getRawContent());
SdpInfo sdpInfo;
try {
sdpInfo = sipUtil.getSdpInfo(sdpBody, false);
} catch (ParseException e) {
Logger.error("Call " + cp + " Invalid SDP in OK Response! " + e.getMessage());
cancelRequest("SIP error! Invalid SDP in OK Response!");
return;
}
MediaInfo mediaInfo = sdpInfo.getMediaInfo();
InetSocketAddress isa =
new InetSocketAddress(sdpInfo.getRemoteHost(), sdpInfo.getRemotePort());
InetSocketAddress rtcpAddress = sdpInfo.getRtcpAddress();
setEndpointAddress(
isa,
mediaInfo.getPayload(),
sdpInfo.getTransmitMediaInfo().getPayload(),
sdpInfo.getTelephoneEventPayload(),
rtcpAddress);
/*
* The CallParticipant has answered.
* If join confirmation is required, we remain in the
* INVITED state. We set the callAnswered flag so that
* if the join confirmation times out we know to
* send a BYE rather than a CANCEL.
*/
callAnswered = true;
if (cp.getJoinConfirmationTimeout() == 0) {
setState(CallState.ANSWERED);
}
/*
* Start treatment if any and wait for it to finish.
* When the treatment finishes, notification will
* be delivered to our parent which will indicate
* we're ready for the conference.
*
* If there's no treatment to be played, we're ready now
* unless we're waiting for join confirmation..
*/
initializeCallAnsweredTreatment();
if (callAnsweredTreatment != null) {
startCallAnsweredTreatment();
} else {
if (cp.getJoinConfirmationTimeout() == 0) {
setState(CallState.ESTABLISHED);
}
}
} else {
Logger.writeFile("Call " + cp + " Ignoring response: " + response.getReasonPhrase());
if (Logger.logLevel >= Logger.LOG_SIP) {
Logger.println("Call " + cp + " Response: " + response);
}
}
}
public synchronized void processResponse(ResponseEvent responseReceivedEvent) {
try {
Response response = (Response) responseReceivedEvent.getResponse();
ClientTransaction clientTransaction = responseReceivedEvent.getClientTransaction();
int statusCode = response.getStatusCode();
FromHeader fromHeader = (FromHeader) response.getHeader(FromHeader.NAME);
String displayName = fromHeader.getAddress().getDisplayName();
if (Logger.logLevel >= Logger.LOG_SIP) {
Logger.println(
"Response: statusCode "
+ statusCode
+ " state "
+ getCallState()
+ " fromHeader "
+ displayName
+ " call participant "
+ cp.getName());
}
if (reasonCallTerminated != null) {
/*
* Ignore OK and Request Terminated.
* XXX what's the symbol for 487?
*/
if (statusCode != Response.OK && statusCode != 487) {
if (Logger.logLevel >= Logger.LOG_SIP) {
Logger.println("Call " + cp + ": request cancelled, ignoring response");
}
}
CallIdHeader callIdHeader = (CallIdHeader) response.getHeader("Call-Id");
String sipCallId = callIdHeader.getCallId();
sipServerCallback.removeSipListener(sipCallId);
return;
}
/*
* Some type of global failure that prevents the
* CallParticipant from being contacted, report failure.
*/
if (forceGatewayError) {
statusCode = 500;
forceGatewayError = false;
}
if (statusCode >= 500 && getState() == CallState.INVITED) {
Logger.error(
"Call " + cp + " gateway error: " + statusCode + " " + response.getReasonPhrase());
cancelRequest("gateway error: " + statusCode + " " + response.getReasonPhrase());
return;
} else if (statusCode == Response.PROXY_AUTHENTICATION_REQUIRED
|| statusCode == Response.UNAUTHORIZED) {
if (cp.getProxyCredentials() != null) {
try {
SipServer.handleChallenge(response, clientTransaction, cp.getProxyCredentials())
.sendRequest();
} catch (Exception e) {
Logger.println("Proxy authentification failed " + e);
}
}
return;
} else if (statusCode >= 400) {
// if we get a busy or an unknown error, play busy.
Logger.println("Call " + cp + " got status code :" + statusCode);
cp.setCallEndTreatment(null);
cp.setConferenceJoinTreatment(null);
cp.setConferenceLeaveTreatment(null);
/*
* play busy treatment, but deallocate any resources
* held up by ringBack first, if any.
*/
// stopCallAnsweredTreatment();
if (statusCode == Response.BUSY_HERE) {
try {
if (busyTreatment != null) {
addTreatment(busyTreatment);
// busyTreatment.waitForTreatment();
} else {
Logger.println("Unable to play busy treatment!!!");
}
} catch (Exception e) {
Logger.error("can't start busy treatment!" + sdpBody);
}
CallEvent callEvent = new CallEvent(CallEvent.BUSY_HERE);
callEvent.setInfo(response.getReasonPhrase());
sendCallEventNotification(callEvent);
}
// sipUtil.sendBye(clientTransaction);
cancelRequest(response.getReasonPhrase());
return;
}
/* state machine */
switch (getState()) {
/*
* CallParticipant picked up, send treatment if any,
* and wait for it to finish.
*/
case CallState.INVITED:
if (rejectCall) {
Logger.error(
"Call " + cp + " gateway error: " + statusCode + " " + response.getReasonPhrase());
cancelRequest("gateway error: " + statusCode + " " + response.getReasonPhrase());
return;
}
handleCallParticipantInvited(response, clientTransaction);
break;
/*
* Call established, the ACK needs to be resent.
* According to Ranga, this is done by the NIST SIP Stack.
*/
case CallState.ESTABLISHED:
if (statusCode == Response.OK) {
gotOk = true;
Logger.writeFile("Call " + cp + " Got OK, ESTABLISHED");
if (ackSent == false) {
sipUtil.sendAck(clientTransaction);
ackSent = true;
}
}
break;
case CallState.ENDED:
break; // ignore the response
default:
Logger.error("Process Response bad state " + getState() + "\n" + response);
}
} catch (SipException e) {
Logger.exception("Call " + cp + " SIP Stack error ", e);
cancelRequest("processResponse: SIP Stack error " + e.getMessage());
} catch (Exception e) {
Logger.exception("processResponse: " + cp, e);
cancelRequest("processResponse: SIP Stack error " + e.getMessage());
}
}
private void register() throws IOException {
Log.info("Registering with " + registrar);
FromHeader fromHeader = getFromHeader();
Address fromAddress = fromHeader.getAddress();
// Request URI
SipURI requestURI = null;
try {
requestURI = addressFactory.createSipURI(null, registrar);
} catch (ParseException e) {
throw new IOException("Bad registrar address:" + registrar + " " + e.getMessage());
}
// requestURI.setPort(registrarPort);
try {
requestURI.setTransportParam(sipProvider.getListeningPoint().getTransport());
} catch (ParseException e) {
throw new IOException(
sipProvider.getListeningPoint().getTransport()
+ " is not a valid transport! "
+ e.getMessage());
}
CallIdHeader callIdHeader = sipProvider.getNewCallId();
CSeqHeader cSeqHeader = null;
try {
cSeqHeader = headerFactory.createCSeqHeader(1, Request.REGISTER);
} catch (ParseException e) {
// Should never happen
throw new IOException("Corrupt Sip Stack " + e.getMessage());
} catch (InvalidArgumentException e) {
// Should never happen
throw new IOException("The application is corrupt ");
}
ToHeader toHeader = null;
try {
String proxyWorkAround = System.getProperty("com.sun.mc.softphone.REGISTRAR_WORKAROUND");
if (proxyWorkAround != null && proxyWorkAround.toUpperCase().equals("TRUE")) {
SipURI toURI = (SipURI) (requestURI.clone());
toURI.setUser(System.getProperty("user.name"));
toHeader = headerFactory.createToHeader(addressFactory.createAddress(toURI), null);
} else {
toHeader = headerFactory.createToHeader(fromAddress, null);
}
} catch (ParseException e) {
throw new IOException(
"Could not create a To header for address:"
+ fromHeader.getAddress()
+ " "
+ e.getMessage());
}
ArrayList viaHeaders = getLocalViaHeaders();
MaxForwardsHeader maxForwardsHeader = getMaxForwardsHeader();
Request request = null;
try {
request =
messageFactory.createRequest(
requestURI,
Request.REGISTER,
callIdHeader,
cSeqHeader,
fromHeader,
toHeader,
viaHeaders,
maxForwardsHeader);
} catch (ParseException e) {
throw new IOException("Could not create the register request! " + e.getMessage());
}
ExpiresHeader expHeader = null;
for (int retry = 0; retry < 2; retry++) {
try {
expHeader = headerFactory.createExpiresHeader(expires);
} catch (InvalidArgumentException e) {
if (retry == 0) {
continue;
}
throw new IOException(
"Invalid registrations expiration parameter - " + expires + " " + e.getMessage());
}
}
request.addHeader(expHeader);
ContactHeader contactHeader = getRegistrationContactHeader();
request.addHeader(contactHeader);
try {
SipURI routeURI =
(SipURI) addressFactory.createURI("sip:" + proxyCredentials.getProxy() + ";lr");
RouteHeader routeHeader =
headerFactory.createRouteHeader(addressFactory.createAddress(routeURI));
request.addHeader(routeHeader);
} catch (Exception e) {
Log.error("Creating registration route error ", e);
}
ClientTransaction regTrans = null;
try {
regTrans = sipProvider.getNewClientTransaction(request);
} catch (TransactionUnavailableException e) {
throw new IOException(
"Could not create a register transaction!\n"
+ "Check that the Registrar address is correct! "
+ e.getMessage());
}
try {
sipCallId = callIdHeader.getCallId();
sipServerCallback.addSipListener(sipCallId, this);
registerRequest = request;
regTrans.sendRequest();
Log.debug("Sent register request " + registerRequest);
if (expires > 0) {
scheduleReRegistration();
}
} catch (Exception e) {
throw new IOException("Could not send out the register request! " + e.getMessage());
}
this.registerRequest = request;
}
public void joinConference() {
log.info("joinConference()");
try {
String fromName = "notetaker";
String fromSipAddress = "jmik.org";
String fromDisplayName = "Conference Note Taker";
String toSipAddress = peerIP;
String toUser = roomId;
String toDisplayName = roomId;
// create >From Header
SipURI fromAddress = addressFactory.createSipURI(fromName, fromSipAddress);
Address fromNameAddress = addressFactory.createAddress(fromAddress);
fromNameAddress.setDisplayName(fromDisplayName);
FromHeader fromHeader = headerFactory.createFromHeader(fromNameAddress, "12345");
// create To Header
SipURI toAddress = addressFactory.createSipURI(toUser, toSipAddress);
Address toNameAddress = addressFactory.createAddress(toAddress);
toNameAddress.setDisplayName(toDisplayName);
ToHeader toHeader = headerFactory.createToHeader(toNameAddress, null);
// create Request URI
SipURI requestURI = addressFactory.createSipURI(toUser, peerIP + ":" + peerPort);
// Create ViaHeaders
ArrayList<ViaHeader> viaHeaders = new ArrayList<ViaHeader>();
ViaHeader viaHeader = headerFactory.createViaHeader(myIP, myPort, "udp", null);
viaHeaders.add(viaHeader);
// Create ContentTypeHeader
ContentTypeHeader contentTypeHeader =
headerFactory.createContentTypeHeader("application", "sdp");
// Create a new CallId header
CallIdHeader callIdHeader = sipProvider.getNewCallId();
callId = callIdHeader.getCallId();
// Create a new Cseq header
CSeqHeader cSeqHeader = headerFactory.createCSeqHeader(1, Request.INVITE);
// Create a new MaxForwardsHeader
MaxForwardsHeader maxForwards = headerFactory.createMaxForwardsHeader(70);
// Create the request.
Request request =
messageFactory.createRequest(
requestURI,
Request.INVITE,
callIdHeader,
cSeqHeader,
fromHeader,
toHeader,
viaHeaders,
maxForwards);
// Create contact headers
String contactHost = sipStack.getIPAddress();
SipURI contactUrl = addressFactory.createSipURI(fromName, contactHost);
contactUrl.setPort(myPort);
// Create the contact name address.
SipURI contactURI = addressFactory.createSipURI(fromName, myIP);
contactURI.setPort(myPort);
Address contactAddress = addressFactory.createAddress(contactURI);
// Add the contact address.
contactAddress.setDisplayName(fromName);
ContactHeader contactHeader = headerFactory.createContactHeader(contactAddress);
request.addHeader(contactHeader);
String sdpData =
"v=0\r\n"
+ "o=username 0 0"
+ "IN IP4 "
+ myIP
+ "\r\n"
+ "s=The Funky Flow\r\n"
+ "c=IN IP4 "
+ myIP
+ "\r\n"
+ "t=0 0\r\n"
+ "m=audio 0 RTP/AVP 0 97 8 3\r\n"
+ "a=rtpmap:0 PCMU/8000\r\n"
+ "a=rtpmap:3 GSM/8000\r\n"
+ "a=rtpmap:8 PCMA/8000\r\n"
+ "a=rtpmap:97 iLBC/8000\r\n"
+ "a=fmtp:97 mode=30\r\n";
request.setContent(sdpData, contentTypeHeader);
if (logger.isDebugEnabled()) logger.debug("request\n:" + request + "\n");
// Create the client transaction.
ClientTransaction inviteTid = sipProvider.getNewClientTransaction(request);
// send the request out.
inviteTid.sendRequest();
log.info("joinConference invite sent");
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
* Implements {@link MethodProcessor#processResponse(ResponseEvent)}. Handles only responses to
* SUBSCRIBE requests because they are the only requests concerning event package subscribers (and
* the only requests sent by them, for that matter) and if the processing of a given response
* requires event package-specific handling, delivers the response to the matching
* <tt>Subscription</tt> instance. Examples of such event package-specific handling include
* letting the respective <tt>Subscription</tt> handle the success or failure in the establishment
* of a subscription.
*
* @param responseEvent a <tt>ResponseEvent</tt> specifying the SIP <tt>Response</tt> to be
* processed
* @return <tt>true</tt> if the SIP <tt>Response</tt> specified by <tt>responseEvent</tt> was
* processed; otherwise, <tt>false</tt>
*/
@Override
public boolean processResponse(ResponseEvent responseEvent) {
Response response = responseEvent.getResponse();
CSeqHeader cseqHeader = (CSeqHeader) response.getHeader(CSeqHeader.NAME);
if (cseqHeader == null) {
logger.error("An incoming response did not contain a CSeq header");
return false;
}
if (!Request.SUBSCRIBE.equals(cseqHeader.getMethod())) return false;
ClientTransaction clientTransaction = responseEvent.getClientTransaction();
Request request = clientTransaction.getRequest();
/*
* Don't handle responses to requests not coming from this event
* package.
*/
if (request != null) {
EventHeader eventHeader = (EventHeader) request.getHeader(EventHeader.NAME);
if ((eventHeader == null) || !eventPackage.equalsIgnoreCase(eventHeader.getEventType()))
return false;
}
// Find the subscription.
CallIdHeader callIdHeader = (CallIdHeader) response.getHeader(CallIdHeader.NAME);
String callId = callIdHeader.getCallId();
Subscription subscription = getSubscription(callId);
// if it's the response to an unsubscribe message, we just ignore it
// whatever the response is however if we need to handle a
// challenge, we do it
ExpiresHeader expHeader = response.getExpires();
int statusCode = response.getStatusCode();
SipProvider sourceProvider = (SipProvider) responseEvent.getSource();
if (((expHeader != null) && (expHeader.getExpires() == 0))
|| (subscription == null)) // this handle the unsubscription
// case where we removed the contact
// from subscribedContacts
{
boolean processed = false;
if ((statusCode == Response.UNAUTHORIZED)
|| (statusCode == Response.PROXY_AUTHENTICATION_REQUIRED)) {
try {
processAuthenticationChallenge(clientTransaction, response, sourceProvider);
processed = true;
} catch (OperationFailedException e) {
logger.error("can't handle the challenge", e);
}
} else if ((statusCode != Response.OK) && (statusCode != Response.ACCEPTED)) processed = true;
// any other cases (200/202) will imply a NOTIFY, so we will
// handle the end of a subscription there
return processed;
}
if ((statusCode >= Response.OK) && (statusCode < Response.MULTIPLE_CHOICES)) {
// OK (200/202)
if ((statusCode == Response.OK) || (statusCode == Response.ACCEPTED)) {
if (expHeader == null) {
// not conform to rfc3265
logger.error("no Expires header in this response");
return false;
}
SubscriptionRefreshTask refreshTask = new SubscriptionRefreshTask(subscription);
subscription.setTimerTask(refreshTask);
int refreshDelay = expHeader.getExpires();
// try to keep a margin if the refresh delay allows it
if (refreshDelay >= (2 * refreshMargin)) refreshDelay -= refreshMargin;
timer.schedule(refreshTask, refreshDelay * 1000);
// do it to remember the dialog in case of a polling
// subscription (which means no call to finalizeSubscription)
subscription.setDialog(clientTransaction.getDialog());
subscription.processSuccessResponse(responseEvent, statusCode);
}
} else if ((statusCode >= Response.MULTIPLE_CHOICES) && (statusCode < Response.BAD_REQUEST)) {
if (logger.isInfoEnabled())
logger.info(
"Response to subscribe to "
+ subscription.getAddress()
+ ": "
+ response.getReasonPhrase());
} else if (statusCode >= Response.BAD_REQUEST) {
// if the response is a 423 response, just re-send the request
// with a valid expires value
if (statusCode == Response.INTERVAL_TOO_BRIEF) {
MinExpiresHeader min = (MinExpiresHeader) response.getHeader(MinExpiresHeader.NAME);
if (min == null) {
logger.error("no minimal expires value in this 423 " + "response");
return false;
}
ExpiresHeader exp = request.getExpires();
try {
exp.setExpires(min.getExpires());
} catch (InvalidArgumentException e) {
logger.error("can't set the new expires value", e);
return false;
}
ClientTransaction transac = null;
try {
transac = protocolProvider.getDefaultJainSipProvider().getNewClientTransaction(request);
} catch (TransactionUnavailableException e) {
logger.error("can't create the client transaction", e);
return false;
}
try {
transac.sendRequest();
} catch (SipException e) {
logger.error("can't send the new request", e);
return false;
}
return true;
// UNAUTHORIZED (401/407)
} else if ((statusCode == Response.UNAUTHORIZED)
|| (statusCode == Response.PROXY_AUTHENTICATION_REQUIRED)) {
try {
processAuthenticationChallenge(clientTransaction, response, sourceProvider);
} catch (OperationFailedException e) {
logger.error("can't handle the challenge", e);
removeSubscription(callId, subscription);
subscription.processFailureResponse(responseEvent, statusCode);
}
// 408 480 486 600 603 : non definitive reject
// others: definitive reject (or not implemented)
} else {
if (logger.isDebugEnabled()) logger.debug("error received from the network:\n" + response);
removeSubscription(callId, subscription);
subscription.processFailureResponse(responseEvent, statusCode);
}
}
return true;
}
/**
* Implements {@link MethodProcessor#processRequest(RequestEvent)}. Handles only NOTIFY requests
* because they are the only requests concerning event package subscribers and if the processing
* of a given request requires event package-specific handling, delivers the request to the
* matching Subscription instance. Examples of such event package-specific handling include
* handling the termination of an existing Subscription and processing the bodies of the NOTIFY
* requests for active Subscriptions.
*
* @param requestEvent a <tt>RequestEvent</tt> specifying the SIP <tt>Request</tt> to be processed
* @return <tt>true</tt> if the SIP <tt>Request</tt> specified by <tt>requestEvent</tt> was
* processed; otherwise, <tt>false</tt>
*/
@Override
public boolean processRequest(RequestEvent requestEvent) {
Request request = requestEvent.getRequest();
EventHeader eventHeader = (EventHeader) request.getHeader(EventHeader.NAME);
if ((eventHeader == null) || !eventPackage.equalsIgnoreCase(eventHeader.getEventType())) {
/*
* We are not concerned by this request, perhaps another listener
* is. So don't send a 489 / Bad event answer here.
*/
return false;
}
if (!Request.NOTIFY.equals(request.getMethod())) return false;
if (logger.isDebugEnabled()) logger.debug("notify received");
SubscriptionStateHeader sstateHeader =
(SubscriptionStateHeader) request.getHeader(SubscriptionStateHeader.NAME);
// notify must contain one (rfc3265)
if (sstateHeader == null) {
logger.error("no subscription state in this request");
return false;
}
String sstate = sstateHeader.getState();
ServerTransaction serverTransaction = getOrCreateServerTransaction(requestEvent);
// first handle the case of a contact still pending
// it's possible if the NOTIFY arrives before the OK
CallIdHeader callIdHeader = (CallIdHeader) request.getHeader(CallIdHeader.NAME);
String callId = callIdHeader.getCallId();
Subscription subscription = getSubscription(callId);
// see if the notify correspond to an existing subscription
if ((subscription == null) && !SubscriptionStateHeader.TERMINATED.equalsIgnoreCase(sstate)) {
if (logger.isDebugEnabled()) logger.debug("subscription not found for callId " + callId);
// send a 481 response (rfc3625)
Response response;
try {
response =
protocolProvider
.getMessageFactory()
.createResponse(Response.CALL_OR_TRANSACTION_DOES_NOT_EXIST, request);
} catch (ParseException e) {
logger.error("failed to create the 481 response", e);
return false;
}
try {
serverTransaction.sendResponse(response);
} catch (SipException e) {
logger.error("failed to send the response", e);
} catch (InvalidArgumentException e) {
// should not happen
logger.error("invalid argument provided while trying to send the response", e);
}
return true;
}
// if we don't understand the content
ContentTypeHeader ctheader = (ContentTypeHeader) request.getHeader(ContentTypeHeader.NAME);
if ((ctheader != null) && !ctheader.getContentSubType().equalsIgnoreCase(contentSubType)) {
// send a 415 response (rfc3261)
Response response;
try {
response =
protocolProvider
.getMessageFactory()
.createResponse(Response.UNSUPPORTED_MEDIA_TYPE, request);
} catch (ParseException e) {
logger.error("failed to create the OK response", e);
return false;
}
// we want PIDF
AcceptHeader acceptHeader;
try {
acceptHeader =
protocolProvider.getHeaderFactory().createAcceptHeader("application", contentSubType);
} catch (ParseException e) {
// should not happen
logger.error("failed to create the accept header", e);
return false;
}
response.setHeader(acceptHeader);
try {
serverTransaction.sendResponse(response);
} catch (SipException e) {
logger.error("failed to send the response", e);
} catch (InvalidArgumentException e) {
// should not happen
logger.error("invalid argument provided while trying" + " to send the response", e);
}
}
// if the presentity doesn't want of us anymore
if (SubscriptionStateHeader.TERMINATED.equalsIgnoreCase(sstate)) {
// if we requested this end of subscription, subscription == null
if (subscription != null) {
removeSubscription(callId, subscription);
subscription.processTerminatedRequest(requestEvent, sstateHeader.getReasonCode());
}
}
// send an OK response
Response response;
try {
response = protocolProvider.getMessageFactory().createResponse(Response.OK, request);
} catch (ParseException e) {
logger.error("failed to create the OK response", e);
return false;
}
try {
serverTransaction.sendResponse(response);
} catch (SipException e) {
logger.error("failed to send the response", e);
} catch (InvalidArgumentException e) {
// should not happen
logger.error("invalid argument provided while trying to send the response", e);
}
// transform the presence document in new presence status
if (subscription != null)
subscription.processActiveRequest(requestEvent, request.getRawContent());
return true;
}