/**
* Creates an ACK for non-2xx responses according to RFC3261 17.1.1.3
*
* @return A SIPRequest with an ACK method.
* @throws SipException
* @throws NullPointerException
* @throws ParseException
* @author jvb
*/
public final SIPRequest createErrorAck(To responseToHeader) throws SipException, ParseException {
/*
* The ACK request constructed by the client transaction MUST contain values for the
* Call-ID, From, and Request-URI that are equal to the values of those header fields in
* the request passed to the transport by the client transaction (call this the "original
* request"). The To header field in the ACK MUST equal the To header field in the
* response being acknowledged, and therefore will usually differ from the To header field
* in the original request by the addition of the tag parameter. The ACK MUST contain a
* single Via header field, and this MUST be equal to the top Via header field of the
* original request. The CSeq header field in the ACK MUST contain the same value for the
* sequence number as was present in the original request, but the method parameter MUST
* be equal to "ACK".
*/
SIPRequest newRequest = new SIPRequest();
newRequest.setRequestLine((RequestLine) this.requestLine.clone());
newRequest.setMethod(Request.ACK);
newRequest.setHeader((Header) this.callIdHeader.clone());
newRequest.setHeader((Header) this.maxForwardsHeader.clone()); // ISSUE
// 130
// fix
newRequest.setHeader((Header) this.fromHeader.clone());
newRequest.setHeader((Header) responseToHeader.clone());
newRequest.addFirst((Header) this.getTopmostVia().clone());
newRequest.setHeader((Header) cSeqHeader.clone());
newRequest.getCSeq().setMethod(Request.ACK);
/*
* If the INVITE request whose response is being acknowledged had Route header fields,
* those header fields MUST appear in the ACK. This is to ensure that the ACK can be
* routed properly through any downstream stateless proxies.
*/
if (this.getRouteHeaders() != null) {
newRequest.setHeader((SIPHeaderList) this.getRouteHeaders().clone());
}
if (MessageFactoryImpl.getDefaultUserAgentHeader() != null) {
newRequest.setHeader(MessageFactoryImpl.getDefaultUserAgentHeader());
}
return newRequest;
}
/**
* Create a new default SIPRequest from the original request. Warning: the newly created
* SIPRequest, shares the headers of this request but we generate any new headers that we need to
* modify so the original request is umodified. However, if you modify the shared headers after
* this request is created, then the newly created request will also be modified. If you want to
* modify the original request without affecting the returned Request make sure you clone it
* before calling this method.
*
* <p>Only required headers are copied.
*
* <ul>
* <li>Contact headers are not included in the newly created request. Setting the appropriate
* sequence number is the responsibility of the caller.
* <li>RouteList is not copied for ACK and CANCEL
* <li>Note that we DO NOT copy the body of the argument into the returned header. We do not
* copy the content type header from the original request either. These have to be added
* seperately and the content length has to be correctly set if necessary the content length
* is set to 0 in the returned header.
* <li>Contact List is not copied from the original request.
* <li>RecordRoute List is not included from original request.
* <li>Via header is not included from the original request.
* </ul>
*
* @param requestLine is the new request line.
* @param switchHeaders is a boolean flag that causes to and from headers to switch (set this to
* true if you are the server of the transaction and are generating a BYE request). If the
* headers are switched, we generate new From and To headers otherwise we just use the
* incoming headers.
* @return a new Default SIP Request which has the requestLine specified.
*/
public SIPRequest createSIPRequest(RequestLine requestLine, boolean switchHeaders) {
SIPRequest newRequest = new SIPRequest();
newRequest.requestLine = requestLine;
Iterator headerIterator = this.getHeaders();
while (headerIterator.hasNext()) {
SIPHeader nextHeader = (SIPHeader) headerIterator.next();
// For BYE and cancel set the CSeq header to the
// appropriate method.
if (nextHeader instanceof CSeq) {
CSeq newCseq = (CSeq) nextHeader.clone();
nextHeader = newCseq;
try {
newCseq.setMethod(requestLine.getMethod());
} catch (ParseException e) {
}
} else if (nextHeader instanceof ViaList) {
Via via = (Via) (((ViaList) nextHeader).getFirst().clone());
via.removeParameter("branch");
nextHeader = via;
// Cancel and ACK preserve the branch ID.
} else if (nextHeader instanceof To) {
To to = (To) nextHeader;
if (switchHeaders) {
nextHeader = new From(to);
((From) nextHeader).removeTag();
} else {
nextHeader = (SIPHeader) to.clone();
((To) nextHeader).removeTag();
}
} else if (nextHeader instanceof From) {
From from = (From) nextHeader;
if (switchHeaders) {
nextHeader = new To(from);
((To) nextHeader).removeTag();
} else {
nextHeader = (SIPHeader) from.clone();
((From) nextHeader).removeTag();
}
} else if (nextHeader instanceof ContentLength) {
ContentLength cl = (ContentLength) nextHeader.clone();
try {
cl.setContentLength(0);
} catch (InvalidArgumentException e) {
}
nextHeader = cl;
} else if (!(nextHeader instanceof CallID) && !(nextHeader instanceof MaxForwards)) {
// Route is kept by dialog.
// RR is added by the caller.
// Contact is added by the Caller
// Any extension headers must be added
// by the caller.
continue;
}
try {
newRequest.attachHeader(nextHeader, false);
} catch (SIPDuplicateHeaderException e) {
e.printStackTrace();
}
}
if (MessageFactoryImpl.getDefaultUserAgentHeader() != null) {
newRequest.setHeader(MessageFactoryImpl.getDefaultUserAgentHeader());
}
return newRequest;
}