");
}
sprint("}");
}
} catch (IllegalAccessException ex1) {
continue; // we are accessing a private field...
}
}
sprint("}");
return stringRepresentation;
}
/**
* Formatter with a given starting indentation (for nested structs).
* @param indent int to set
* @return String
*/
public String debugDump(int indent) {
int save = indentation;
indentation = indent;
String retval = this.debugDump();
indentation = save;
return retval;
}
/** Encode this to a string.
*
*@return string representation for this object.
*/
public String toString() {
return this.encode();
}
}
java/gov/nist/javax/sip/address/NetObjectList.java 0100644 0000000 0000000 00000007661 13513104763 021220 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.address;
import gov.nist.core.*;
import java.util.ListIterator;
import java.util.LinkedList;
import java.util.Iterator;
import java.lang.reflect.*;
/**
* Root class for all the collection objects in this list:
* a wrapper class on the GenericObjectList class for lists of objects
* that can appear in NetObjects.
* IMPORTANT NOTE: NetObjectList cannot derive from NetObject as this
* will screw up the way in which we attach objects to headers.
*
*@version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:22 $
*
*@author M. Ranganathan
*
*
*
*/
public class NetObjectList extends GenericObjectList {
/**
*
*/
private static final long serialVersionUID = -1551780600806959023L;
/**
* Construct a NetObject List given a list name.
* @param lname String to set
*/
public NetObjectList(String lname) {
super(lname);
}
/**
* Construct a NetObject List given a list name and a class for
* the objects that go into the list.
* @param lname String to set
* @param cname Class to set
*/
public NetObjectList(String lname, Class cname) {
super(lname, cname);
}
/**
* Construct an empty NetObjectList.
*/
public NetObjectList() {
super();
}
/**
* Add a new object to the list.
* @param obj NetObject to set
*/
public void add(NetObject obj) {
super.add(obj);
}
/** concatenate the two Lists
* @param net_obj_list NetObjectList to set
*/
public void concatenate(NetObjectList net_obj_list) {
super.concatenate(net_obj_list);
}
/** returns the first element
* @return GenericObject
*/
public GenericObject first() {
return (NetObject) super.first();
}
/** returns the next element
* @return GenericObject
*/
public GenericObject next() {
return (NetObject) super.next();
}
/** returns the next element
* @param li ListIterator to set
* @return GenericObject
*/
public GenericObject next(ListIterator li) {
return (NetObject) super.next(li);
}
/** set the class
* @param cl Class to set
*/
public void setMyClass(Class cl) {
super.setMyClass(cl);
}
/**
* Convert to a string given an indentation(for pretty printing).
* @param indent int to set
* @return String
*/
public String debugDump(int indent) {
return super.debugDump(indent);
}
/**
* Encode this to a string.
*
*@return a string representation for this object.
*/
public String toString() {
return this.encode();
}
}
java/gov/nist/javax/sip/address/ParameterNames.java 0100644 0000000 0000000 00000010736 13513104763 021410 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.address;
/**
* Common parameter names.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:22 $
*
* @author M. Ranganathan
*
*
*/
public interface ParameterNames {
public static final String SIP_URI_SCHEME = "sip";
public static final String SIPS_URI_SCHEME = "sips";
public static final String TEL_URI_SCHEME = "tel";
public static final String POSTDIAL = "postdial";
public static final String PHONE_CONTEXT_TAG = "context-tag";
public static final String ISUB = "isub";
public static final String PROVIDER_TAG = "provider-tag";
public static final String UDP = GenericURI.UDP;
public static final String TCP = GenericURI.TCP;
public static final String TLS = GenericURI.TLS;
}
/*
* $Log: ParameterNames.java,v $
* Revision 1.6 2009/07/17 18:57:22 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.5 2006/07/13 09:02:30 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:29 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:34 mranga
*
* Import
*
*
* Revision 1.3 2004/10/28 19:02:49 mranga
* Submitted by: Daniel Martinez
* Reviewed by: M. Ranganathan
*
* Added changes for TLS support contributed by Daniel Martinez
*
* Revision 1.2 2004/01/22 13:26:28 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/address/RFC2396UrlDecoder.java 0100644 0000000 0000000 00000010231 13513104763 021401 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.address;
import java.io.UnsupportedEncodingException;
/**
* Copied from Apache Excalibur project.
* Source code available at http://www.google.com/codesearch?hl=en&q=+excalibur+decodePath+show:sK_gDY0W5Rw:OTjCHAiSuF0:th3BdHtpX20&sa=N&cd=1&ct=rc&cs_p=http://apache.edgescape.com/excalibur/excalibur-sourceresolve/source/excalibur-sourceresolve-1.1-src.zip&cs_f=excalibur-sourceresolve-1.1/src/java/org/apache/excalibur/source/SourceUtil.java
* @author Jean Deruelle
*
*/
public class RFC2396UrlDecoder {
/**
* Decode a path.
*
* Interprets %XX (where XX is hexadecimal number) as UTF-8 encoded bytes.
*
The validity of the input path is not checked (i.e. characters that
* were not encoded will not be reported as errors).
*
This method differs from URLDecoder.decode in that it always uses UTF-8
* (while URLDecoder uses the platform default encoding, often ISO-8859-1),
* and doesn't translate + characters to spaces.
*
* @param uri the path to decode
* @return the decoded path
*/
public static String decode(String uri) {
StringBuffer translatedUri = new StringBuffer(uri.length());
byte[] encodedchars = new byte[uri.length() / 3];
int i = 0;
int length = uri.length();
int encodedcharsLength = 0;
while (i < length) {
if (uri.charAt(i) == '%') {
//we must process all consecutive %-encoded characters in one go, because they represent
//an UTF-8 encoded string, and in UTF-8 one character can be encoded as multiple bytes
while (i < length && uri.charAt(i) == '%') {
if (i + 2 < length) {
try {
byte x = (byte)Integer.parseInt(uri.substring(i + 1, i + 3), 16);
encodedchars[encodedcharsLength] = x;
} catch (NumberFormatException e) {
throw new IllegalArgumentException("Illegal hex characters in pattern %" + uri.substring(i + 1, i + 3));
}
encodedcharsLength++;
i += 3;
} else {
throw new IllegalArgumentException("% character should be followed by 2 hexadecimal characters.");
}
}
try {
String translatedPart = new String(encodedchars, 0, encodedcharsLength, "UTF-8");
translatedUri.append(translatedPart);
} catch (UnsupportedEncodingException e) {
//the situation that UTF-8 is not supported is quite theoretical, so throw a runtime exception
throw new RuntimeException("Problem in decodePath: UTF-8 encoding not supported.");
}
encodedcharsLength = 0;
} else {
//a normal character
translatedUri.append(uri.charAt(i));
i++;
}
}
return translatedUri.toString();
}
} java/gov/nist/javax/sip/address/RouterExt.java 0100644 0000000 0000000 00000002526 13513104763 020443 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
*
*/
package gov.nist.javax.sip.address;
import javax.sip.address.Hop;
import javax.sip.address.Router;
/**
*
*/
public interface RouterExt extends Router {
/**
* Record that a transaction failure occured for the given hop.
*
*/
public void transactionTimeout(Hop hop);
}
java/gov/nist/javax/sip/address/SipURIExt.java 0100644 0000000 0000000 00000001574 13513104763 020300 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.address;
import javax.sip.address.SipURI;
/**
* URI Interface extensions that will be added to version 2.0 of the JSR 32 spec.
*
* @author mranga
*
* @since 2.0
*
*/
public interface SipURIExt extends SipURI {
/**
* Strip the headers that are tacked to the URI.
*
* @since 2.0
*/
public void removeHeaders();
/**
* Strip a specific header tacked to the URI.
*
* @param headerName -- the name of the header.
*
* @since 2.0
*/
public void removeHeader(String headerName);
/**
* Returns whether the gr parameter is set.
*
* @since 2.0
*/
public boolean hasGrParam();
/**
* Sets the gr parameter.
*
* @param value -- the GRUU param value.
*
* @since 2.0
*/
public void setGrParam(String value);
}
java/gov/nist/javax/sip/address/SipUri.java 0100644 0000000 0000000 00000102122 13513104763 017706 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.address;
/*
*Bug fix contributions
*Daniel J. Martinez Manzano
*Stefan Marx.
*pmusgrave@newheights.com (Additions for gruu and outbound drafts)
*Jeroen van Bemmel ( additions for SCTP transport )
*/
import gov.nist.core.*;
import java.util.*;
import java.text.ParseException;
import javax.sip.PeerUnavailableException;
import javax.sip.SipFactory;
import javax.sip.address.SipURI;
import javax.sip.header.Header;
import javax.sip.header.HeaderFactory;
/**
* Implementation of the SipURI interface.
*
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.22 $ $Date: 2009/11/15 19:50:45 $
*
*
*
*/
public class SipUri extends GenericURI implements javax.sip.address.SipURI , SipURIExt{
private static final long serialVersionUID = 7749781076218987044L;
/** Authority for the uri.
*/
protected Authority authority;
/** uriParms list
*/
protected NameValueList uriParms;
/** qheaders list
*/
protected NameValueList qheaders;
/** telephoneSubscriber field
*/
protected TelephoneNumber telephoneSubscriber;
public SipUri() {
this.scheme = SIP;
this.uriParms = new NameValueList();
this.qheaders = new NameValueList();
this.qheaders.setSeparator("&");
}
/** Constructor given the scheme.
* The scheme must be either Sip or Sips
*/
public void setScheme(String scheme) {
if (scheme.compareToIgnoreCase(SIP) != 0
&& scheme.compareToIgnoreCase(SIPS) != 0)
throw new IllegalArgumentException("bad scheme " + scheme);
this.scheme = scheme.toLowerCase();
}
/** Get the scheme.
*/
public String getScheme() {
return scheme;
}
/**
* clear all URI Parameters.
* @since v1.0
*/
public void clearUriParms() {
uriParms = new NameValueList();
}
/**
*Clear the password from the user part if it exists.
*/
public void clearPassword() {
if (this.authority != null) {
UserInfo userInfo = authority.getUserInfo();
if (userInfo != null)
userInfo.clearPassword();
}
}
/** Get the authority.
*/
public Authority getAuthority() {
return this.authority;
}
/**
* Clear all Qheaders.
*/
public void clearQheaders() {
qheaders = new NameValueList();
}
/**
* Compare two URIs and return true if they are equal.
* @param that the object to compare to.
* @return true if the object is equal to this object.
*
* JvB: Updated to define equality in terms of API methods, according to the rules
* in RFC3261 section 19.1.4
*
* Jean Deruelle: Updated to define equality of API methods, according to the rules
* in RFC3261 section 19.1.4 convert potential ie :
* %HEX HEX encoding parts of the URI before comparing them
* transport param added in comparison
* header equality enforced in comparison
*
*/
@SuppressWarnings("unchecked")
@Override
public boolean equals(Object that) {
// Shortcut for same object
if (that==this) return true;
if (that instanceof SipURI) {
final SipURI a = this;
final SipURI b = (SipURI) that;
// A SIP and SIPS URI are never equivalent
if ( a.isSecure() ^ b.isSecure() ) return false;
// For two URIs to be equal, the user, password, host, and port
// components must match; comparison of userinfo is case-sensitive
if (a.getUser()==null ^ b.getUser()==null) return false;
if (a.getUserPassword()==null ^ b.getUserPassword()==null) return false;
if (a.getUser()!=null && !RFC2396UrlDecoder.decode(a.getUser()).equals(RFC2396UrlDecoder.decode(b.getUser()))) return false;
if (a.getUserPassword()!=null && !RFC2396UrlDecoder.decode(a.getUserPassword()).equals(RFC2396UrlDecoder.decode(b.getUserPassword()))) return false;
if (a.getHost() == null ^ b.getHost() == null) return false;
if (a.getHost() != null && !a.getHost().equalsIgnoreCase(b.getHost())) return false;
if (a.getPort() != b.getPort()) return false;
// URI parameters
for (Iterator i = a.getParameterNames(); i.hasNext();) {
String pname = (String) i.next();
String p1 = a.getParameter(pname);
String p2 = b.getParameter(pname);
// those present in both must match (case-insensitive)
if (p1!=null && p2!=null && !RFC2396UrlDecoder.decode(p1).equalsIgnoreCase(RFC2396UrlDecoder.decode(p2))) return false;
}
// transport, user, ttl or method must match when present in either
if (a.getTransportParam()==null ^ b.getTransportParam()==null) return false;
if (a.getUserParam()==null ^ b.getUserParam()==null) return false;
if (a.getTTLParam()==-1 ^ b.getTTLParam()==-1) return false;
if (a.getMethodParam()==null ^ b.getMethodParam()==null) return false;
if (a.getMAddrParam()==null ^ b.getMAddrParam()==null) return false;
// Headers: must match according to their definition.
if(a.getHeaderNames().hasNext() && !b.getHeaderNames().hasNext()) return false;
if(!a.getHeaderNames().hasNext() && b.getHeaderNames().hasNext()) return false;
if(a.getHeaderNames().hasNext() && b.getHeaderNames().hasNext()) {
HeaderFactory headerFactory = null;
try {
headerFactory = SipFactory.getInstance().createHeaderFactory();
} catch (PeerUnavailableException e) {
Debug.logError("Cannot get the header factory to parse the header of the sip uris to compare", e);
return false;
}
for (Iterator i = a.getHeaderNames(); i.hasNext();) {
String hname = (String) i.next();
String h1 = a.getHeader(hname);
String h2 = b.getHeader(hname);
if(h1 == null && h2 != null) return false;
if(h2 == null && h1 != null) return false;
// The following check should not be needed but we add it for findbugs.
if(h1 == null && h2 == null) continue;
try {
Header header1 = headerFactory.createHeader(hname, RFC2396UrlDecoder.decode(h1));
Header header2 = headerFactory.createHeader(hname, RFC2396UrlDecoder.decode(h2));
// those present in both must match according to the equals method of the corresponding header
if (!header1.equals(header2)) return false;
} catch (ParseException e) {
Debug.logError("Cannot parse one of the header of the sip uris to compare " + a + " " + b, e);
return false;
}
}
}
// Finally, we can conclude that they are indeed equal
return true;
}
return false;
}
/**
* Construct a URL from the parsed structure.
* @return String
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
buffer.append(scheme).append(COLON);
if (authority != null)
authority.encode(buffer);
if (!uriParms.isEmpty()) {
buffer.append(SEMICOLON);
uriParms.encode(buffer);
}
if (!qheaders.isEmpty()) {
buffer.append(QUESTION);
qheaders.encode(buffer);
}
return buffer;
}
/** Return a string representation.
*
*@return the String representation of this URI.
*
*/
public String toString() {
return this.encode();
}
/**
* getUser@host
* @return user@host portion of the uri (null if none exists).
*
* Peter Musgrave - handle null user
*/
public String getUserAtHost() {
String user = "";
if (authority.getUserInfo() != null)
user = authority.getUserInfo().getUser();
String host = authority.getHost().encode();
StringBuffer s = null;
if (user.equals("")) {
s = new StringBuffer();
} else {
s = new StringBuffer(user).append(AT);
}
return s.append(host).toString();
}
/**
* getUser@host
* @return user@host portion of the uri (null if none exists).
*/
public String getUserAtHostPort() {
String user = "";
if (authority.getUserInfo() != null)
user = authority.getUserInfo().getUser();
String host = authority.getHost().encode();
int port = authority.getPort();
// If port not set assign the default.
StringBuffer s = null;
if (user.equals("")) {
s = new StringBuffer();
} else {
s = new StringBuffer(user).append(AT);
}
if (port != -1) {
return s.append(host).append(COLON).append(port).toString();
} else
return s.append(host).toString();
}
/**
* get the parameter (do a name lookup) and return null if none exists.
* @param parmname Name of the parameter to get.
* @return Parameter of the given name (null if none exists).
*/
public Object getParm(String parmname) {
Object obj = uriParms.getValue(parmname);
return obj;
}
/**
* Get the method parameter.
* @return Method parameter.
*/
public String getMethod() {
return (String) getParm(METHOD);
}
/**
* Accessor for URI parameters
* @return A name-value list containing the parameters.
*/
public NameValueList getParameters() {
return uriParms;
}
/** Remove the URI parameters.
*
*/
public void removeParameters() {
this.uriParms = new NameValueList();
}
/**
* Accessor forSIPObjects
* @return Get the query headers (that appear after the ? in
* the URL)
*/
public NameValueList getQheaders() {
return qheaders;
}
/**
* Get the urse parameter.
* @return User parameter (user= phone or user=ip).
*/
public String getUserType() {
return (String) uriParms.getValue(USER);
}
/**
* Get the password of the user.
* @return User password when it embedded as part of the uri
* ( a very bad idea).
*/
public String getUserPassword() {
if (authority == null)
return null;
return authority.getPassword();
}
/** Set the user password.
*@param password - password to set.
*/
public void setUserPassword(String password) {
if (this.authority == null)
this.authority = new Authority();
authority.setPassword(password);
}
/**
* Returns the stucture corresponding to the telephone number
* provided that the user is a telephone subscriber.
* @return TelephoneNumber part of the url (only makes sense
* when user = phone is specified)
*/
public TelephoneNumber getTelephoneSubscriber() {
if (telephoneSubscriber == null) {
telephoneSubscriber = new TelephoneNumber();
}
return telephoneSubscriber;
}
/**
* Get the host and port of the server.
* @return get the host:port part of the url parsed into a
* structure.
*/
public HostPort getHostPort() {
if (authority == null || authority.getHost() == null )
return null;
else {
return authority.getHostPort();
}
}
/** Get the port from the authority field.
*
*@return the port from the authority field.
*/
public int getPort() {
HostPort hp = this.getHostPort();
if (hp == null)
return -1;
return hp.getPort();
}
/** Get the host protion of the URI.
* @return the host portion of the url.
*/
public String getHost() {
if ( authority == null) return null;
else if (authority.getHost() == null ) return null;
else return authority.getHost().encode();
}
/**
* returns true if the user is a telephone subscriber.
* If the host is an Internet telephony
* gateway, a telephone-subscriber field MAY be used instead
* of a user field. The telephone-subscriber field uses the
* notation of RFC 2806 [19]. Any characters of the un-escaped
* "telephone-subscriber" that are not either in the set
* "unreserved" or "user-unreserved" MUST be escaped. The set
* of characters not reserved in the RFC 2806 description of
* telephone-subscriber contains a number of characters in
* various syntax elements that need to be escaped when used
* in SIP URLs, for example quotation marks (%22), hash (%23),
* colon (%3a), at-sign (%40) and the "unwise" characters,
* i.e., punctuation of %5b and above.
*
* The telephone number is a special case of a user name and
* cannot be distinguished by a BNF. Thus, a URL parameter,
* user, is added to distinguish telephone numbers from user
* names.
*
* The user parameter value "phone" indicates that the user
* part contains a telephone number. Even without this
* parameter, recipients of SIP URLs MAY interpret the pre-@
* part as a telephone number if local restrictions on the
* @return true if the user is a telephone subscriber.
*/
public boolean isUserTelephoneSubscriber() {
String usrtype = (String) uriParms.getValue(USER);
if (usrtype == null)
return false;
return usrtype.equalsIgnoreCase(PHONE);
}
/**
*remove the ttl value from the parameter list if it exists.
*/
public void removeTTL() {
if (uriParms != null)
uriParms.delete(TTL);
}
/**
*Remove the maddr param if it exists.
*/
public void removeMAddr() {
if (uriParms != null)
uriParms.delete(MADDR);
}
/**
*Delete the transport string.
*/
public void removeTransport() {
if (uriParms != null)
uriParms.delete(TRANSPORT);
}
/** Remove a header given its name (provided it exists).
* @param name name of the header to remove.
*/
public void removeHeader(String name) {
if (qheaders != null)
qheaders.delete(name);
}
/** Remove all headers.
*/
public void removeHeaders() {
qheaders = new NameValueList();
}
/**
* Set the user type.
*/
public void removeUserType() {
if (uriParms != null)
uriParms.delete(USER);
}
/**
*remove the port setting.
*/
public void removePort() {
authority.removePort();
}
/**
* remove the Method.
*/
public void removeMethod() {
if (uriParms != null)
uriParms.delete(METHOD);
}
/** Sets the user of SipURI. The identifier of a particular resource at
* the host being addressed. The user and the user password including the
* "at" sign make up the user-info.
*
* @param uname The new String value of the user.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the user value.
*/
public void setUser(String uname) {
if (this.authority == null) {
this.authority = new Authority();
}
this.authority.setUser(uname);
}
/** Remove the user.
*/
public void removeUser() {
this.authority.removeUserInfo();
}
/** Set the default parameters for this URI.
* Do nothing if the parameter is already set to some value.
* Otherwise set it to the given value.
* @param name Name of the parameter to set.
* @param value value of the parameter to set.
*/
public void setDefaultParm(String name, Object value) {
if (uriParms.getValue(name) == null) {
NameValue nv = new NameValue(name, value);
uriParms.set(nv);
}
}
/** Set the authority member
* @param authority Authority to set.
*/
public void setAuthority(Authority authority) {
this.authority = authority;
}
/** Set the host for this URI.
* @param h host to set.
*/
public void setHost(Host h) {
if (this.authority == null)
this.authority = new Authority();
this.authority.setHost(h);
}
/** Set the uriParms member
* @param parms URI parameters to set.
*/
public void setUriParms(NameValueList parms) {
uriParms = parms;
}
/**
* Set a given URI parameter. Note - parameter must be properly
* encoded before the function is called.
* @param name Name of the parameter to set.
* @param value value of the parameter to set.
*/
public void setUriParm(String name, Object value) {
NameValue nv = new NameValue(name, value);
uriParms.set(nv);
}
/** Set the qheaders member
* @param parms query headers to set.
*/
public void setQheaders(NameValueList parms) {
qheaders = parms;
}
/**
* Set the MADDR parameter .
* @param mAddr Host Name to set
*/
public void setMAddr(String mAddr) {
NameValue nameValue = uriParms.getNameValue(MADDR);
Host host = new Host();
host.setAddress(mAddr);
if (nameValue != null)
nameValue.setValueAsObject(host);
else {
nameValue = new NameValue(MADDR, host);
uriParms.set(nameValue);
}
}
/** Sets the value of the user parameter. The user URI parameter exists to
* distinguish telephone numbers from user names that happen to look like
* telephone numbers. This is equivalent to setParameter("user", user).
*
* @param usertype New value String value of the method parameter
*/
public void setUserParam(String usertype) {
uriParms.set(USER, usertype);
}
/**
* Set the Method
* @param method method parameter
*/
public void setMethod(String method) {
uriParms.set(METHOD, method);
}
/**
* Sets ISDN subaddress of SipURL
* @param isdnSubAddress ISDN subaddress
*/
public void setIsdnSubAddress(String isdnSubAddress) {
if (telephoneSubscriber == null)
telephoneSubscriber = new TelephoneNumber();
telephoneSubscriber.setIsdnSubaddress(isdnSubAddress);
}
/**
* Set the telephone subscriber field.
* @param tel Telephone subscriber field to set.
*/
public void setTelephoneSubscriber(TelephoneNumber tel) {
telephoneSubscriber = tel;
}
/** set the port to a given value.
* @param p Port to set.
*/
public void setPort(int p) {
if (authority == null)
authority = new Authority();
authority.setPort(p);
}
/**
* Boolean to check if a parameter of a given name exists.
* @param name Name of the parameter to check on.
* @return a boolean indicating whether the parameter exists.
*/
public boolean hasParameter(String name) {
return uriParms.getValue(name) != null;
}
/**
* Set the query header when provided as a name-value pair.
* @param nameValue qeuery header provided as a name,value pair.
*/
public void setQHeader(NameValue nameValue) {
this.qheaders.set(nameValue);
}
/** Set the parameter as given.
*@param nameValue - parameter to set.
*/
public void setUriParameter(NameValue nameValue) {
this.uriParms.set(nameValue);
}
/** Return true if the transport parameter is defined.
* @return true if transport appears as a parameter and false otherwise.
*/
public boolean hasTransport() {
return hasParameter(TRANSPORT);
}
/**
* Remove a parameter given its name
* @param name -- name of the parameter to remove.
*/
public void removeParameter(String name) {
uriParms.delete(name);
}
/** Set the hostPort field of the imbedded authority field.
*@param hostPort is the hostPort to set.
*/
public void setHostPort(HostPort hostPort) {
if (this.authority == null) {
this.authority = new Authority();
}
authority.setHostPort(hostPort);
}
/** clone this.
*/
public Object clone() {
SipUri retval = (SipUri) super.clone();
if (this.authority != null)
retval.authority = (Authority) this.authority.clone();
if (this.uriParms != null)
retval.uriParms = (NameValueList) this.uriParms.clone();
if (this.qheaders != null)
retval.qheaders = (NameValueList) this.qheaders.clone();
if (this.telephoneSubscriber != null)
retval.telephoneSubscriber = (TelephoneNumber) this.telephoneSubscriber.clone();
return retval;
}
/**
* Returns the value of the named header, or null if it is not set.
* SIP/SIPS URIs may specify headers. As an example, the URI
* sip:joe@jcp.org?priority=urgent has a header "priority" whose
* value is "urgent".
*
* @param name name of header to retrieve
* @return the value of specified header
*/
public String getHeader(String name) {
return this.qheaders.getValue(name) != null
? this.qheaders.getValue(name).toString()
: null;
}
/**
* Returns an Iterator over the names (Strings) of all headers present
* in this SipURI.
*
* @return an Iterator over all the header names
*/
public Iterator getHeaderNames() {
return this.qheaders.getNames();
}
/** Returns the value of the lr parameter, or null if this
* is not set. This is equivalent to getParameter("lr").
*
* @return the value of the lr parameter
*/
public String getLrParam() {
boolean haslr = this.hasParameter(LR);
return haslr ? "true" : null;
}
/** Returns the value of the maddr parameter, or null if this
* is not set. This is equivalent to getParameter("maddr").
*
* @return the value of the maddr parameter
*/
public String getMAddrParam() {
NameValue maddr = uriParms.getNameValue(MADDR);
if (maddr == null)
return null;
String host = (String) maddr.getValueAsObject();
return host;
}
/**
* Returns the value of the method parameter, or null if this
* is not set. This is equivalent to getParameter("method").
*
* @return the value of the method parameter
*/
public String getMethodParam() {
return this.getParameter(METHOD);
}
/**
* Returns the value of the named parameter, or null if it is not set. A
* zero-length String indicates flag parameter.
*
* @param name name of parameter to retrieve
* @return the value of specified parameter
*/
public String getParameter(String name) {
Object val = uriParms.getValue(name);
if (val == null)
return null;
if (val instanceof GenericObject)
return ((GenericObject) val).encode();
else
return val.toString();
}
/**
* Returns an Iterator over the names (Strings) of all parameters present
*
* in this ParametersHeader.
*
*
*
* @return an Iterator over all the parameter names
*
*/
public Iterator getParameterNames() {
return this.uriParms.getNames();
}
/** Returns the value of the "ttl" parameter, or -1 if this is not set.
* This method is equivalent to getParameter("ttl").
*
* @return the value of the ttl parameter
*/
public int getTTLParam() {
Integer ttl = (Integer) uriParms.getValue("ttl");
if (ttl != null)
return ttl.intValue();
else
return -1;
}
/** Returns the value of the "transport" parameter, or null if this is not
* set. This is equivalent to getParameter("transport").
*
* @return the transport paramter of the SipURI
*/
public String getTransportParam() {
if (uriParms != null) {
return (String) uriParms.getValue(TRANSPORT);
} else
return null;
}
/** Returns the value of the userParam,
*or null if this is not set.
*
* This is equivalent to getParameter("user").
*
* @return the value of the userParam of the SipURI
*/
public String getUser() {
return authority.getUser();
}
/** Returns true if this SipURI is secure i.e. if this SipURI represents a
* sips URI. A sip URI returns false.
*
* @return true if this SipURI represents a sips URI, and
* false if it represents a sip URI.
*/
public boolean isSecure() {
return this.getScheme().equalsIgnoreCase(SIPS);
}
/** This method determines if this is a URI with a scheme of "sip" or "sips".
*
* @return true if the scheme is "sip" or "sips", false otherwise.
*/
public boolean isSipURI() {
return true;
}
/** Sets the value of the specified header fields to be included in a
* request constructed from the URI. If the header already had a value it
* will be overwritten.
*
* @param name - a String specifying the header name
* @param value - a String specifying the header value
*/
public void setHeader(String name, String value) {
NameValue nv = new NameValue(name, value);
qheaders.set(nv);
}
/**
* Set the host portion of the SipURI
*
* @param host host to set.
*/
public void setHost(String host) throws ParseException {
Host h = new Host(host);
this.setHost(h);
}
/** Sets the value of the lr parameter of this SipURI. The lr
* parameter, when present, indicates that the element responsible for
* this resource implements the routing mechanisms specified in RFC 3261.
* This parameter will be used in the URIs proxies place in the
* Record-Route header field values, and may appear in the URIs in a
* pre-existing route set.
*/
public void setLrParam() {
this.uriParms.set("lr",null); // JvB: fixed to not add duplicates
}
/**
* Sets the value of the maddr parameter of this SipURI. The
* maddr parameter indicates the server address to be contacted for this
* user, overriding any address derived from the host field. This is
* equivalent to setParameter("maddr", maddr).
*
* @param maddr New value of the maddr parameter
*/
public void setMAddrParam(String maddr) throws ParseException {
if (maddr == null)
throw new NullPointerException("bad maddr");
setParameter("maddr", maddr);
}
/** Sets the value of the method parameter. This specifies
* which SIP method to use in requests directed at this URI. This is
* equivalent to setParameter("method", method).
*
* @param method - new value String value of the method parameter
*/
public void setMethodParam(String method) throws ParseException {
setParameter("method", method);
}
/**
* Sets the value of the specified parameter. If the parameter already had
*
* a value it will be overwritten. A zero-length String indicates flag
*
* parameter.
*
*
*
* @param name - a String specifying the parameter name
*
* @param value - a String specifying the parameter value
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the parameter name or value.
*
*/
public void setParameter(String name, String value) throws ParseException {
if (name.equalsIgnoreCase("ttl")) {
try {
Integer.parseInt(value);
} catch (NumberFormatException ex) {
throw new ParseException("bad parameter " + value, 0);
}
}
uriParms.set(name,value);
}
/** Sets the scheme of this URI to sip or sips depending on whether the
* argument is true or false. The default value is false.
*
* @param secure - the boolean value indicating if the SipURI is secure.
*/
public void setSecure(boolean secure) {
if (secure)
this.scheme = SIPS;
else
this.scheme = SIP;
}
/** Sets the value of the ttl parameter. The ttl parameter
* specifies the time-to-live value when packets are sent using UDP
* multicast. This is equivalent to setParameter("ttl", ttl).
*
* @param ttl - new value of the ttl parameter
*/
public void setTTLParam(int ttl) {
if (ttl <= 0)
throw new IllegalArgumentException("Bad ttl value");
if (uriParms != null) {
NameValue nv = new NameValue("ttl", Integer.valueOf(ttl));
uriParms.set(nv);
}
}
/** Sets the value of the "transport" parameter. This parameter specifies
* which transport protocol to use for sending requests and responses to
* this entity. The following values are defined: "udp", "tcp", "sctp",
* "tls", but other values may be used also. This method is equivalent to
* setParameter("transport", transport). Transport parameter constants
* are defined in the {@link javax.sip.ListeningPoint}.
*
* @param transport - new value for the "transport" parameter
* @see javax.sip.ListeningPoint
*/
public void setTransportParam(String transport) throws ParseException {
if (transport == null)
throw new NullPointerException("null arg");
if (transport.compareToIgnoreCase("UDP") == 0
|| transport.compareToIgnoreCase("TLS") == 0
|| transport.compareToIgnoreCase("TCP") == 0
|| transport.compareToIgnoreCase("SCTP") == 0) {
NameValue nv = new NameValue(TRANSPORT, transport.toLowerCase());
uriParms.set(nv);
} else
throw new ParseException("bad transport " + transport, 0);
}
/** Returns the user part of this SipURI, or null if it is not set.
*
* @return the user part of this SipURI
*/
public String getUserParam() {
return getParameter("user");
}
/** Returns whether the the lr parameter is set. This is
* equivalent to hasParameter("lr"). This interface has no getLrParam as
* RFC3261 does not specify any values for the "lr" paramater.
*
* @return true if the "lr" parameter is set, false otherwise.
*/
public boolean hasLrParam() {
return uriParms.getNameValue("lr") != null;
}
/**
* Returns whether the gr parameter is set.
*
* Not part on the interface since gruu is not part of the base RFC3261.
*/
public boolean hasGrParam() {
return uriParms.getNameValue(GRUU) != null;
}
/**
* Sets the gr parameter.
*
* Not part on the interface since gruu is not part of the base RFC3261.
*/
public void setGrParam(String value) {
this.uriParms.set(GRUU, value); // JvB: fixed to not add duplicates
}
/**
* Sets the gr parameter.
*
* Not part on the interface since gruu is not part of the base RFC3261.
*/
public String getGrParam() {
return (String) this.uriParms.getValue(GRUU); // JvB: fixed to not add duplicates
}
/**
*remove the +sip-instance value from the parameter list if it exists.
*/
}
java/gov/nist/javax/sip/address/TelURLImpl.java 0100644 0000000 0000000 00000014775 13513104763 020444 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.address;
import gov.nist.core.NameValueList;
import java.text.ParseException;
import java.util.Iterator;
/**
* Implementation of the TelURL interface.
*
* @version 1.2 $Revision: 1.10 $ $Date: 2009/11/15 19:50:45 $
*
* @author M. Ranganathan
*
*/
public class TelURLImpl
extends GenericURI
implements javax.sip.address.TelURL {
private static final long serialVersionUID = 5873527320305915954L;
protected TelephoneNumber telephoneNumber;
/** Creates a new instance of TelURLImpl */
public TelURLImpl() {
this.scheme = "tel";
}
/** Set the telephone number.
*@param telephoneNumber -- telephone number to set.
*/
public void setTelephoneNumber(TelephoneNumber telephoneNumber) {
this.telephoneNumber = telephoneNumber;
}
/** Returns the value of the isdnSubAddress parameter, or null
* if it is not set.
*
* @return the value of the isdnSubAddress parameter
*/
public String getIsdnSubAddress() {
return telephoneNumber.getIsdnSubaddress();
}
/** Returns the value of the postDial parameter, or null if it
* is not set.
*
* @return the value of the postDial parameter
*/
public String getPostDial() {
return telephoneNumber.getPostDial();
}
/** Returns the value of the "scheme" of this URI, for example "sip", "sips"
* or "tel".
*
* @return the scheme paramter of the URI
*/
public String getScheme() {
return this.scheme;
}
/** Returns true if this TelURL is global i.e. if the TelURI
* has a global phone user.
*
* @return true if this TelURL represents a global phone user,
* and false otherwise.
*/
public boolean isGlobal() {
return telephoneNumber.isGlobal();
}
/** This method determines if this is a URI with a scheme of "sip" or "sips".
*
* @return true if the scheme is "sip" or "sips", false otherwise.
*/
public boolean isSipURI() {
return false;
}
/** Sets phone user of this TelURL to be either global or local. The default
* value is false, hence the TelURL is defaulted to local.
*
* @param global - the boolean value indicating if the TelURL has a global
* phone user.
*/
public void setGlobal(boolean global) {
this.telephoneNumber.setGlobal(global);
}
/** Sets ISDN subaddress of this TelURL. If a subaddress is present, it is
* appended to the phone number after ";isub=".
*
* @param isdnSubAddress - new value of the isdnSubAddress
* parameter
*/
public void setIsdnSubAddress(String isdnSubAddress) {
this.telephoneNumber.setIsdnSubaddress(isdnSubAddress);
}
/** Sets post dial of this TelURL. The post-dial sequence describes what and
* when the local entity should send to the phone line.
*
* @param postDial - new value of the postDial parameter
*/
public void setPostDial(String postDial) {
this.telephoneNumber.setPostDial(postDial);
}
/**
* Set the telephone number.
* @param telephoneNumber long phone number to set.
*/
public void setPhoneNumber(String telephoneNumber) {
this.telephoneNumber.setPhoneNumber(telephoneNumber);
}
/** Get the telephone number.
*
*@return -- the telephone number.
*/
public String getPhoneNumber() {
return this.telephoneNumber.getPhoneNumber();
}
/** Return the string encoding.
*
*@return -- the string encoding.
*/
public String toString() {
return this.scheme + ":" + telephoneNumber.encode();
}
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
buffer.append(this.scheme).append(':');
telephoneNumber.encode(buffer);
return buffer;
}
/** Deep copy clone operation.
*
*@return -- a cloned version of this telephone number.
*/
public Object clone() {
TelURLImpl retval = (TelURLImpl) super.clone();
if (this.telephoneNumber != null)
retval.telephoneNumber = (TelephoneNumber) this.telephoneNumber.clone();
return retval;
}
public String getParameter(String parameterName) {
return telephoneNumber.getParameter(parameterName);
}
public void setParameter(String name, String value) {
telephoneNumber.setParameter(name, value);
}
public Iterator getParameterNames() {
return telephoneNumber.getParameterNames();
}
public NameValueList getParameters() {
return telephoneNumber.getParameters();
}
public void removeParameter(String name) {
telephoneNumber.removeParameter(name);
}
/* (non-Javadoc)
* @see javax.sip.address.TelURL#setPhoneContext(java.lang.String)
*/
public void setPhoneContext(String phoneContext) throws ParseException {
// JvB: set (null) should be interpreted as 'remove'
if (phoneContext==null) {
this.removeParameter("phone-context");
} else {
this.setParameter("phone-context",phoneContext);
}
}
/* (non-Javadoc)
* @see javax.sip.address.TelURL#getPhoneContext()
*/
public String getPhoneContext() {
return this.getParameter("phone-context");
}
}
java/gov/nist/javax/sip/address/TelephoneNumber.java 0100644 0000000 0000000 00000014430 13513104763 021573 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.address;
import gov.nist.core.*;
import java.util.Iterator;
/**
* Telephone number class.
* @version 1.2
* @version 1.2 $Revision: 1.10 $ $Date: 2009/07/17 18:57:23 $
*
* @author M. Ranganathan
*
*/
public class TelephoneNumber extends NetObject {
public static final String POSTDIAL = ParameterNames.POSTDIAL;
public static final String PHONE_CONTEXT_TAG =
ParameterNames.PHONE_CONTEXT_TAG;
public static final String ISUB = ParameterNames.ISUB;
public static final String PROVIDER_TAG = ParameterNames.PROVIDER_TAG;
/** isglobal field
*/
protected boolean isglobal;
/** phoneNumber field
*/
protected String phoneNumber;
/** parmeters list
*/
protected NameValueList parameters;
/** Creates new TelephoneNumber */
public TelephoneNumber() {
parameters = new NameValueList();
}
/** delete the specified parameter.
* @param name String to set
*/
public void deleteParm(String name) {
parameters.delete(name);
}
/** get the PhoneNumber field
* @return String
*/
public String getPhoneNumber() {
return phoneNumber;
}
/** get the PostDial field
* @return String
*/
public String getPostDial() {
return (String) parameters.getValue(POSTDIAL);
}
/**
* Get the isdn subaddress for this number.
* @return String
*/
public String getIsdnSubaddress() {
return (String) parameters.getValue(ISUB);
}
/** returns true if th PostDial field exists
* @return boolean
*/
public boolean hasPostDial() {
return parameters.getValue(POSTDIAL) != null;
}
/** return true if this header has parameters.
* @param pname String to set
* @return boolean
*/
public boolean hasParm(String pname) {
return parameters.hasNameValue(pname);
}
/**
* return true if the isdn subaddress exists.
* @return boolean
*/
public boolean hasIsdnSubaddress() {
return hasParm(ISUB);
}
/**
* is a global telephone number.
* @return boolean
*/
public boolean isGlobal() {
return isglobal;
}
/** remove the PostDial field
*/
public void removePostDial() {
parameters.delete(POSTDIAL);
}
/**
* Remove the isdn subaddress (if it exists).
*/
public void removeIsdnSubaddress() {
deleteParm(ISUB);
}
/**
* Set the list of parameters.
* @param p NameValueList to set
*/
public void setParameters(NameValueList p) {
parameters = p;
}
/** set the Global field
* @param g boolean to set
*/
public void setGlobal(boolean g) {
isglobal = g;
}
/** set the PostDial field
* @param p String to set
*/
public void setPostDial(String p) {
NameValue nv = new NameValue(POSTDIAL, p);
parameters.set(nv);
}
/** set the specified parameter
* @param name String to set
* @param value Object to set
*/
public void setParm(String name, Object value) {
NameValue nv = new NameValue(name, value);
parameters.set(nv);
}
/**
* set the isdn subaddress for this structure.
* @param isub String to set
*/
public void setIsdnSubaddress(String isub) {
setParm(ISUB, isub);
}
/** set the PhoneNumber field
* @param num String to set
*/
public void setPhoneNumber(String num) {
phoneNumber = num;
}
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
if (isglobal)
buffer.append('+');
buffer.append(phoneNumber);
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
return buffer;
}
/**
* Returns the value of the named parameter, or null if it is not set. A
* zero-length String indicates flag parameter.
*
* @param name name of parameter to retrieve
*
* @return the value of specified parameter
*
*/
public String getParameter(String name) {
Object val = parameters.getValue(name);
if (val == null)
return null;
if (val instanceof GenericObject)
return ((GenericObject) val).encode();
else
return val.toString();
}
/**
*
* Returns an Iterator over the names (Strings) of all parameters.
*
* @return an Iterator over all the parameter names
*
*/
public Iterator getParameterNames() {
return this.parameters.getNames();
}
public void removeParameter(String parameter) {
this.parameters.delete(parameter);
}
public void setParameter(String name, String value) {
NameValue nv = new NameValue(name, value);
this.parameters.set(nv);
}
public Object clone() {
TelephoneNumber retval = (TelephoneNumber) super.clone();
if (this.parameters != null)
retval.parameters = (NameValueList) this.parameters.clone();
return retval;
}
public NameValueList getParameters() {
return this.parameters;
}
}
java/gov/nist/javax/sip/address/UserInfo.java 0100644 0000000 0000000 00000011625 13513104763 020234 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*
* Acknowledgement -- Lamine Brahimi
* Submitted a bug fix for a this class.
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.address;
/**
* User information part of a URL.
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:23 $
* @author M. Ranganathan
*
*/
public final class UserInfo extends NetObject {
private static final long serialVersionUID = 7268593273924256144L;
/** user field
*/
protected String user;
/** password field
*/
protected String password;
/** userType field
*/
protected int userType;
/** Constant field
*/
public final static int TELEPHONE_SUBSCRIBER = 1;
/** constant field
*/
public final static int USER = 2;
/** Default constructor
*/
public UserInfo() {
super();
}
/**
* Compare for equality.
* @param obj Object to set
* @return true if the two headers are equals, false otherwise.
*/
public boolean equals(Object obj) {
if (getClass() != obj.getClass()) {
return false;
}
UserInfo other = (UserInfo) obj;
if (this.userType != other.userType) {
return false;
}
if (!this.user.equalsIgnoreCase(other.user)) {
return false;
}
if (this.password != null && other.password == null)
return false;
if (other.password != null && this.password == null)
return false;
if (this.password == other.password)
return true;
return (this.password.equals(other.password));
}
/**
* Encode the user information as a string.
* @return String
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
if (password != null)
buffer.append(user).append(COLON).append(password);
else
buffer.append(user);
return buffer;
}
/** Clear the password field.
*/
public void clearPassword() {
this.password = null;
}
/**
* Gets the user type (which can be set to TELEPHONE_SUBSCRIBER or USER)
* @return the type of user.
*/
public int getUserType() {
return userType;
}
/** get the user field.
* @return String
*/
public String getUser() {
return user;
}
/** get the password field.
* @return String
*/
public String getPassword() {
return password;
}
/**
* Set the user member
* @param user String to set
*/
public void setUser(String user) {
this.user = user;
// BUG Fix submitted by Lamine Brahimi
// add this (taken form sip_messageParser)
// otherwise comparison of two SipUrl will fail because this
// parameter is not set (whereas it is set in sip_messageParser).
if (user != null
&& (user.indexOf(POUND) >= 0 || user.indexOf(SEMICOLON) >= 0)) {
setUserType(TELEPHONE_SUBSCRIBER);
} else {
setUserType(USER);
}
}
/**
* Set the password member
* @param p String to set
*/
public void setPassword(String p) {
password = p;
}
/**
* Set the user type (to TELEPHONE_SUBSCRIBER or USER).
* @param type int to set
* @throws IllegalArgumentException if type is not in range.
*/
public void setUserType(int type) throws IllegalArgumentException {
if (type != TELEPHONE_SUBSCRIBER && type != USER) {
throw new IllegalArgumentException("Parameter not in range");
}
userType = type;
}
}
java/gov/nist/javax/sip/address/package.html 0100644 0000000 0000000 00000000113 13513104763 020106 0 ustar 00 0000000 0000000
Implementation of the address package of the JAIN SIP API.
java/gov/nist/javax/sip/clientauthutils/ 0040755 0000000 0000000 00000000000 13513104763 017431 5 ustar 00 0000000 0000000 java/gov/nist/javax/sip/clientauthutils/AccountManager.java 0100644 0000000 0000000 00000001250 13513104763 023156 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
import javax.sip.ClientTransaction;
public interface AccountManager {
/**
* Returns the user credentials for a given SIP Domain.
* You can implement any desired method (such as popping up a dialog for example )
* to retrieve the credentials.
*
* @param challengedTransaction - the transaction that is being challenged.
* @param realm - the realm that is being challenged for which a credential should be
* returned.
* @return -- the user credentials associated with the domain.
*/
UserCredentials getCredentials(ClientTransaction challengedTransaction, String realm);
}
java/gov/nist/javax/sip/clientauthutils/AuthenticationHelper.java 0100644 0000000 0000000 00000005306 13513104763 024414 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
import java.text.ParseException;
import java.util.Collection;
import javax.sip.ClientTransaction;
import javax.sip.InvalidArgumentException;
import javax.sip.SipException;
import javax.sip.SipProvider;
import javax.sip.header.AuthorizationHeader;
import javax.sip.message.Request;
import javax.sip.message.Response;
/**
* A helper interface that provides useful functionality for clients that need to authenticate
* with servers.
*
* @author Emil Ivov
* @author Jeroen van Bemmel
* @author M. Ranganathan
*
* @since 2.0
*
*
*/
public interface AuthenticationHelper {
/**
* Uses securityAuthority to determinie a set of valid user credentials for
* the specified Response (Challenge) and appends it to the challenged
* request so that it could be retransmitted.
*
*
*
* @param challenge
* the 401/407 challenge response
* @param challengedTransaction
* the transaction established by the challenged request
* @param transactionCreator
* the JAIN SipProvider that we should use to create the new
* transaction.
* @param cacheTime The amount of time (seconds ) for which the authentication helper
* will keep a reference to the generated credentials in a cache.
* If you specify -1, then the authentication credentials are cached
* until you remove them from the cache. If you choose this option, make sure
* you remove the cached headers or you will have a memory leak.
*
* @return a transaction containing a re-originated request with the
* necessary authorization header.
* @throws SipException
* if we get an exception white creating the new transaction
* @throws NullPointerException
* if an argument or a header is null.
*/
public abstract ClientTransaction handleChallenge(Response challenge,
ClientTransaction challengedTransaction,
SipProvider transactionCreator, int cacheTime ) throws SipException,
NullPointerException;
/**
* Attach authentication headers to the given request. This looks up
* the credential cache and picks up any stored authentication headers
* for the given call ID and attaches it to the request.
* @param request - the request for which we attach the authentication headers.
*/
public abstract void setAuthenticationHeaders(Request request) ;
/**
* Remove cached entry.
*
* @param callId -- the call Id for which we want to remove the cached headers.
*
*/
public abstract void removeCachedAuthenticationHeaders(String callId);
}
java/gov/nist/javax/sip/clientauthutils/AuthenticationHelperImpl.java 0100644 0000000 0000000 00000045325 13513104763 025243 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
/*
*
* This code has been contributed with permission from:
*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client but has been significantly changed.
* It is donated to the JAIN-SIP project as it is common code that many sip clients
* need to perform class and others will consitute a set of utility functions
* that will implement common operations that ease the life of the developer.
*
* Acknowledgements:
* ----------------
*
* Fredrik Wickstrom reported that dialog cseq counters are not incremented
* when resending requests. He later uncovered additional problems and
* proposed a way to fix them (his proposition was taken into account).
*/
import gov.nist.javax.sip.SipStackImpl;
import gov.nist.javax.sip.address.SipUri;
import gov.nist.javax.sip.message.SIPRequest;
import gov.nist.javax.sip.stack.SIPClientTransaction;
import gov.nist.javax.sip.stack.SIPTransactionStack;
import java.text.ParseException;
import java.util.Collection;
import java.util.Iterator;
import java.util.ListIterator;
import java.util.Timer;
import javax.sip.ClientTransaction;
import javax.sip.DialogState;
import javax.sip.InvalidArgumentException;
import javax.sip.SipException;
import javax.sip.SipProvider;
import javax.sip.address.Hop;
import javax.sip.address.SipURI;
import javax.sip.address.URI;
import javax.sip.header.AuthorizationHeader;
import javax.sip.header.CSeqHeader;
import javax.sip.header.Header;
import javax.sip.header.HeaderFactory;
import javax.sip.header.ProxyAuthenticateHeader;
import javax.sip.header.ProxyAuthorizationHeader;
import javax.sip.header.ViaHeader;
import javax.sip.header.WWWAuthenticateHeader;
import javax.sip.message.Request;
import javax.sip.message.Response;
/**
* The class handles authentication challenges, caches user credentials and takes care (through
* the SecurityAuthority interface) about retrieving passwords.
*
*
* @author Emil Ivov
* @author Jeroen van Bemmel
* @author M. Ranganathan
*
* @since 2.0
*/
public class AuthenticationHelperImpl implements AuthenticationHelper {
/**
* Credentials cached so far.
*/
private CredentialsCache cachedCredentials;
/**
* The account manager for the system. Stores user credentials.
*/
private Object accountManager = null;
/*
* Header factory for this security manager.
*/
private HeaderFactory headerFactory;
private SipStackImpl sipStack;
Timer timer;
/**
* Default constructor for the security manager. There is one Account manager. There is one
* SipSecurity manager for every user name,
*
* @param sipStack -- our stack.
* @param accountManager -- an implementation of the AccountManager interface.
* @param headerFactory -- header factory.
*/
public AuthenticationHelperImpl(SipStackImpl sipStack, AccountManager accountManager,
HeaderFactory headerFactory) {
this.accountManager = accountManager;
this.headerFactory = headerFactory;
this.sipStack = sipStack;
this.cachedCredentials = new CredentialsCache(((SIPTransactionStack) sipStack).getTimer());
}
/**
* Default constructor for the security manager. There is one Account manager. There is one
* SipSecurity manager for every user name,
*
* @param sipStack -- our stack.
* @param accountManager -- an implementation of the AccountManager interface.
* @param headerFactory -- header factory.
*/
public AuthenticationHelperImpl(SipStackImpl sipStack, SecureAccountManager accountManager,
HeaderFactory headerFactory) {
this.accountManager = accountManager;
this.headerFactory = headerFactory;
this.sipStack = sipStack;
this.cachedCredentials = new CredentialsCache(((SIPTransactionStack) sipStack).getTimer());
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.clientauthutils.AuthenticationHelper#handleChallenge(javax.sip.message.Response,
* javax.sip.ClientTransaction, javax.sip.SipProvider)
*/
public ClientTransaction handleChallenge(Response challenge,
ClientTransaction challengedTransaction, SipProvider transactionCreator, int cacheTime)
throws SipException, NullPointerException {
try {
if (sipStack.isLoggingEnabled()) {
sipStack.getStackLogger().logDebug("handleChallenge: " + challenge);
}
SIPRequest challengedRequest = ((SIPRequest) challengedTransaction.getRequest());
Request reoriginatedRequest = null;
/*
* If the challenged request is part of a Dialog and the
* Dialog is confirmed the re-originated request should be
* generated as an in-Dialog request.
*/
if ( challengedRequest.getToTag() != null ||
challengedTransaction.getDialog() == null ||
challengedTransaction.getDialog().getState() != DialogState.CONFIRMED) {
reoriginatedRequest = (Request) challengedRequest.clone();
} else {
/*
* Re-originate the request by consulting the dialog. In particular
* the route set could change between the original request and the
* in-dialog challenge.
*/
reoriginatedRequest =
challengedTransaction.getDialog().createRequest(challengedRequest.getMethod());
Iterator headerNames = challengedRequest.getHeaderNames();
while (headerNames.hasNext()) {
String headerName = headerNames.next();
if ( reoriginatedRequest.getHeader(headerName) != null) {
ListIterator iterator = reoriginatedRequest.getHeaders(headerName);
while (iterator.hasNext()) {
reoriginatedRequest.addHeader(iterator.next());
}
}
}
}
// remove the branch id so that we could use the request in a new
// transaction
removeBranchID(reoriginatedRequest);
if (challenge == null || reoriginatedRequest == null) {
throw new NullPointerException("A null argument was passed to handle challenge.");
}
ListIterator authHeaders = null;
if (challenge.getStatusCode() == Response.UNAUTHORIZED) {
authHeaders = challenge.getHeaders(WWWAuthenticateHeader.NAME);
} else if (challenge.getStatusCode() == Response.PROXY_AUTHENTICATION_REQUIRED) {
authHeaders = challenge.getHeaders(ProxyAuthenticateHeader.NAME);
} else {
throw new IllegalArgumentException("Unexpected status code ");
}
if (authHeaders == null) {
throw new IllegalArgumentException(
"Could not find WWWAuthenticate or ProxyAuthenticate headers");
}
// Remove all authorization headers from the request (we'll re-add them
// from cache)
reoriginatedRequest.removeHeader(AuthorizationHeader.NAME);
reoriginatedRequest.removeHeader(ProxyAuthorizationHeader.NAME);
// rfc 3261 says that the cseq header should be augmented for the new
// request. do it here so that the new dialog (created together with
// the new client transaction) takes it into account.
// Bug report - Fredrik Wickstrom
CSeqHeader cSeq = (CSeqHeader) reoriginatedRequest.getHeader((CSeqHeader.NAME));
try {
cSeq.setSeqNumber(cSeq.getSeqNumber() + 1l);
} catch (InvalidArgumentException ex) {
throw new SipException("Invalid CSeq -- could not increment : "
+ cSeq.getSeqNumber());
}
/* Resolve this to the next hop based on the previous lookup. If we are not using
* lose routing (RFC2543) then just attach hop as a maddr param.
*/
if ( challengedRequest.getRouteHeaders() == null ) {
Hop hop = ((SIPClientTransaction) challengedTransaction).getNextHop();
SipURI sipUri = (SipURI) reoriginatedRequest.getRequestURI();
// BEGIN android-added
if ( !hop.getHost().equalsIgnoreCase(sipUri.getHost())
&& !hop.equals(sipStack.getRouter(challengedRequest).getOutboundProxy()) )
// END android-added
sipUri.setMAddrParam(hop.getHost());
if ( hop.getPort() != -1 ) sipUri.setPort(hop.getPort());
}
ClientTransaction retryTran = transactionCreator
.getNewClientTransaction(reoriginatedRequest);
WWWAuthenticateHeader authHeader = null;
SipURI requestUri = (SipURI) challengedTransaction.getRequest().getRequestURI();
while (authHeaders.hasNext()) {
authHeader = (WWWAuthenticateHeader) authHeaders.next();
String realm = authHeader.getRealm();
AuthorizationHeader authorization = null;
String sipDomain;
if ( this.accountManager instanceof SecureAccountManager ) {
UserCredentialHash credHash =
((SecureAccountManager)this.accountManager).getCredentialHash(challengedTransaction,realm);
URI uri = reoriginatedRequest.getRequestURI();
sipDomain = credHash.getSipDomain();
authorization = this.getAuthorization(reoriginatedRequest
.getMethod(), uri.toString(),
(reoriginatedRequest.getContent() == null) ? "" : new String(
reoriginatedRequest.getRawContent()), authHeader, credHash);
} else {
UserCredentials userCreds = ((AccountManager) this.accountManager).getCredentials(challengedTransaction, realm);
sipDomain = userCreds.getSipDomain();
if (userCreds == null)
throw new SipException(
"Cannot find user creds for the given user name and realm");
// we haven't yet authenticated this realm since we were
// started.
authorization = this.getAuthorization(reoriginatedRequest
.getMethod(), reoriginatedRequest.getRequestURI().toString(),
(reoriginatedRequest.getContent() == null) ? "" : new String(
reoriginatedRequest.getRawContent()), authHeader, userCreds);
}
if (sipStack.isLoggingEnabled())
sipStack.getStackLogger().logDebug(
"Created authorization header: " + authorization.toString());
if (cacheTime != 0)
cachedCredentials.cacheAuthorizationHeader(sipDomain,
authorization, cacheTime);
reoriginatedRequest.addHeader(authorization);
}
if (sipStack.isLoggingEnabled()) {
sipStack.getStackLogger().logDebug(
"Returning authorization transaction." + retryTran);
}
return retryTran;
} catch (SipException ex) {
throw ex;
} catch (Exception ex) {
sipStack.getStackLogger().logError("Unexpected exception ", ex);
throw new SipException("Unexpected exception ", ex);
}
}
/**
* Generates an authorisation header in response to wwwAuthHeader.
*
* @param method method of the request being authenticated
* @param uri digest-uri
* @param requestBody the body of the request.
* @param authHeader the challenge that we should respond to
* @param userCredentials username and pass
*
* @return an authorisation header in response to authHeader.
*
* @throws OperationFailedException if auth header was malformated.
*/
private AuthorizationHeader getAuthorization(String method, String uri, String requestBody,
WWWAuthenticateHeader authHeader, UserCredentials userCredentials) {
String response = null;
// JvB: authHeader.getQop() is a quoted _list_ of qop values
// (e.g. "auth,auth-int") Client is supposed to pick one
String qopList = authHeader.getQop();
String qop = (qopList != null) ? "auth" : null;
String nc_value = "00000001";
String cnonce = "xyz";
response = MessageDigestAlgorithm.calculateResponse(authHeader.getAlgorithm(),
userCredentials.getUserName(), authHeader.getRealm(), userCredentials
.getPassword(), authHeader.getNonce(), nc_value, // JvB added
cnonce, // JvB added
method, uri, requestBody, qop,sipStack.getStackLogger());// jvb changed
AuthorizationHeader authorization = null;
try {
if (authHeader instanceof ProxyAuthenticateHeader) {
authorization = headerFactory.createProxyAuthorizationHeader(authHeader
.getScheme());
} else {
authorization = headerFactory.createAuthorizationHeader(authHeader.getScheme());
}
authorization.setUsername(userCredentials.getUserName());
authorization.setRealm(authHeader.getRealm());
authorization.setNonce(authHeader.getNonce());
authorization.setParameter("uri", uri);
authorization.setResponse(response);
if (authHeader.getAlgorithm() != null) {
authorization.setAlgorithm(authHeader.getAlgorithm());
}
if (authHeader.getOpaque() != null) {
authorization.setOpaque(authHeader.getOpaque());
}
// jvb added
if (qop != null) {
authorization.setQop(qop);
authorization.setCNonce(cnonce);
authorization.setNonceCount(Integer.parseInt(nc_value));
}
authorization.setResponse(response);
} catch (ParseException ex) {
throw new RuntimeException("Failed to create an authorization header!");
}
return authorization;
}
/**
* Generates an authorisation header in response to wwwAuthHeader.
*
* @param method method of the request being authenticated
* @param uri digest-uri
* @param requestBody the body of the request.
* @param authHeader the challenge that we should respond to
* @param userCredentials username and pass
*
* @return an authorisation header in response to authHeader.
*
* @throws OperationFailedException if auth header was malformated.
*/
private AuthorizationHeader getAuthorization(String method, String uri, String requestBody,
WWWAuthenticateHeader authHeader, UserCredentialHash userCredentials) {
String response = null;
// JvB: authHeader.getQop() is a quoted _list_ of qop values
// (e.g. "auth,auth-int") Client is supposed to pick one
String qopList = authHeader.getQop();
String qop = (qopList != null) ? "auth" : null;
String nc_value = "00000001";
String cnonce = "xyz";
response = MessageDigestAlgorithm.calculateResponse(authHeader.getAlgorithm(),
userCredentials.getHashUserDomainPassword(), authHeader.getNonce(), nc_value, // JvB added
cnonce, // JvB added
method, uri, requestBody, qop,sipStack.getStackLogger());// jvb changed
AuthorizationHeader authorization = null;
try {
if (authHeader instanceof ProxyAuthenticateHeader) {
authorization = headerFactory.createProxyAuthorizationHeader(authHeader
.getScheme());
} else {
authorization = headerFactory.createAuthorizationHeader(authHeader.getScheme());
}
authorization.setUsername(userCredentials.getUserName());
authorization.setRealm(authHeader.getRealm());
authorization.setNonce(authHeader.getNonce());
authorization.setParameter("uri", uri);
authorization.setResponse(response);
if (authHeader.getAlgorithm() != null) {
authorization.setAlgorithm(authHeader.getAlgorithm());
}
if (authHeader.getOpaque() != null) {
authorization.setOpaque(authHeader.getOpaque());
}
// jvb added
if (qop != null) {
authorization.setQop(qop);
authorization.setCNonce(cnonce);
authorization.setNonceCount(Integer.parseInt(nc_value));
}
authorization.setResponse(response);
} catch (ParseException ex) {
throw new RuntimeException("Failed to create an authorization header!");
}
return authorization;
}
/**
* Removes all via headers from request and replaces them with a new one, equal to
* the one that was top most.
*
* @param request the Request whose branchID we'd like to remove.
*
*/
private void removeBranchID(Request request) {
ViaHeader viaHeader = (ViaHeader) request.getHeader(ViaHeader.NAME);
viaHeader.removeParameter("branch");
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.clientauthutils.AuthenticationHelper#attachAuthenticationHeaders(javax.sip.message.Request)
*/
public void setAuthenticationHeaders(Request request) {
SIPRequest sipRequest = (SIPRequest) request;
String callId = sipRequest.getCallId().getCallId();
request.removeHeader(AuthorizationHeader.NAME);
Collection authHeaders = this.cachedCredentials
.getCachedAuthorizationHeaders(callId);
if (authHeaders == null) {
if (sipStack.isLoggingEnabled())
sipStack.getStackLogger().logDebug(
"Could not find authentication headers for " + callId);
return;
}
for (AuthorizationHeader authHeader : authHeaders) {
request.addHeader(authHeader);
}
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.clientauthutils.AuthenticationHelper#removeCachedAuthenticationHeaders(java.lang.String)
*/
public void removeCachedAuthenticationHeaders(String callId) {
if (callId == null)
throw new NullPointerException("Null callId argument ");
this.cachedCredentials.removeAuthenticationHeader(callId);
}
}
java/gov/nist/javax/sip/clientauthutils/CredentialsCache.java 0100644 0000000 0000000 00000007110 13513104763 023451 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import javax.sip.*;
import javax.sip.header.*;
import javax.sip.address.*;
import javax.sip.message.*;
/**
* A cache of authorization headers to be used for subsequent processing when we
* set up calls. We cache credentials on a per proxy domain per user basis.
*
*/
class CredentialsCache {
/**
* The key for this map is the proxy domain name. A given proxy authorizes a
* user for a number of domains. The Hashtable value of the mapping is a
* mapping of user names to AuthorizationHeader list for that proxy domain.
*/
private ConcurrentHashMap> authorizationHeaders =
new ConcurrentHashMap>();
private Timer timer;
class TimeoutTask extends TimerTask {
String callId;
String userName;
public TimeoutTask(String userName, String proxyDomain) {
this.callId = proxyDomain;
this.userName = userName;
}
@Override
public void run() {
authorizationHeaders.remove(callId);
}
}
CredentialsCache (Timer timer) {
this.timer = timer;
}
/**
* Cache the bindings of proxyDomain and authorization header.
*
* @param callid
* the id of the call that the authorization header
* belongs to.
* @param authorization
* the authorization header that we'd like to cache.
*/
void cacheAuthorizationHeader(String callId,
AuthorizationHeader authorization, int cacheTime) {
String user = authorization.getUsername();
if ( callId == null) throw new NullPointerException("Call ID is null!");
if ( authorization == null) throw new NullPointerException("Null authorization domain");
List authHeaders = authorizationHeaders.get(callId);
if (authHeaders == null) {
authHeaders = new LinkedList();
authorizationHeaders.put(callId, authHeaders);
} else {
String realm = authorization.getRealm();
for (ListIterator li = authHeaders.listIterator(); li.hasNext();) {
AuthorizationHeader authHeader = (AuthorizationHeader) li.next();
if ( realm.equals(authHeader.getRealm()) ) {
li.remove();
}
}
}
authHeaders.add(authorization);
TimeoutTask timeoutTask = new TimeoutTask( callId,user);
if ( cacheTime != -1)
this.timer.schedule(timeoutTask, cacheTime*1000);
}
/**
* Returns an authorization header cached for the specified call id and null
* if no authorization header has been previously cached for this call.
*
* @param callid
* the call id that we'd like to retrive a cached authorization
* header for.
*
* @return authorization header corresponding to that user for the given
* proxy domain.
*/
Collection getCachedAuthorizationHeaders(
String callid) {
if (callid == null)
throw new NullPointerException("Null arg!");
return this.authorizationHeaders.get(callid);
}
/**
* Remove a cached authorization header.
*
* @param callId
*/
public void removeAuthenticationHeader(String callId) {
this.authorizationHeaders.remove(callId);
}
}
java/gov/nist/javax/sip/clientauthutils/MessageDigestAlgorithm.java 0100644 0000000 0000000 00000022244 13513104763 024670 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
import gov.nist.core.StackLogger;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
/**
* The class takes standard Http Authentication details and returns a response according to the
* MD5 algorithm
*
* @author Emil Ivov
*/
public class MessageDigestAlgorithm {
/**
* Calculates an http authentication response in accordance with rfc2617.
*
*
* @param algorithm a string indicating a pair of algorithms (MD5 (default), or MD5-sess) used
* to produce the digest and a checksum.
* @param hashUserNameRealmPasswd MD5 hash of (username:realm:password)
* @param nonce_value A server-specified data string provided in the challenge.
* @param cnonce_value an optional client-chosen value whose purpose is to foil chosen
* plaintext attacks.
* @param method the SIP method of the request being challenged.
* @param digest_uri_value the value of the "uri" directive on the Authorization header in the
* request.
* @param entity_body the entity-body
* @param qop_value Indicates what "quality of protection" the client has applied to the
* message.
* @param nc_value the hexadecimal count of the number of requests (including the current
* request) that the client has sent with the nonce value in this request.
* @return a digest response as defined in rfc2617
* @throws NullPointerException in case of incorrectly null parameters.
*/
static String calculateResponse(String algorithm, String hashUserNameRealmPasswd,
String nonce_value, String nc_value, String cnonce_value,
String method, String digest_uri_value, String entity_body, String qop_value,
StackLogger stackLogger) {
if (stackLogger.isLoggingEnabled()) {
stackLogger.logDebug("trying to authenticate using : " + algorithm + ", "+
hashUserNameRealmPasswd + ", " + nonce_value + ", "
+ nc_value + ", " + cnonce_value + ", " + method + ", " + digest_uri_value
+ ", " + entity_body + ", " + qop_value);
}
if (hashUserNameRealmPasswd == null || method == null
|| digest_uri_value == null || nonce_value == null)
throw new NullPointerException(
"Null parameter to MessageDigestAlgorithm.calculateResponse()");
// The following follows closely the algorithm for generating a response
// digest as specified by rfc2617
if (cnonce_value == null || cnonce_value.length() == 0)
throw new NullPointerException(
"cnonce_value may not be absent for MD5-Sess algorithm.");
String A2 = null;
if (qop_value == null || qop_value.trim().length() == 0
|| qop_value.trim().equalsIgnoreCase("auth")) {
A2 = method + ":" + digest_uri_value;
} else {
if (entity_body == null)
entity_body = "";
A2 = method + ":" + digest_uri_value + ":" + H(entity_body);
}
String request_digest = null;
if (cnonce_value != null && qop_value != null && nc_value != null
&& (qop_value.equalsIgnoreCase("auth") || qop_value.equalsIgnoreCase("auth-int")))
{
request_digest = KD(hashUserNameRealmPasswd, nonce_value + ":" + nc_value + ":" + cnonce_value + ":"
+ qop_value + ":" + H(A2));
} else {
request_digest = KD(hashUserNameRealmPasswd, nonce_value + ":" + H(A2));
}
return request_digest;
}
/**
* Calculates an http authentication response in accordance with rfc2617.
*
*
* @param algorithm a string indicating a pair of algorithms (MD5 (default), or MD5-sess) used
* to produce the digest and a checksum.
* @param username_value username_value (see rfc2617)
* @param realm_value A string that has been displayed to the user in order to determine the
* context of the username and password to use.
* @param passwd the password to encode in the challenge response.
* @param nonce_value A server-specified data string provided in the challenge.
* @param cnonce_value an optional client-chosen value whose purpose is to foil chosen
* plaintext attacks.
* @param method the SIP method of the request being challenged.
* @param digest_uri_value the value of the "uri" directive on the Authorization header in the
* request.
* @param entity_body the entity-body
* @param qop_value Indicates what "quality of protection" the client has applied to the
* message.
* @param nc_value the hexadecimal count of the number of requests (including the current
* request) that the client has sent with the nonce value in this request.
* @return a digest response as defined in rfc2617
* @throws NullPointerException in case of incorrectly null parameters.
*/
static String calculateResponse(String algorithm, String username_value, String realm_value,
String passwd, String nonce_value, String nc_value, String cnonce_value,
String method, String digest_uri_value, String entity_body, String qop_value,
StackLogger stackLogger) {
if (stackLogger.isLoggingEnabled()) {
stackLogger.logDebug("trying to authenticate using : " + algorithm + ", "
+ username_value + ", " + realm_value + ", "
+ (passwd != null && passwd.trim().length() > 0) + ", " + nonce_value + ", "
+ nc_value + ", " + cnonce_value + ", " + method + ", " + digest_uri_value
+ ", " + entity_body + ", " + qop_value);
}
if (username_value == null || realm_value == null || passwd == null || method == null
|| digest_uri_value == null || nonce_value == null)
throw new NullPointerException(
"Null parameter to MessageDigestAlgorithm.calculateResponse()");
// The following follows closely the algorithm for generating a response
// digest as specified by rfc2617
String A1 = null;
if (algorithm == null || algorithm.trim().length() == 0
|| algorithm.trim().equalsIgnoreCase("MD5")) {
A1 = username_value + ":" + realm_value + ":" + passwd;
} else {
if (cnonce_value == null || cnonce_value.length() == 0)
throw new NullPointerException(
"cnonce_value may not be absent for MD5-Sess algorithm.");
A1 = H(username_value + ":" + realm_value + ":" + passwd) + ":" + nonce_value + ":"
+ cnonce_value;
}
String A2 = null;
if (qop_value == null || qop_value.trim().length() == 0
|| qop_value.trim().equalsIgnoreCase("auth")) {
A2 = method + ":" + digest_uri_value;
} else {
if (entity_body == null)
entity_body = "";
A2 = method + ":" + digest_uri_value + ":" + H(entity_body);
}
String request_digest = null;
if (cnonce_value != null && qop_value != null && nc_value != null
&& (qop_value.equalsIgnoreCase("auth") || qop_value.equalsIgnoreCase("auth-int")))
{
request_digest = KD(H(A1), nonce_value + ":" + nc_value + ":" + cnonce_value + ":"
+ qop_value + ":" + H(A2));
} else {
request_digest = KD(H(A1), nonce_value + ":" + H(A2));
}
return request_digest;
}
/**
* Defined in rfc 2617 as H(data) = MD5(data);
*
* @param data data
* @return MD5(data)
*/
private static String H(String data) {
try {
MessageDigest digest = MessageDigest.getInstance("MD5");
return toHexString(digest.digest(data.getBytes()));
} catch (NoSuchAlgorithmException ex) {
// shouldn't happen
throw new RuntimeException("Failed to instantiate an MD5 algorithm", ex);
}
}
/**
* Defined in rfc 2617 as KD(secret, data) = H(concat(secret, ":", data))
*
* @param data data
* @param secret secret
* @return H(concat(secret, ":", data));
*/
private static String KD(String secret, String data) {
return H(secret + ":" + data);
}
// the following code was copied from the NIST-SIP instant
// messenger (its author is Olivier Deruelle). Thanks for making it public!
/**
* to hex converter
*/
private static final char[] toHex = {
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
};
/**
* Converts b[] to hex string.
*
* @param b the bte array to convert
* @return a Hex representation of b.
*/
private static String toHexString(byte b[]) {
int pos = 0;
char[] c = new char[b.length * 2];
for (int i = 0; i < b.length; i++) {
c[pos++] = toHex[(b[i] >> 4) & 0x0F];
c[pos++] = toHex[b[i] & 0x0f];
}
return new String(c);
}
}
java/gov/nist/javax/sip/clientauthutils/SecureAccountManager.java 0100644 0000000 0000000 00000001264 13513104763 024332 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
import javax.sip.ClientTransaction;
public interface SecureAccountManager {
/**
* Returns the user credentials for a given SIP Domain.
* You can implement any desired method (such as popping up a dialog for example )
* to retrieve the credentials.
*
* @param challengedTransaction - the transaction that is being challenged.
* @param realm - the realm that is being challenged for which a credential should be
* returned.
* @return -- the user credentials associated with the domain.
*/
UserCredentialHash getCredentialHash(ClientTransaction challengedTransaction, String realm);
}
java/gov/nist/javax/sip/clientauthutils/UserCredentialHash.java 0100644 0000000 0000000 00000001535 13513104763 024012 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
/**
* Interface for those clients that only supply
* hash(user:domain:password). This is more secure than simply supplying
* password because the password cannot be extracted. Implementations
* tend to prefer to store information in user accounts using such a
* hash rather than plain text passwords because it offers better security.
*
*/
public interface UserCredentialHash {
/**
* Get the user name.
*
* @return userName
*/
public String getUserName();
/**
* Get the SipDomain.
*
* @return the SIP Domain.
*/
public String getSipDomain();
/**
* Get the MD5(userName:sipdomain:password)
*
* @return the MD5 hash of userName:sipDomain:password.
*/
public String getHashUserDomainPassword();
}
java/gov/nist/javax/sip/clientauthutils/UserCredentials.java 0100644 0000000 0000000 00000001456 13513104763 023373 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.clientauthutils;
/**
* The class is used whenever user credentials for a particular realm (site
* server or service) are necessary
* @author Emil Ivov
* @author M. Ranganathan
* @version 1.0
*/
public interface UserCredentials
{
/**
* Returns the name of the user that these credentials relate to.
* @return the user name.
*/
public String getUserName();
/**
* Returns a password associated with this set of credentials.
*
* @return a password associated with this set of credentials.
*/
public String getPassword();
/**
* Returns the SIP Domain for this username password combination.
*
* @return the sip domain
*/
public String getSipDomain();
}
java/gov/nist/javax/sip/clientauthutils/package.html 0100644 0000000 0000000 00000001046 13513104763 021710 0 ustar 00 0000000 0000000
This package contains a set of utilities for client side Authentication Challenge handling. It has been
adapted from the SIP communicator project and generously dontated to the JAIN-SIP project
It is not part of the standard JAIN-SIP implementation at this point but is being considered for
addition as this is an operation that is commonly required by all SIP clients; it is hence a good capability
to include in a library such as JAIN-SIP.
Primary authors of this code are Emil Ivov with corrections from Jeroen van Bemmel.
java/gov/nist/javax/sip/header/ 0040755 0000000 0000000 00000000000 13513104763 015440 5 ustar 00 0000000 0000000 java/gov/nist/javax/sip/header/Accept.java 0100644 0000000 0000000 00000012512 13513104763 017500 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.InvalidArgumentException;
/**
* Accept header : The top level header is actually AcceptList which is a list of
* Accept headers.
*
* @version 1.2 $Revision: 1.9 $ $Date: 2009/07/17 18:57:24 $
*
* @since 1.1
*
* @author M. Ranganathan
*
*
*
*/
public final class Accept
extends ParametersHeader
implements javax.sip.header.AcceptHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -7866187924308658151L;
/** mediaRange field
*/
protected MediaRange mediaRange;
/** default constructor
*/
public Accept() {
super(NAME);
}
/** returns true if this header allows all ContentTypes,
* false otherwise.
* @return Boolean
*/
public boolean allowsAllContentTypes() {
if (mediaRange == null)
return false;
else
return mediaRange.type.compareTo(STAR) == 0;
}
/**
* returns true if this header allows all ContentSubTypes,
* false otherwise.
* @return boolean
*/
public boolean allowsAllContentSubTypes() {
if (mediaRange == null) {
return false;
} else
return mediaRange.getSubtype().compareTo(STAR) == 0;
}
/** Encode the value of this header into cannonical form.
*@return encoded value of the header as a string.
*/
protected String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (mediaRange != null)
mediaRange.encode(buffer);
if (parameters != null && !parameters.isEmpty()) {
buffer.append(';');
parameters.encode(buffer);
}
return buffer;
}
/** get the MediaRange field
* @return MediaRange
*/
public MediaRange getMediaRange() {
return mediaRange;
}
/** get the contentType field
* @return String
*/
public String getContentType() {
if (mediaRange == null)
return null;
else
return mediaRange.getType();
}
/** get the ContentSubType fiels
* @return String
*/
public String getContentSubType() {
if (mediaRange == null)
return null;
else
return mediaRange.getSubtype();
}
/**
* Get the q value.
* @return float
*/
public float getQValue() {
return getParameterAsFloat(ParameterNames.Q);
}
/**
* Return true if the q value has been set.
* @return boolean
*/
public boolean hasQValue() {
return super.hasParameter(ParameterNames.Q);
}
/**
*Remove the q value.
*/
public void removeQValue() {
super.removeParameter(ParameterNames.Q);
}
/** set the ContentSubType field
* @param subtype String to set
*/
public void setContentSubType(String subtype) {
if (mediaRange == null)
mediaRange = new MediaRange();
mediaRange.setSubtype(subtype);
}
/** set the ContentType field
* @param type String to set
*/
public void setContentType(String type) {
if (mediaRange == null)
mediaRange = new MediaRange();
mediaRange.setType(type);
}
/**
* Set the q value
* @param qValue float to set
* @throws IllegalArgumentException if qValue is <0.0 or >1.0
*/
public void setQValue(float qValue) throws InvalidArgumentException {
if (qValue == -1)
super.removeParameter(ParameterNames.Q);
super.setParameter(ParameterNames.Q, qValue);
}
/**
* Set the mediaRange member
* @param m MediaRange field
*/
public void setMediaRange(MediaRange m) {
mediaRange = m;
}
public Object clone() {
Accept retval = (Accept) super.clone();
if (this.mediaRange != null)
retval.mediaRange = (MediaRange) this.mediaRange.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/AcceptEncoding.java 0100644 0000000 0000000 00000010575 13513104763 021156 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.InvalidArgumentException;
import javax.sip.header.*;
import java.text.ParseException;
/**
* Accept-Encoding SIP (HTTP) Header.
*
* @author M. Ranganathan
* @author Olivier Deruelle
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:24 $
* @since 1.1
*
*
* From HTTP RFC 2616
*
*
* The Accept-Encoding request-header field is similar to Accept, but
* restricts the content-codings (section 3.5) that are acceptable in
* the response.
*
*
* Accept-Encoding = "Accept-Encoding" ":"
*
*
* 1#( codings [ ";" "q" "=" qvalue ] )
* codings = ( content-coding | "*" )
*
* Examples of its use are:
*
* Accept-Encoding: compress, gzip
* Accept-Encoding:
* Accept-Encoding: *
* Accept-Encoding: compress;q=0.5, gzip;q=1.0
* Accept-Encoding: gzip;q=1.0, identity; q=0.5, *;q=0
*
*
*/
public final class AcceptEncoding extends ParametersHeader implements
AcceptEncodingHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -1476807565552873525L;
/**
* contentEncoding field
*/
protected String contentCoding;
/**
* default constructor
*/
public AcceptEncoding() {
super(NAME);
}
/**
* Encode the value of this header.
*
* @return the value of this header encoded into a string.
*/
protected String encodeBody() {
return encode(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (contentCoding != null) {
buffer.append(contentCoding);
}
if (parameters != null && !parameters.isEmpty()) {
buffer.append(SEMICOLON).append(parameters.encode());
}
return buffer;
}
/**
* get QValue field
*
* @return float
*/
public float getQValue() {
return getParameterAsFloat("q");
}
/**
* get ContentEncoding field
*
* @return String
*/
public String getEncoding() {
return contentCoding;
}
/**
* Set the qvalue member
*
* @param q
* double to set
*/
public void setQValue(float q) throws InvalidArgumentException {
if (q < 0.0 || q > 1.0)
throw new InvalidArgumentException("qvalue out of range!");
super.setParameter("q", q);
}
/**
* Sets the encoding of an EncodingHeader.
*
* @param encoding -
* the new string value defining the encoding.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the encoding value.
*/
public void setEncoding(String encoding) throws ParseException {
if (encoding == null)
throw new NullPointerException(" encoding parameter is null");
contentCoding = encoding;
}
}
java/gov/nist/javax/sip/header/AcceptEncodingList.java 0100644 0000000 0000000 00000003576 13513104763 022015 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* AcceptEncodingList of AccepEncoding headers.
*
*@author M. Ranganathan
*@version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:25 $
*@since 1.1
*
*
*/
public class AcceptEncodingList extends SIPHeaderList{
@Override
public Object clone() {
AcceptEncodingList retval = new AcceptEncodingList();
retval.clonehlist(this.hlist);
return retval;
}
/** default constructor
*/
public AcceptEncodingList() {
super(AcceptEncoding.class, AcceptEncodingHeader.NAME);
}
}
java/gov/nist/javax/sip/header/AcceptLanguage.java 0100644 0000000 0000000 00000013101 13513104763 021137 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/****************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
****************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
import javax.sip.header.AcceptLanguageHeader;
import javax.sip.InvalidArgumentException;
import java.util.Locale;
/**
* Accept Language body.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.8 $ $Date: 2009/10/18 13:46:32 $
* @since 1.1
*
*
*
* HTTP RFC 2616 Section 14.4
* Accept-Language = "Accept-Language" ":"
* 1#( language-range [ ";" "q" "=" qvalue ] )
* language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) | "*" )
*
*
*
* @see AcceptLanguageList
*/
public final class AcceptLanguage
extends ParametersHeader
implements AcceptLanguageHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -4473982069737324919L;
/** languageRange field
*/
protected String languageRange;
/** default constructor
*/
public AcceptLanguage() {
super(NAME);
}
/** Encode the value of this header to a string.
*@return encoded header as a string.
*/
protected String encodeBody() {
StringBuffer encoding = new StringBuffer();
if (languageRange != null) {
encoding.append(languageRange);
}
if (!parameters.isEmpty()) {
encoding.append(SEMICOLON).append(parameters.encode());
}
return encoding.toString();
}
/** get the LanguageRange field
* @return String
*/
public String getLanguageRange() {
return languageRange;
}
/** get the QValue field. Return -1 if the parameter has not been
* set.
* @return float
*/
public float getQValue() {
if (!hasParameter("q"))
return -1;
return ((Float) parameters.getValue("q")).floatValue();
}
/**
* Return true if the q value has been set.
* @since 1.0
* @return boolean
*/
public boolean hasQValue() {
return hasParameter("q");
}
/**
* Remove the q value.
* @since 1.0
*/
public void removeQValue() {
removeParameter("q");
}
/**
* Set the languageRange.
*
* @param languageRange is the language range to set.
*
*/
public void setLanguageRange(String languageRange) {
this.languageRange = languageRange.trim();
}
/**
* Sets q-value for media-range in AcceptLanguageHeader. Q-values allow the
*
* user to indicate the relative degree of preference for that media-range,
*
* using the qvalue scale from 0 to 1. If no q-value is present, the
*
* media-range should be treated as having a q-value of 1.
*
*
*
* @param q The new float value of the q-value, a value of -1 resets
* the qValue.
*
* @throws InvalidArgumentException if the q parameter value is not
*
* -1 or between 0 and 1.
*
*/
public void setQValue(float q) throws InvalidArgumentException {
if (q < 0.0 || q > 1.0)
throw new InvalidArgumentException("qvalue out of range!");
if (q == -1)
this.removeParameter("q");
else
this.setParameter(new NameValue("q", Float.valueOf(q)));
}
/**
* Gets the language value of the AcceptLanguageHeader.
*
*
*
* @return the language Locale value of this AcceptLanguageHeader
*
*/
public Locale getAcceptLanguage() {
if (this.languageRange == null)
return null;
else {
int dash = languageRange.indexOf('-');
if (dash>=0) {
return new Locale( languageRange.substring(0,dash), languageRange.substring(dash+1) );
} else return new Locale( this.languageRange );
}
}
/**
* Sets the language parameter of this AcceptLanguageHeader.
*
*
*
* @param language - the new Locale value of the language of
*
* AcceptLanguageHeader
*
*
*/
public void setAcceptLanguage(Locale language) {
// JvB: need to take sub-tag into account
if ( "".equals(language.getCountry())) {
this.languageRange = language.getLanguage();
} else {
this.languageRange = language.getLanguage() + '-' + language.getCountry();
}
}
}
java/gov/nist/javax/sip/header/AcceptLanguageList.java 0100644 0000000 0000000 00000004575 13513104763 022012 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* AcceptLanguageList: Strings together a list of AcceptLanguage SIPHeaders.
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:25 $
* @since 1.1
*
*
*/
public class AcceptLanguageList extends SIPHeaderList {
private static final long serialVersionUID = -3289606805203488840L;
@Override
public Object clone() {
AcceptLanguageList retval = new AcceptLanguageList();
retval.clonehlist(this.hlist);
return retval;
}
public AcceptLanguageList() {
super(AcceptLanguage.class, AcceptLanguageHeader.NAME);
}
public AcceptLanguage getFirst() {
AcceptLanguage retval = (AcceptLanguage) super.getFirst();
if (retval != null)
return retval;
else
return new AcceptLanguage();
}
public AcceptLanguage getLast() {
AcceptLanguage retval = (AcceptLanguage) super.getLast();
if (retval != null)
return retval;
else
return new AcceptLanguage();
}
}
java/gov/nist/javax/sip/header/AcceptList.java 0100644 0000000 0000000 00000003736 13513104763 020344 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* Accept List of SIP headers.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:25 $
*
* @since 1.1
*
* @see Accept
*/
public class AcceptList extends SIPHeaderList {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -1800813338560484831L;
@Override
public Object clone() {
AcceptList retval = new AcceptList();
retval.clonehlist(this.hlist);
return retval;
}
/**
* Default constructor
*/
public AcceptList() {
super(Accept.class, AcceptHeader.NAME);
}
}
java/gov/nist/javax/sip/header/AddressParameters.java 0100644 0000000 0000000 00000001135 13513104763 021711 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header;
import java.util.Map;
import java.util.Map.Entry;
import javax.sip.address.Address;
import javax.sip.header.Parameters;
public interface AddressParameters extends Parameters {
/**
* get the Address field
* @return the imbedded Address
*/
public abstract Address getAddress();
/**
* set the Address field
* @param address Address to set
*/
public abstract void setAddress(Address address);
/**
* Get the parameters map.
*
*/
public abstract Map> getParameters();
}
java/gov/nist/javax/sip/header/AddressParametersHeader.java 0100644 0000000 0000000 00000006115 13513104763 023025 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
package gov.nist.javax.sip.header;
import javax.sip.address.*;
import javax.sip.header.FromHeader;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
import gov.nist.javax.sip.address.*;
/** An abstract class for headers that take an address and parameters.
*
* @version 1.2 $Revision: 1.11 $ $Date: 2009/07/17 18:57:25 $
*
* @since 1.1
*
* @author M. Ranganathan
*
*
*
*
*/
public abstract class AddressParametersHeader extends ParametersHeader implements Parameters {
protected AddressImpl address;
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AddressParameters#getAddress()
*/
public Address getAddress() {
return address;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AddressParameters#setAddress(javax.sip.address.Address)
*/
public void setAddress(Address address) {
this.address = (AddressImpl) address;
}
/**
* Constructor given the name of the header.
*/
protected AddressParametersHeader(String name) {
super(name);
}
/**
* Constructor given a synch flag.
*
* @param name
* @param sync
*/
protected AddressParametersHeader(String name, boolean sync) {
super(name,sync);
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AddressParameters#clone()
*/
public Object clone() {
AddressParametersHeader retval = (AddressParametersHeader) super.clone();
if (this.address != null)
retval.address = (AddressImpl) this.address.clone();
return retval;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AddressParameters#equals(java.lang.Object)
*/
public boolean equals(Object other) {
if (this==other) return true;
if (other instanceof HeaderAddress && other instanceof Parameters) {
final HeaderAddress o = (HeaderAddress) other;
return this.getAddress().equals( o.getAddress() ) && this.equalParameters( (Parameters) o );
}
return false;
}
}
java/gov/nist/javax/sip/header/AlertInfo.java 0100644 0000000 0000000 00000007206 13513104763 020170 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD) *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
import gov.nist.javax.sip.address.*;
import javax.sip.address.*;
/**
* AlertInfo SIP Header.
*
* @author M. Ranganathan
*
* @since 1.1
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:25 $
*
*
*/
public final class AlertInfo
extends ParametersHeader
implements javax.sip.header.AlertInfoHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 4159657362051508719L;
/** URI field
*/
protected GenericURI uri;
/** String field
*/
protected String string;
/** Constructor
*/
public AlertInfo() {
super(NAME);
}
/**
* Return value encoding in canonical form.
* @return The value of the header in canonical encoding.
*/
protected String encodeBody() {
StringBuffer encoding = new StringBuffer();
if (uri != null) {
encoding.append(LESS_THAN).append(uri.encode()).append(GREATER_THAN);
} else if (string != null) {
encoding.append(string);
}
if (!parameters.isEmpty()) {
encoding.append(SEMICOLON).append(parameters.encode());
}
return encoding.toString();
}
/**
* Set the uri member
* @param uri URI to set
*/
public void setAlertInfo(URI uri) {
this.uri = (GenericURI) uri;
}
/**
* Set the string member
* @param string String to set
*/
public void setAlertInfo(String string) {
this.string = string;
}
/**
* Returns the AlertInfo value of this AlertInfoHeader.
* @return the URI representing the AlertInfo.
*/
public URI getAlertInfo() {
URI alertInfoUri = null;
if (this.uri != null) {
alertInfoUri = (URI) this.uri;
} else {
try {
alertInfoUri = (URI) new GenericURI(string);
} catch (ParseException e) {
; // Eat the exception.
}
}
return alertInfoUri;
}
public Object clone() {
AlertInfo retval = (AlertInfo) super.clone();
if (this.uri != null) {
retval.uri = (GenericURI) this.uri.clone();
} else if (this.string != null) {
retval.string = this.string;
}
return retval;
}
}
java/gov/nist/javax/sip/header/AlertInfoList.java 0100644 0000000 0000000 00000003527 13513104763 021026 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* AlertInfo SIPHeader - there can be several AlertInfo headers.
*
*@author M. Ranganathan
*
*
*
*/
public class AlertInfoList extends SIPHeaderList {
private static final long serialVersionUID = 1L;
public Object clone() {
AlertInfoList retval = new AlertInfoList();
retval.clonehlist(this.hlist);
return retval;
}
/** default constructor
*/
public AlertInfoList() {
super( AlertInfo.class,AlertInfoHeader.NAME);
}
}
java/gov/nist/javax/sip/header/Allow.java 0100644 0000000 0000000 00000005165 13513104763 017365 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
/**
* Allow SIPHeader.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:26 $
* @since 1.1
*
*
*/
public final class Allow extends
SIPHeader implements javax.sip.header.AllowHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3105079479020693930L;
/** method field
*/
protected String method;
/** default constructor
*/
public Allow() {
super(ALLOW);
}
/** constructor
* @param m String to set
*/
public Allow(String m) {
super(ALLOW);
method = m;
}
/** get the method field
* @return String
*/
public String getMethod() {
return method;
}
/**
* Set the method member
* @param method method to set.
*/
public void setMethod(String method) throws ParseException {
if (method == null)
throw new NullPointerException(
"JAIN-SIP Exception"
+ ", Allow, setMethod(), the method parameter is null.");
this.method = method;
}
/** Return body encoded in canonical form.
* @return body encoded as a string.
*/
protected String encodeBody() {
return method;
}
}
java/gov/nist/javax/sip/header/AllowEvents.java 0100644 0000000 0000000 00000006151 13513104763 020546 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
/**
* AllowEvents SIPHeader.
*
* @author M. Ranganathan NIST/ITL ANTD.
* @author Olivier Deruelle
*
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:26 $
* @since 1.1
*/
public final class AllowEvents
extends SIPHeader
implements javax.sip.header.AllowEventsHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 617962431813193114L;
/** method field
*/
protected String eventType;
/** default constructor
*/
public AllowEvents() {
super(ALLOW_EVENTS);
}
/** constructor
* @param m String to set
*/
public AllowEvents(String m) {
super(ALLOW_EVENTS);
eventType = m;
}
/**
* Sets the eventType defined in this AllowEventsHeader.
*
* @param eventType - the String defining the method supported
* in this AllowEventsHeader
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the Strings defining the eventType supported
*/
public void setEventType(String eventType) throws ParseException {
if (eventType == null)
throw new NullPointerException(
"JAIN-SIP Exception,"
+ "AllowEvents, setEventType(), the eventType parameter is null");
this.eventType = eventType;
}
/**
* Gets the eventType of the AllowEventsHeader.
*
* @return the String object identifing the eventTypes of AllowEventsHeader.
*/
public String getEventType() {
return eventType;
}
/** Return body encoded in canonical form.
* @return body encoded as a string.
*/
protected String encodeBody() {
return eventType;
}
}
java/gov/nist/javax/sip/header/AllowEventsList.java 0100644 0000000 0000000 00000006752 13513104763 021411 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.*;
import java.text.ParseException;
import javax.sip.header.*;
/**
* List of AllowEvents headers.
* The sip message can have multiple AllowEvents headers which are strung
* together in a list.
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:26 $
* @since 1.1
*
*/
public class AllowEventsList extends SIPHeaderList {
private static final long serialVersionUID = -684763195336212992L;
public Object clone() {
AllowEventsList retval = new AllowEventsList();
retval.clonehlist(this.hlist);
return retval;
}
/** default constructor
*/
public AllowEventsList() {
super(AllowEvents.class, AllowEventsHeader.NAME);
}
/**
* Gets an Iterator of all the methods of the AllowEventsHeader. Returns an empty
*
* Iterator if no methods are defined in this AllowEvents Header.
*
*
*
* @return Iterator of String objects each identifing the methods of
*
* AllowEventsHeader.
*
*
*/
public ListIterator getMethods() {
ListIterator li = super.hlist.listIterator();
LinkedList ll = new LinkedList ();
while (li.hasNext()) {
AllowEvents allowEvents = (AllowEvents) li.next();
ll.add(allowEvents.getEventType());
}
return ll.listIterator();
}
/**
* Sets the methods supported defined by this AllowEventsHeader.
*
*
*
* @param methods - the Iterator of Strings defining the methods supported
*
* in this AllowEventsHeader
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the Strings defining the methods supported.
*
*
*/
public void setMethods(List methods) throws ParseException {
ListIterator it = methods.listIterator();
while (it.hasNext()) {
AllowEvents allowEvents = new AllowEvents();
allowEvents.setEventType((String) it.next());
this.add(allowEvents);
}
}
}
java/gov/nist/javax/sip/header/AllowList.java 0100644 0000000 0000000 00000006454 13513104763 020223 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.*;
import java.text.ParseException;
import javax.sip.header.*;
/**
* List of ALLOW headers. The sip message can have multiple Allow headers
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:26 $
* @since 1.1
*
*/
public class AllowList extends SIPHeaderList {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -4699795429662562358L;
public Object clone() {
AllowList retval = new AllowList();
retval.clonehlist(this.hlist);
return retval;
}
/** default constructor
*/
public AllowList() {
super(Allow.class, AllowHeader.NAME);
}
/**
* Gets an Iterator of all the methods of the AllowHeader. Returns an empty
*
* Iterator if no methods are defined in this Allow Header.
*
*
*
* @return Iterator of String objects each identifing the methods of
*
* AllowHeader.
*
*
*/
public ListIterator getMethods() {
LinkedList ll = new LinkedList ();
for ( Iterator it = this.hlist.iterator(); it.hasNext();) {
Allow a = (Allow)it.next();
ll.add(a.getMethod());
}
return ll.listIterator();
}
/**
* Sets the methods supported defined by this AllowHeader.
*
*
*
* @param methods - the Iterator of Strings defining the methods supported
*
* in this AllowHeader
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the Strings defining the methods supported.
*
*
*/
public void setMethods(List methods) throws ParseException {
ListIterator it = methods.listIterator();
while (it.hasNext()) {
Allow allow = new Allow();
allow.setMethod((String) it.next());
this.add(allow);
}
}
}
java/gov/nist/javax/sip/header/AuthenticationHeader.java 0100644 0000000 0000000 00000043256 13513104763 022402 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*****************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
import gov.nist.javax.sip.header.ims.ParameterNamesIms;
import java.text.ParseException;
/*
* 2005/06/12: geir.hedemark@telio.no: Changed behaviour of qop parameter in
* Authorization header - removed quoting of string according to
* RFC3261, BNF element "message-qop" (as opposed to "qop-options",
* which is quoted.
*/
/**
* The generic AuthenticationHeader
*
* @author Olivier Deruelle
* @author M. Ranganathan
* @since 1.1
* @version 1.2 $Revision: 1.13 $ $Date: 2009/10/18 13:46:32 $
*
*
*/
public abstract class AuthenticationHeader extends ParametersHeader {
public static final String DOMAIN = ParameterNames.DOMAIN;
public static final String REALM = ParameterNames.REALM;
public static final String OPAQUE = ParameterNames.OPAQUE;
public static final String ALGORITHM = ParameterNames.ALGORITHM;
public static final String QOP = ParameterNames.QOP;
public static final String STALE = ParameterNames.STALE;
public static final String SIGNATURE = ParameterNames.SIGNATURE;
public static final String RESPONSE = ParameterNames.RESPONSE;
public static final String SIGNED_BY = ParameterNames.SIGNED_BY;
public static final String NC = ParameterNames.NC;
public static final String URI = ParameterNames.URI;
public static final String USERNAME = ParameterNames.USERNAME;
public static final String CNONCE = ParameterNames.CNONCE;
public static final String NONCE = ParameterNames.NONCE;
public static final String IK = ParameterNamesIms.IK;
public static final String CK = ParameterNamesIms.CK;
public static final String INTEGRITY_PROTECTED = ParameterNamesIms.INTEGRITY_PROTECTED;
protected String scheme;
public AuthenticationHeader(String name) {
super(name);
parameters.setSeparator(Separators.COMMA); // oddball
this.scheme = ParameterNames.DIGEST;
}
public AuthenticationHeader() {
super();
parameters.setSeparator(Separators.COMMA);
}
/**
* set the specified parameter. Bug reported by Dominic Sparks.
*
* @param name --
* name of the parameter
* @param value --
* value of the parameter.
*/
public void setParameter(String name, String value) throws ParseException {
NameValue nv = super.parameters.getNameValue(name.toLowerCase());
if (nv == null) {
nv = new NameValue(name, value);
if (name.equalsIgnoreCase(ParameterNames.QOP)
|| name.equalsIgnoreCase(ParameterNames.REALM)
|| name.equalsIgnoreCase(ParameterNames.CNONCE)
|| name.equalsIgnoreCase(ParameterNames.NONCE)
|| name.equalsIgnoreCase(ParameterNames.USERNAME)
|| name.equalsIgnoreCase(ParameterNames.DOMAIN)
|| name.equalsIgnoreCase(ParameterNames.OPAQUE)
|| name.equalsIgnoreCase(ParameterNames.NEXT_NONCE)
|| name.equalsIgnoreCase(ParameterNames.URI)
|| name.equalsIgnoreCase(ParameterNames.RESPONSE )
||name.equalsIgnoreCase(ParameterNamesIms.IK)
|| name.equalsIgnoreCase(ParameterNamesIms.CK)
|| name.equalsIgnoreCase(ParameterNamesIms.INTEGRITY_PROTECTED)) {
if (((this instanceof Authorization) || (this instanceof ProxyAuthorization))
&& name.equalsIgnoreCase(ParameterNames.QOP)) {
// NOP, QOP not quoted in authorization headers
} else {
nv.setQuotedValue();
}
if (value == null)
throw new NullPointerException("null value");
if (value.startsWith(Separators.DOUBLE_QUOTE))
throw new ParseException(value
+ " : Unexpected DOUBLE_QUOTE", 0);
}
super.setParameter(nv);
} else
nv.setValueAsObject(value);
}
/**
* This is only used for the parser interface.
*
* @param challenge --
* the challenge from which the parameters are extracted.
*/
public void setChallenge(Challenge challenge) {
this.scheme = challenge.scheme;
super.parameters = challenge.authParams;
}
/**
* Encode in canonical form.
*
* @return canonical string.
*/
public String encodeBody() {
this.parameters.setSeparator(Separators.COMMA);
return this.scheme + SP + parameters.encode();
}
/**
* Sets the scheme of the challenge information for this
* AuthenticationHeaderHeader. For example, Digest.
*
* @param scheme -
* the new string value that identifies the challenge information
* scheme.
*/
public void setScheme(String scheme) {
this.scheme = scheme;
}
/**
* Returns the scheme of the challenge information for this
* AuthenticationHeaderHeader.
*
* @return the string value of the challenge information.
*/
public String getScheme() {
return scheme;
}
/**
* Sets the Realm of the WWWAuthenicateHeader to the realm
* parameter value. Realm strings MUST be globally unique. It is RECOMMENDED
* that a realm string contain a hostname or domain name. Realm strings
* SHOULD present a human-readable identifier that can be rendered to a
* user.
*
* @param realm
* the new Realm String of this WWWAuthenicateHeader.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the realm.
*/
public void setRealm(String realm) throws ParseException {
if (realm == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " AuthenticationHeader, setRealm(), The realm parameter is null");
setParameter(ParameterNames.REALM, realm);
}
/**
* Returns the Realm value of this WWWAuthenicateHeader. This convenience
* method returns only the realm of the complete Challenge.
*
* @return the String representing the Realm information, null if value is
* not set.
* @since v1.1
*/
public String getRealm() {
return getParameter(ParameterNames.REALM);
}
/**
* Sets the Nonce of the WWWAuthenicateHeader to the nonce
* parameter value.
*
* @param nonce -
* the new nonce String of this WWWAuthenicateHeader.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the nonce value.
* @since v1.1
*/
public void setNonce(String nonce) throws ParseException {
if (nonce == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " AuthenticationHeader, setNonce(), The nonce parameter is null");
setParameter(NONCE, nonce);
}
/**
* Returns the Nonce value of this WWWAuthenicateHeader.
*
* @return the String representing the nonce information, null if value is
* not set.
* @since v1.1
*/
public String getNonce() {
return getParameter(ParameterNames.NONCE);
}
/**
* Sets the URI of the WWWAuthenicateHeader to the uri parameter
* value.
*
* @param uri -
* the new URI of this AuthenicationHeader.
* @since v1.1
*
* Note that since 1.2 this is no longer applicable to the WWW-Authenticate
* and Proxy-Authenticate headers
*/
public void setURI(javax.sip.address.URI uri) {
if (uri != null) {
NameValue nv = new NameValue(ParameterNames.URI, uri);
nv.setQuotedValue();
super.parameters.set(nv);
} else {
throw new NullPointerException("Null URI");
}
}
/**
* Returns the URI value of this WWWAuthenicateHeader, for example
* DigestURI.
*
* @return the URI representing the URI information, null if value is not
* set.
* @since v1.1
*
* Note that since 1.2 this is no longer applicable to the WWW-Authenticate
* and Proxy-Authenticate headers
*/
public javax.sip.address.URI getURI() {
return getParameterAsURI(ParameterNames.URI);
}
/**
* Sets the Algorithm of the WWWAuthenicateHeader to the new algorithm
* parameter value.
*
* @param algorithm -
* the new algorithm String of this WWWAuthenicateHeader.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the algorithm value.
* @since v1.1
*/
public void setAlgorithm(String algorithm) throws ParseException {
if (algorithm == null)
throw new NullPointerException("null arg");
setParameter(ParameterNames.ALGORITHM, algorithm);
}
/**
* Returns the Algorithm value of this WWWAuthenicateHeader.
*
* @return the String representing the Algorithm information, null if the
* value is not set.
* @since v1.1
*/
public String getAlgorithm() {
return getParameter(ParameterNames.ALGORITHM);
}
/**
* Sets the Qop value of the WWWAuthenicateHeader to the new qop
* parameter value.
*
* @param qop -
* the new Qop string of this WWWAuthenicateHeader.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the Qop value.
* @since v1.1
*/
public void setQop(String qop) throws ParseException {
if (qop == null)
throw new NullPointerException("null arg");
setParameter(ParameterNames.QOP, qop);
}
/**
* Returns the Qop value of this WWWAuthenicateHeader.
*
* @return the string representing the Qop information, null if the value is
* not set.
* @since v1.1
*/
public String getQop() {
return getParameter(ParameterNames.QOP);
}
/**
* Sets the Opaque value of the WWWAuthenicateHeader to the new opaque
* parameter value.
*
* @param opaque -
* the new Opaque string of this WWWAuthenicateHeader.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the opaque value.
* @since v1.1
*/
public void setOpaque(String opaque) throws ParseException {
if (opaque == null)
throw new NullPointerException("null arg");
setParameter(ParameterNames.OPAQUE, opaque);
}
/**
* Returns the Opaque value of this WWWAuthenicateHeader.
*
* @return the String representing the Opaque information, null if the value
* is not set.
* @since v1.1
*/
public String getOpaque() {
return getParameter(ParameterNames.OPAQUE);
}
/**
* Sets the Domain of the WWWAuthenicateHeader to the domain
* parameter value.
*
* @param domain -
* the new Domain string of this WWWAuthenicateHeader.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the domain.
* @since v1.1
*/
public void setDomain(String domain) throws ParseException {
if (domain == null)
throw new NullPointerException("null arg");
setParameter(ParameterNames.DOMAIN, domain);
}
/**
* Returns the Domain value of this WWWAuthenicateHeader.
*
* @return the String representing the Domain information, null if value is
* not set.
* @since v1.1
*/
public String getDomain() {
return getParameter(ParameterNames.DOMAIN);
}
/**
* Sets the value of the stale parameter of the WWWAuthenicateHeader to the
* stale parameter value.
*
* @param stale -
* the Boolean.valueOf value of the stale parameter.
* @since v1.1
*/
public void setStale(boolean stale) {
setParameter(new NameValue(ParameterNames.STALE, Boolean.valueOf(stale)));
}
/**
* Returns the boolean value of the state paramater of this
* WWWAuthenicateHeader.
*
* @return the boolean representing if the challenge is stale.
* @since v1.1
*/
public boolean isStale() {
return this.getParameterAsBoolean(ParameterNames.STALE);
}
/**
* Set the CNonce.
*
* @param cnonce --
* a nonce string.
*/
public void setCNonce(String cnonce) throws ParseException {
this.setParameter(ParameterNames.CNONCE, cnonce);
}
/**
* Get the CNonce.
*
* @return the cnonce value.
*/
public String getCNonce() {
return getParameter(ParameterNames.CNONCE);
}
public int getNonceCount() {
return this.getParameterAsHexInt(ParameterNames.NC);
}
/**
* Set the nonce count pakrameter. Bug fix sent in by Andreas Bystr�m
*/
public void setNonceCount(int param) throws java.text.ParseException {
if (param < 0)
throw new ParseException("bad value", 0);
String nc = Integer.toHexString(param);
String base = "00000000";
nc = base.substring(0, 8 - nc.length()) + nc;
this.setParameter(ParameterNames.NC, nc);
}
/**
* Get the RESPONSE value (or null if it does not exist).
*
* @return String response parameter value.
*/
public String getResponse() {
return (String) getParameterValue(ParameterNames.RESPONSE);
}
/**
* Set the Response.
*
* @param response
* to set.
*/
public void setResponse(String response) throws ParseException {
if (response == null)
throw new NullPointerException("Null parameter");
// Bug fix from Andreas Bystr�m
this.setParameter(RESPONSE, response);
}
/**
* Returns the Username value of this AuthorizationHeader. This convenience
* method returns only the username of the complete Response.
*
* @return the String representing the Username information, null if value
* is not set.
*
*
*
*/
public String getUsername() {
return (String) getParameter(ParameterNames.USERNAME);
}
/**
* Sets the Username of the AuthorizationHeader to the username
* parameter value.
*
* @param username
* the new Username String of this AuthorizationHeader.
*
* @throws ParseException
* which signals that an error has been reached
*
* unexpectedly while parsing the username.
*
*
*
*/
public void setUsername(String username) throws ParseException {
this.setParameter(ParameterNames.USERNAME, username);
}
public void setIK(String ik) throws ParseException {
if (ik == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " AuthenticationHeader, setIk(), The auth-param IK parameter is null");
setParameter(IK, ik);
}
public String getIK() {
return getParameter(ParameterNamesIms.IK);
}
public void setCK(String ck) throws ParseException {
if (ck == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " AuthenticationHeader, setCk(), The auth-param CK parameter is null");
setParameter(CK, ck);
}
public String getCK() {
return getParameter(ParameterNamesIms.CK);
}
public void setIntegrityProtected(String integrityProtected) throws ParseException
{
if (integrityProtected == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " AuthenticationHeader, setIntegrityProtected(), The integrity-protected parameter is null");
setParameter(INTEGRITY_PROTECTED, integrityProtected);
}
public String getIntegrityProtected() {
return getParameter(ParameterNamesIms.INTEGRITY_PROTECTED);
}
}
java/gov/nist/javax/sip/header/AuthenticationInfo.java 0100644 0000000 0000000 00000017606 13513104763 022105 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
import java.text.ParseException;
/**
* Authentication info SIP Header.
*
* @author M. Ranganathan NIST/ITL/ANTD
* @since 1.1
* @version 1.2 $Revision: 1.9 $ $Date: 2009/07/17 18:57:27 $
*
*
*/
public final class AuthenticationInfo
extends ParametersHeader
implements javax.sip.header.AuthenticationInfoHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -4371927900917127057L;
/** Default contstructor.
*/
public AuthenticationInfo() {
super(NAME);
parameters.setSeparator(COMMA); // Odd ball.
}
public void add(NameValue nv) {
parameters.set(nv);
}
/** Value of header encoded in canonical form.
*/
protected String encodeBody() {
return parameters.encode();
}
/** Get the name value pair for a given authentication info parameter.
*
*@param name is the name for which we want to retrieve the name value
* list.
*/
public NameValue getAuthInfo(String name) {
return parameters.getNameValue(name);
}
/**
* Returns the AuthenticationInfo value of this AuthenticationInfoHeader.
*
*
*
* @return the String representing the AuthenticationInfo
*
*
*
*/
public String getAuthenticationInfo() {
return this.encodeBody();
}
/** Returns the CNonce value of this AuthenticationInfoHeader.
*
* @return the String representing the cNonce information, null if value is
* not set.
* @since v1.1
*/
public String getCNonce() {
return this.getParameter(ParameterNames.CNONCE);
}
/** Returns the nextNonce value of this AuthenticationInfoHeader.
*
* @return the String representing the nextNonce
* information, null if value is not set.
* @since v1.1
*/
public String getNextNonce() {
return this.getParameter(ParameterNames.NEXT_NONCE);
}
/** Returns the Nonce Count value of this AuthenticationInfoHeader.
*
* @return the integer representing the nonceCount information, -1 if value is
* not set.
* @since v1.1
*/
public int getNonceCount() {
return this.getParameterAsInt(ParameterNames.NONCE_COUNT);
}
/** Returns the messageQop value of this AuthenticationInfoHeader.
*
* @return the string representing the messageQop information, null if the
* value is not set.
* @since v1.1
*/
public String getQop() {
return this.getParameter(ParameterNames.QOP);
}
/** Returns the Response value of this AuthenticationInfoHeader.
*
* @return the String representing the Response information.
* @since v1.1
*/
public String getResponse() {
return this.getParameter(ParameterNames.RESPONSE_AUTH);
}
/** Sets the CNonce of the AuthenticationInfoHeader to the cNonce
* parameter value.
*
* @param cNonce - the new cNonce String of this AuthenticationInfoHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the cNonce value.
* @since v1.1
*/
public void setCNonce(String cNonce) throws ParseException {
this.setParameter(ParameterNames.CNONCE, cNonce);
}
/** Sets the NextNonce of the AuthenticationInfoHeader to the nextNonce
* parameter value.
*
* @param nextNonce - the new nextNonce String of this AuthenticationInfoHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the nextNonce value.
* @since v1.1
*/
public void setNextNonce(String nextNonce) throws ParseException {
this.setParameter(ParameterNames.NEXT_NONCE, nextNonce);
}
/** Sets the Nonce Count of the AuthenticationInfoHeader to the nonceCount
* parameter value.
*
* @param nonceCount - the new nonceCount integer of this AuthenticationInfoHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the nonceCount value.
* @since v1.1
*/
public void setNonceCount(int nonceCount) throws ParseException {
if (nonceCount < 0)
throw new ParseException("bad value", 0);
String nc = Integer.toHexString(nonceCount);
String base = "00000000";
nc = base.substring(0, 8 - nc.length()) + nc;
this.setParameter(ParameterNames.NC, nc);
}
/** Sets the Qop value of the AuthenticationInfoHeader to the new
* qop parameter value.
*
* @param qop - the new Qop string of this AuthenticationInfoHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the Qop value.
* @since v1.1
*/
public void setQop(String qop) throws ParseException {
this.setParameter(ParameterNames.QOP, qop);
}
/** Sets the Response of the
* AuthenticationInfoHeader to the new response
* parameter value.
*
* @param response - the new response String of this
* AuthenticationInfoHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the Response.
* @since v1.1
*/
public void setResponse(String response) throws ParseException {
this.setParameter(ParameterNames.RESPONSE_AUTH, response);
}
public void setParameter(String name, String value) throws ParseException {
if (name == null)
throw new NullPointerException("null name");
NameValue nv = super.parameters.getNameValue(name.toLowerCase());
if (nv == null) {
nv = new NameValue(name, value);
if (name.equalsIgnoreCase(ParameterNames.QOP)
|| name.equalsIgnoreCase(ParameterNames.NEXT_NONCE)
|| name.equalsIgnoreCase(ParameterNames.REALM)
|| name.equalsIgnoreCase(ParameterNames.CNONCE)
|| name.equalsIgnoreCase(ParameterNames.NONCE)
|| name.equalsIgnoreCase(ParameterNames.OPAQUE)
|| name.equalsIgnoreCase(ParameterNames.USERNAME)
|| name.equalsIgnoreCase(ParameterNames.DOMAIN)
|| name.equalsIgnoreCase(ParameterNames.NEXT_NONCE)
|| name.equalsIgnoreCase(ParameterNames.RESPONSE_AUTH)) {
if (value == null)
throw new NullPointerException("null value");
if (value.startsWith(Separators.DOUBLE_QUOTE))
throw new ParseException(
value + " : Unexpected DOUBLE_QUOTE",
0);
nv.setQuotedValue();
}
super.setParameter(nv);
} else
nv.setValueAsObject(value);
}
}
java/gov/nist/javax/sip/header/AuthenticationInfoList.java 0100644 0000000 0000000 00000003660 13513104763 022734 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* A list of AuthenticationInfo headers (there can be multiple in a message).
*
*@author M. Ranganathan
*
*/
public class AuthenticationInfoList extends SIPHeaderList {
private static final long serialVersionUID = 1L;
public Object clone() {
AuthenticationInfoList retval = new AuthenticationInfoList();
retval.clonehlist(this.hlist);
return retval;
}
/** Creates a new instance of AuthenticationList */
public AuthenticationInfoList() {
super( AuthenticationInfo.class, AuthenticationInfoHeader.NAME);
}
}
java/gov/nist/javax/sip/header/Authorization.java 0100644 0000000 0000000 00000003763 13513104763 021151 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.header.ims.AuthorizationHeaderIms;
import javax.sip.header.*;
/**
* Authorization SIP header.
*
* @see ProxyAuthorization
*
* @author M. Ranganathan NIST/ITL/ANTD
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:27 $
*
*
*/
public class Authorization
extends gov.nist.javax.sip.header.AuthenticationHeader
implements javax.sip.header.AuthorizationHeader, AuthorizationHeaderIms {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -8897770321892281348L;
/** Default constructor.
*/
public Authorization() {
super(AuthorizationHeader.NAME);
}
}
java/gov/nist/javax/sip/header/AuthorizationList.java 0100644 0000000 0000000 00000003723 13513104763 022001 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
/**
* WWWAuthenticate SIPHeader (of which there can be several?)
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:27 $
*
* @author M. Ranganathan
*
*
*
*/
public class AuthorizationList extends SIPHeaderList {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 1L;
public Object clone() {
AuthorizationList retval = new AuthorizationList();
retval.clonehlist(this.hlist);
return retval;
}
/**
* constructor.
*/
public AuthorizationList() {
super(Authorization.class, Authorization.NAME);
}
}
java/gov/nist/javax/sip/header/CSeq.java 0100644 0000000 0000000 00000012302 13513104763 017131 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.message.SIPRequest;
import javax.sip.InvalidArgumentException;
import javax.sip.header.CSeqHeader;
import java.text.ParseException;
/**
* CSeq SIP Header.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.10 $ $Date: 2009/10/18 13:46:33 $
* @since 1.1
*
*/
public class CSeq extends SIPHeader implements javax.sip.header.CSeqHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -5405798080040422910L;
/**
* seqno field
*/
protected Long seqno;
/**
* method field
*/
protected String method;
/**
* Constructor.
*/
public CSeq() {
super(CSEQ);
}
/**
* Constructor given the sequence number and method.
*
* @param seqno is the sequence number to assign.
* @param method is the method string.
*/
public CSeq(long seqno, String method) {
this();
this.seqno = Long.valueOf(seqno);
this.method = SIPRequest.getCannonicalName(method);
}
/**
* Compare two cseq headers for equality.
* @param other Object to compare against.
* @return true if the two cseq headers are equals, false
* otherwise.
*/
public boolean equals(Object other) {
if (other instanceof CSeqHeader) {
final CSeqHeader o = (CSeqHeader) other;
return this.getSeqNumber() == o.getSeqNumber()
&& this.getMethod().equals( o.getMethod() );
}
return false;
}
/**
* Return canonical encoded header.
* @return String with canonical encoded header.
*/
public String encode() {
return headerName + COLON + SP + encodeBody() + NEWLINE;
}
/**
* Return canonical header content. (encoded header except headerName:)
*
* @return encoded string.
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
return buffer.append(seqno).append(SP).append(method.toUpperCase());
}
/**
* Get the method.
* @return String the method.
*/
public String getMethod() {
return method;
}
/*
* (non-Javadoc)
* @see javax.sip.header.CSeqHeader#setSequenceNumber(long)
*/
public void setSeqNumber(long sequenceNumber)
throws InvalidArgumentException {
if (sequenceNumber < 0 )
throw new InvalidArgumentException(
"JAIN-SIP Exception, CSeq, setSequenceNumber(), "
+ "the sequence number parameter is < 0 : " + sequenceNumber);
else if ( sequenceNumber > ((long)1)<<32 - 1)
throw new InvalidArgumentException(
"JAIN-SIP Exception, CSeq, setSequenceNumber(), "
+ "the sequence number parameter is too large : " + sequenceNumber);
seqno = Long.valueOf(sequenceNumber);
}
/**
* For backwards compatibility
*/
public void setSequenceNumber(int sequenceNumber) throws InvalidArgumentException {
this.setSeqNumber( (long) sequenceNumber );
}
/*
* (non-Javadoc)
* @see javax.sip.header.CSeqHeader#setMethod(java.lang.String)
*/
public void setMethod(String meth) throws ParseException {
if (meth == null)
throw new NullPointerException(
"JAIN-SIP Exception, CSeq"
+ ", setMethod(), the meth parameter is null");
this.method = SIPRequest.getCannonicalName(meth);
}
/*
* (non-Javadoc)
* @see javax.sip.header.CSeqHeader#getSequenceNumber()
*/
public int getSequenceNumber() {
if (this.seqno == null)
return 0;
else
return this.seqno.intValue();
}
public long getSeqNumber() {
return this.seqno.longValue();
}
}
java/gov/nist/javax/sip/header/CallID.java 0100644 0000000 0000000 00000010603 13513104763 017370 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.CallIdHeader;
import java.text.ParseException;
/**
* Call ID SIPHeader.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:27 $
* @since 1.1
*/
public class CallID
extends SIPHeader
implements javax.sip.header.CallIdHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6463630258703731156L;
/**
* callIdentifier field
*/
protected CallIdentifier callIdentifier;
/**
* Default constructor
*/
public CallID() {
super(NAME);
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*
* CallIDs are compared case-insensitively
*/
public boolean equals( Object other ) {
if (this==other) return true;
if (other instanceof CallIdHeader) {
final CallIdHeader o = (CallIdHeader) other;
return this.getCallId().equalsIgnoreCase( o.getCallId() );
}
return false;
}
/**
* Encode the body part of this header (i.e. leave out the hdrName).
*@return String encoded body part of the header.
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (callIdentifier != null)
callIdentifier.encode(buffer);
return buffer;
}
/**
* get the CallId field. This does the same thing as
* encodeBody
* @return String the encoded body part of the
*/
public String getCallId() {
return encodeBody();
}
/**
* get the call Identifer member.
* @return CallIdentifier
*/
public CallIdentifier getCallIdentifer() {
return callIdentifier;
}
/**
* set the CallId field
* @param cid String to set. This is the body part of the Call-Id
* header. It must have the form localId@host or localId.
* @throws IllegalArgumentException if cid is null, not a token, or is
* not a token@token.
*/
public void setCallId(String cid) throws ParseException {
try {
callIdentifier = new CallIdentifier(cid);
} catch (IllegalArgumentException ex) {
throw new ParseException(cid, 0);
}
}
/**
* Set the callIdentifier member.
* @param cid CallIdentifier to set (localId@host).
*/
public void setCallIdentifier(CallIdentifier cid) {
callIdentifier = cid;
}
/** Constructor given the call Identifier.
*@param callId string call identifier (should be localid@host)
*@throws IllegalArgumentException if call identifier is bad.
*/
public CallID(String callId) throws IllegalArgumentException {
super(NAME);
this.callIdentifier = new CallIdentifier(callId);
}
public Object clone() {
CallID retval = (CallID) super.clone();
if (this.callIdentifier != null)
retval.callIdentifier = (CallIdentifier) this.callIdentifier.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/CallIdentifier.java 0100644 0000000 0000000 00000012122 13513104763 021154 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
/**
* The call identifer that goes into a callID header and a in-reply-to header.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/12/16 02:38:35 $
* @see CallID
* @see InReplyTo
* @since 1.1
*/
public final class CallIdentifier extends SIPObject {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 7314773655675451377L;
/**
* localId field
*/
protected String localId;
/**
* host field
*/
protected String host;
/**
* Default constructor
*/
public CallIdentifier() {
}
/**
* Constructor
* @param localId id is the local id.
* @param host is the host.
*/
public CallIdentifier(String localId, String host) {
this.localId = localId;
this.host = host;
}
/**
* constructor
* @param cid String to set
* @throws IllegalArgumentException if cid is null or is not a token,
* or token@token
*/
public CallIdentifier(String cid) throws IllegalArgumentException {
setCallID(cid);
}
/**
* Get the encoded version of this id.
* @return String to set
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
buffer.append(localId);
if (host != null) {
buffer.append(AT).append(host);
}
return buffer;
}
/**
* Compare two call identifiers for equality.
* @param other Object to set
* @return true if the two call identifiers are equals, false
* otherwise
*/
public boolean equals(Object other) {
if (other == null ) return false;
if (!other.getClass().equals(this.getClass())) {
return false;
}
CallIdentifier that = (CallIdentifier) other;
if (this.localId.compareTo(that.localId) != 0) {
return false;
}
if (this.host == that.host)
return true;
if ((this.host == null && that.host != null)
|| (this.host != null && that.host == null))
return false;
if (host.compareToIgnoreCase(that.host) != 0) {
return false;
}
return true;
}
@Override
public int hashCode() {
if (this.localId == null ) {
throw new UnsupportedOperationException("Hash code called before id is set");
}
return this.localId.hashCode();
}
/** get the LocalId field
* @return String
*/
public String getLocalId() {
return localId;
}
/** get the host field
* @return host member String
*/
public String getHost() {
return host;
}
/**
* Set the localId member
* @param localId String to set
*/
public void setLocalId(String localId) {
this.localId = localId;
}
/** set the callId field
* @param cid Strimg to set
* @throws IllegalArgumentException if cid is null or is not a token or
* token@token
*/
public void setCallID(String cid) throws IllegalArgumentException {
if (cid == null)
throw new IllegalArgumentException("NULL!");
int index = cid.indexOf('@');
if (index == -1) {
localId = cid;
host = null;
} else {
localId = cid.substring(0, index);
host = cid.substring(index + 1, cid.length());
if (localId == null || host == null) {
throw new IllegalArgumentException("CallID must be token@token or token");
}
}
}
/**
* Set the host member
* @param host String to set
*/
public void setHost(String host) {
this.host = host;
}
}
java/gov/nist/javax/sip/header/CallInfo.java 0100644 0000000 0000000 00000006575 13513104763 020004 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.address.*;
import java.text.ParseException;
/**
* CallInfo SIPHeader.
*
*
* @author "M. Ranganathan"
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:28 $
* @since 1.1
*/
public final class CallInfo
extends ParametersHeader
implements javax.sip.header.CallInfoHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -8179246487696752928L;
protected GenericURI info;
/**
* Default constructor
*/
public CallInfo() {
super(CALL_INFO);
}
/**
* Return canonical representation.
* @return String
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
buffer.append(LESS_THAN);
info.encode(buffer);
buffer.append(GREATER_THAN);
if (parameters != null && !parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
return buffer;
}
/**
* get the purpose field
* @return String
*/
public String getPurpose() {
return this.getParameter("purpose");
}
/**
* get the URI field
* @return URI
*/
public javax.sip.address.URI getInfo() {
return info;
}
/**
* set the purpose field
* @param purpose is the purpose field.
*/
public void setPurpose(String purpose) {
if (purpose == null)
throw new NullPointerException("null arg");
try {
this.setParameter("purpose", purpose);
} catch (ParseException ex) {
}
}
/**
* set the URI field
* @param info is the URI to set.
*/
public void setInfo(javax.sip.address.URI info) {
this.info = (GenericURI) info;
}
public Object clone() {
CallInfo retval = (CallInfo) super.clone();
if (this.info != null)
retval.info = (GenericURI) this.info.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/CallInfoList.java 0100644 0000000 0000000 00000003765 13513104763 020636 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* A list of CallInfo headers (there can be multiple in a message).
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:28 $
* @since 1.1
*
*/
public class CallInfoList extends SIPHeaderList {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -4949850334388806423L;
public Object clone() {
CallInfoList retval = new CallInfoList ();
retval.clonehlist(this.hlist);
return retval;
}
/**
* Default constructor
*/
public CallInfoList() {
super(CallInfo.class, CallInfoHeader.NAME);
}
}
java/gov/nist/javax/sip/header/Challenge.java 0100644 0000000 0000000 00000014541 13513104763 020167 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
/**
* Challenge part of the Auth header. This is only used by the parser interface
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:28 $
* @since 1.1
*
*/
public class Challenge extends SIPObject {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 5944455875924336L;
private static String DOMAIN = ParameterNames.DOMAIN;
private static String REALM = ParameterNames.REALM;
private static String OPAQUE = ParameterNames.OPAQUE;
private static String ALGORITHM = ParameterNames.ALGORITHM;
private static String QOP = ParameterNames.QOP;
private static String STALE = ParameterNames.STALE;
private static String SIGNATURE = ParameterNames.SIGNATURE;
private static String RESPONSE = ParameterNames.RESPONSE;
private static String SIGNED_BY = ParameterNames.SIGNED_BY;
private static String URI = ParameterNames.URI;
/**
* scheme field
*/
protected String scheme;
/**
* authParms list
*/
protected NameValueList authParams;
/**
* Default constructor
*/
public Challenge() {
authParams = new NameValueList();
authParams.setSeparator(COMMA);
}
/**
* Encode the challenge in canonical form.
* @return String
*/
public String encode() {
return new StringBuffer(scheme)
.append(SP)
.append(authParams.encode())
.toString();
}
/**
* get the scheme field
* @return String
*/
public String getScheme() {
return scheme;
}
/**
* get AuthParms list.
* @return NameValueList
*/
public NameValueList getAuthParams() {
return authParams;
}
/**
* get the domain
* @return String
*/
public String getDomain() {
return (String) authParams.getValue(DOMAIN);
}
/**
* get the URI field
* @return String
*/
public String getURI() {
return (String) authParams.getValue(URI);
}
/**
* get the Opaque field
* @return String
*/
public String getOpaque() {
return (String) authParams.getValue(OPAQUE);
}
/**
* get QOP value
* @return String
*/
public String getQOP() {
return (String) authParams.getValue(QOP);
}
/**
* get the Algorithm value.
* @return String
*/
public String getAlgorithm() {
return (String) authParams.getValue(ALGORITHM);
}
/**
* get the State value.
* @return String
*/
public String getStale() {
return (String) authParams.getValue(STALE);
}
/**
* get the Signature value.
* @return String
*/
public String getSignature() {
return (String) authParams.getValue(SIGNATURE);
}
/**
* get the signedBy value.
* @return String
*/
public String getSignedBy() {
return (String) authParams.getValue(SIGNED_BY);
}
/**
* get the Response value.
* @return String
*/
public String getResponse() {
return (String) authParams.getValue(RESPONSE);
}
/**
* get the realm value.
* @return String.
*/
public String getRealm() {
return (String) authParams.getValue(REALM);
}
/**
* get the specified parameter
* @param name String to set
* @return String to set
*/
public String getParameter(String name) {
return (String) authParams.getValue(name);
}
/**
* boolean function
* @param name String to set
* @return true if this header has the specified parameter, false otherwise.
*/
public boolean hasParameter(String name) {
return authParams.getNameValue(name) != null;
}
/**
* Boolean function
* @return true if this header has some parameters.
*/
public boolean hasParameters() {
return authParams.size() != 0;
}
/**
* delete the specified parameter
* @param name String
* @return true if the specified parameter has been removed, false
* otherwise.
*/
public boolean removeParameter(String name) {
return authParams.delete(name);
}
/**
* remove all parameters
*/
public void removeParameters() {
authParams = new NameValueList();
}
/**
* set the specified parameter
* @param nv NameValue to set
*/
public void setParameter(NameValue nv) {
authParams.set(nv);
}
/**
* Set the scheme member
* @param s String to set
*/
public void setScheme(String s) {
scheme = s;
}
/**
* Set the authParams member
* @param a NameValueList to set
*/
public void setAuthParams(NameValueList a) {
authParams = a;
}
public Object clone() {
Challenge retval = (Challenge) super.clone();
if (this.authParams != null)
retval.authParams = (NameValueList) this.authParams.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/Contact.java 0100644 0000000 0000000 00000020403 13513104763 017672 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*
* Bug reports contributed by Joao Paulo, Stephen Jones,
* John Zeng and Alstair Cole.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.NameValue;
import gov.nist.core.NameValueList;
import gov.nist.javax.sip.address.AddressImpl;
import javax.sip.InvalidArgumentException;
import javax.sip.header.ContactHeader;
import java.text.ParseException;
/**
* Contact Item.
*
* @see gov.nist.javax.sip.header.ContactList
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.13 $ $Date: 2009/10/18 13:46:31 $
* @since 1.1
*
*
*/
public final class Contact
extends AddressParametersHeader
implements javax.sip.header.ContactHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 1677294871695706288L;
public static final String ACTION = ParameterNames.ACTION;
public static final String PROXY = ParameterNames.PROXY;
public static final String REDIRECT = ParameterNames.REDIRECT;
public static final String EXPIRES = ParameterNames.EXPIRES;
public static final String Q = ParameterNames.Q;
// This must be private or the toString will go for a loop!
private ContactList contactList;
/** wildCardFlag field.
*/
protected boolean wildCardFlag;
/** Default constructor.
*/
public Contact() {
super(NAME);
}
/** Set a parameter.
*/
public void setParameter(String name, String value) throws ParseException {
NameValue nv = parameters.getNameValue(name);
if (nv != null) {
nv.setValueAsObject(value);
} else {
nv = new NameValue(name, value);
if (name.equalsIgnoreCase("methods"))
nv.setQuotedValue();
this.parameters.set(nv);
}
}
/**
* Encode body of the header into a cannonical String.
* @return string encoding of the header value.
*/
protected String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (wildCardFlag) {
buffer.append('*');
}
else {
// Bug report by Joao Paulo
if (address.getAddressType() == AddressImpl.NAME_ADDR) {
address.encode(buffer);
} else {
// Encoding in canonical form must have <> around address.
buffer.append('<');
address.encode(buffer);
buffer.append('>');
}
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
}
return buffer;
}
/** get the Contact list.
* @return ContactList
*/
public ContactList getContactList() {
return contactList;
}
/** get the WildCardFlag field
* @return boolean
*/
public boolean getWildCardFlag() {
return wildCardFlag;
}
/** get the address field.
* @return Address
*/
public javax.sip.address.Address getAddress() {
// JAIN-SIP stores the wild card as an address!
return address;
}
/** get the parameters List
* @return NameValueList
*/
public NameValueList getContactParms() {
return parameters;
}
/** get Expires parameter.
* @return the Expires parameter.
*/
public int getExpires() {
return getParameterAsInt(EXPIRES);
}
/** Set the expiry time in seconds.
*@param expiryDeltaSeconds exipry time.
*/
public void setExpires(int expiryDeltaSeconds) {
Integer deltaSeconds = Integer.valueOf(expiryDeltaSeconds);
this.parameters.set(EXPIRES, deltaSeconds);
}
/** get the Q-value
* @return float
*/
public float getQValue() {
return getParameterAsFloat(Q);
}
/** set the Contact List
* @param cl ContactList to set
*/
public void setContactList(ContactList cl) {
contactList = cl;
}
/**
* Set the wildCardFlag member
* @param w boolean to set
*/
public void setWildCardFlag(boolean w) {
this.wildCardFlag = true;
this.address = new AddressImpl();
this.address.setWildCardFlag();
}
/**
* Set the address member
*
* @param address Address to set
*/
public void setAddress(javax.sip.address.Address address) {
// Canonical form must have <> around the address.
if (address == null)
throw new NullPointerException("null address");
this.address = (AddressImpl) address;
this.wildCardFlag = false;
}
/**
* set the Q-value parameter
* @param qValue float to set
*/
public void setQValue(float qValue) throws InvalidArgumentException {
if (qValue != -1 && (qValue < 0 || qValue > 1))
throw new InvalidArgumentException(
"JAIN-SIP Exception, Contact, setQValue(), "
+ "the qValue is not between 0 and 1");
this.parameters.set(Q, Float.valueOf(qValue));
}
public Object clone() {
Contact retval = (Contact) super.clone();
if (this.contactList != null)
retval.contactList = (ContactList) this.contactList.clone();
return retval;
}
/* (non-Javadoc)
* @see javax.sip.header.ContactHeader#setWildCard()
*/
public void setWildCard() {
this.setWildCardFlag(true);
}
/* (non-Javadoc)
* @see javax.sip.header.ContactHeader#isWildCard()
*/
public boolean isWildCard() {
return this.address.isWildcard();
}
public boolean equals(Object other) {
return (other instanceof ContactHeader) && super.equals(other);
}
public void removeSipInstanceParam() {
if (parameters != null)
parameters.delete(ParameterNames.SIP_INSTANCE);
}
public String getSipInstanceParam() {
return (String) parameters.getValue(ParameterNames.SIP_INSTANCE);
}
public void setSipInstanceParam(String value) {
this.parameters.set(ParameterNames.SIP_INSTANCE, value);
}
/**
*remove the pub-gruu value from the parameter list if it exists.
*/
public void removePubGruuParam() {
if (parameters != null)
parameters.delete(ParameterNames.PUB_GRUU);
}
public String getPubGruuParam() {
return (String) parameters.getValue(ParameterNames.PUB_GRUU);
}
public void setPubGruuParam(String value)
{
this.parameters.set(ParameterNames.PUB_GRUU, value);
}
/**
*remove the pub-gruu value from the parameter list if it exists.
*/
public void removeTempGruuParam() {
if (parameters != null)
parameters.delete(ParameterNames.TEMP_GRUU);
}
public String getTempGruuParam() {
return (String) parameters.getValue(ParameterNames.TEMP_GRUU);
}
public void setTempGruuParam(String value)
{
this.parameters.set(ParameterNames.TEMP_GRUU, value);
}
}
java/gov/nist/javax/sip/header/ContactList.java 0100644 0000000 0000000 00000003740 13513104763 020533 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.util.ListIterator;
/**
* List of contact headers.ContactLists are also maintained in a hashtable
* for quick lookup.
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:28 $
* @since 1.1
*/
public class ContactList extends SIPHeaderList {
private static final long serialVersionUID = 1224806837758986814L;
public Object clone() {
ContactList retval = new ContactList();
retval.clonehlist(this.hlist);
return retval;
}
/**
* Constructor.
*/
public ContactList() {
super(Contact.class, ContactHeader.NAME);
}
}
java/gov/nist/javax/sip/header/ContentDisposition.java 0100644 0000000 0000000 00000014412 13513104763 022141 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.*;
/**
* Content Dispositon SIP Header.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:29 $
* @since 1.1
*
*/
public final class ContentDisposition
extends ParametersHeader
implements javax.sip.header.ContentDispositionHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 835596496276127003L;
/**
* DispositionType field.
*/
protected String dispositionType;
/**
* Default constructor.
*/
public ContentDisposition() {
super(NAME);
}
/**
* Encode value of header into canonical string.
* @return encoded value of header.
*
*/
public String encodeBody() {
StringBuffer encoding = new StringBuffer(dispositionType);
if (!this.parameters.isEmpty()) {
encoding.append(SEMICOLON).append(parameters.encode());
}
return encoding.toString();
}
/**
* Set the disposition type.
* @param dispositionType type.
*/
public void setDispositionType(String dispositionType)
throws ParseException {
if (dispositionType == null)
throw new NullPointerException(
"JAIN-SIP Exception"
+ ", ContentDisposition, setDispositionType(), the dispositionType parameter is null");
this.dispositionType = dispositionType;
}
/**
* Get the disposition type.
* @return Disposition Type
*/
public String getDispositionType() {
return this.dispositionType;
}
/**
* Get the dispositionType field.
* @return String
*/
public String getHandling() {
return this.getParameter("handling");
}
/** set the dispositionType field.
* @param handling String to set.
*/
public void setHandling(String handling) throws ParseException {
if (handling == null)
throw new NullPointerException(
"JAIN-SIP Exception"
+ ", ContentDisposition, setHandling(), the handling parameter is null");
this.setParameter("handling", handling);
}
/**
* Gets the interpretation of the message body or message body part of
* this ContentDispositionHeader.
*
* @return interpretation of the message body or message body part
*/
public String getContentDisposition() {
return this.encodeBody();
}
}
/*
* $Log: ContentDisposition.java,v $
* Revision 1.5 2009/07/17 18:57:29 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:06 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:34 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ContentEncoding.java 0100644 0000000 0000000 00000011226 13513104763 021363 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
/**
* Content encoding part of a content encoding header list.
* @see ContentEncodingList
*
* From HTTP RFC 2616
*14.11 Content-Encoding
*
* The Content-Encoding entity-header field is used as a modifier to the
* media-type. When present, its value indicates what additional content
* codings have been applied to the entity-body, and thus what decoding
* mechanisms must be applied in order to obtain the media-type
* referenced by the Content-Type header field. Content-Encoding is
* primarily used to allow a document to be compressed without losing
* the identity of its underlying media type.
*
* Content-Encoding = "Content-Encoding" ":" 1#content-coding
*
* Content codings are defined in section 3.5. An example of its use is
*
* Content-Encoding: gzip
*
* The content-coding is a characteristic of the entity identified by
* the Request-URI. Typically, the entity-body is stored with this
* encoding and is only decoded before rendering or analogous usage.
* However, a non-transparent proxy MAY modify the content-coding if the
* new coding is known to be acceptable to the recipient, unless the
* "no-transform" cache-control directive is present in the message.
*
* If the content-coding of an entity is not "identity", then the
* response MUST include a Content-Encoding entity-header (section
* 14.11) that lists the non-identity content-coding(s) used.
*
* If the content-coding of an entity in a request message is not
* acceptable to the origin server, the server SHOULD respond with a
* status code of 415 (Unsupported Media Type).
*
* If multiple encodings have been applied to an entity, the content
* codings MUST be listed in the order in which they were applied.
* Additional information about the encoding parameters MAY be provided
* by other entity-header fields not defined by this specification.
*
*
* @author M. Ranganathan
* @author Olivier Deruelle
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:29 $
* @since 1.1
*/
public class ContentEncoding
extends SIPHeader
implements javax.sip.header.ContentEncodingHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 2034230276579558857L;
/**
* ContentEncoding field.
*/
protected String contentEncoding;
/**
* Default constructor.
*/
public ContentEncoding() {
super(CONTENT_ENCODING);
}
/**
* Constructor.
* @param enc String to set.
*/
public ContentEncoding(String enc) {
super(CONTENT_ENCODING);
contentEncoding = enc;
}
/**
* Canonical encoding of body of the header.
* @return encoded body of the header.
*/
public String encodeBody() {
return contentEncoding;
}
/**
* Get the ContentEncoding field.
* @return String
*/
public String getEncoding() {
return contentEncoding;
}
/**
* Set the ConentEncoding field.
* @param encoding String to set
*/
public void setEncoding(String encoding) throws ParseException {
if (encoding == null)
throw new NullPointerException(
"JAIN-SIP Exception, " + " encoding is null");
contentEncoding = encoding;
}
}
java/gov/nist/javax/sip/header/ContentEncodingList.java 0100644 0000000 0000000 00000003701 13513104763 022216 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* Content Encoding SIP header List. Keeps a list of ContentEncoding headers.
*
*@author M. Rangananthan
*@version 1.2
*@since 1.1
*/
public final class ContentEncodingList extends SIPHeaderList {
private static final long serialVersionUID = 7365216146576273970L;
public Object clone() {
ContentEncodingList retval = new ContentEncodingList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor.
*/
public ContentEncodingList () {
super( ContentEncoding.class,
ContentEncodingHeader.NAME);
}
}
java/gov/nist/javax/sip/header/ContentLanguage.java 0100644 0000000 0000000 00000013051 13513104763 021356 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.Locale;
/**
* ContentLanguage header
*
*Fielding, et al. Standards Track [Page 118]
*RFC 2616 HTTP/1.1 June 1999
*
* 14.12 Content-Language
*
* The Content-Language entity-header field describes the natural
* language(s) of the intended audience for the enclosed entity. Note
* that this might not be equivalent to all the languages used within
* the entity-body.
*
* Content-Language = "Content-Language" ":" 1#language-tag
*
* Language tags are defined in section 3.10. The primary purpose of
* Content-Language is to allow a user to identify and differentiate
* entities according to the user's own preferred language. Thus, if the
* body content is intended only for a Danish-literate audience, the
* appropriate field is
*
* Content-Language: da
*
* If no Content-Language is specified, the default is that the content
* is intended for all language audiences. This might mean that the
* sender does not consider it to be specific to any natural language,
* or that the sender does not know for which language it is intended.
*
* Multiple languages MAY be listed for content that is intended for
* multiple audiences. For example, a rendition of the "Treaty of
* Waitangi," presented simultaneously in the original Maori and English
* versions, would call for
*
* Content-Language: mi, en
*
* However, just because multiple languages are present within an entity
* does not mean that it is intended for multiple linguistic audiences.
* An example would be a beginner's language primer, such as "A First
* Lesson in Latin," which is clearly intended to be used by an
* English-literate audience. In this case, the Content-Language would
* properly only include "en".
*
* Content-Language MAY be applied to any media type -- it is not
* limited to textual documents.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:29 $
* @since 1.1
*/
public class ContentLanguage
extends SIPHeader
implements javax.sip.header.ContentLanguageHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -5195728427134181070L;
/** languageTag field.
*/
protected Locale locale;
public ContentLanguage() {
super(CONTENT_LANGUAGE);
}
/**
* Default constructor.
* @param languageTag String to set
*/
public ContentLanguage(String languageTag) {
super(CONTENT_LANGUAGE);
this.setLanguageTag( languageTag );
}
/**
* Canonical encoding of the value of the header.
* @return encoded body of header.
*/
public String encodeBody() {
return this.getLanguageTag();
}
/** get the languageTag field.
* @return String
*/
public String getLanguageTag() {
// JvB: Need to take sub-tags into account
if ( "".equals(locale.getCountry())) {
return locale.getLanguage();
} else {
return locale.getLanguage() + '-' + locale.getCountry();
}
}
/** set the languageTag field
* @param languageTag -- language tag to set.
*/
public void setLanguageTag(String languageTag) {
final int slash = languageTag.indexOf('-');
if (slash>=0) {
this.locale = new Locale(languageTag.substring(0,slash), languageTag.substring(slash+1) );
} else {
this.locale = new Locale(languageTag);
}
}
/**
* Gets the language value of the ContentLanguageHeader.
*
*
*
* @return the Locale value of this ContentLanguageHeader
*
*/
public Locale getContentLanguage() {
return locale;
}
/**
* Sets the language parameter of this ContentLanguageHeader.
*
* @param language - the new Locale value of the language of
*
* ContentLanguageHeader
*
*/
public void setContentLanguage(Locale language) {
this.locale = language;
}
public Object clone() {
ContentLanguage retval = (ContentLanguage) super.clone();
if (this.locale != null)
retval.locale = (Locale) this.locale.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ContentLanguageList.java 0100644 0000000 0000000 00000003625 13513104763 022220 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* ContentLanguage list of headers.
*
*@since 1.1
*@version 1.2
*@author M. Ranganathan
*/
public final class ContentLanguageList extends SIPHeaderList {
private static final long serialVersionUID = -5302265987802886465L;
public Object clone() {
ContentLanguageList retval = new ContentLanguageList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor
*/
public ContentLanguageList () {
super(ContentLanguage.class,
ContentLanguageHeader.NAME);
}
}
java/gov/nist/javax/sip/header/ContentLength.java 0100644 0000000 0000000 00000011634 13513104763 021061 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.*;
import javax.sip.header.ContentLengthHeader;
/**
* ContentLength SIPHeader (of which there can be only one in a SIPMessage).
*
*Fielding, et al. Standards Track [Page 119]
*RFC 2616 HTTP/1.1 June 1999
*
*
* 14.13 Content-Length
*
* The Content-Length entity-header field indicates the size of the
* entity-body, in decimal number of OCTETs, sent to the recipient or,
* in the case of the HEAD method, the size of the entity-body that
* would have been sent had the request been a GET.
*
* Content-Length = "Content-Length" ":" 1*DIGIT
*
* An example is
*
* Content-Length: 3495
*
* Applications SHOULD use this field to indicate the transfer-length of
* the message-body, unless this is prohibited by the rules in section
* 4.4.
*
* Any Content-Length greater than or equal to zero is a valid value.
* Section 4.4 describes how to determine the length of a message-body
* if a Content-Length is not given.
*
* Note that the meaning of this field is significantly different from
* the corresponding definition in MIME, where it is an optional field
* used within the "message/external-body" content-type. In HTTP, it
* SHOULD be sent whenever the message's length can be determined prior
* to being transferred, unless this is prohibited by the rules in
* section 4.4.
*
*
*@author M. Ranganathan
*@author Olivier Deruelle
*@version 1.2 $Revision: 1.7 $ $Date: 2009/10/18 13:46:34 $
*@since 1.1
*/
public class ContentLength
extends SIPHeader
implements javax.sip.header.ContentLengthHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 1187190542411037027L;
/**
* contentLength field.
*/
protected Integer contentLength;
/**
* Default constructor.
*/
public ContentLength() {
super(NAME);
}
/**
* Constructor given a length.
*/
public ContentLength(int length) {
super(NAME);
this.contentLength = Integer.valueOf(length);
}
/**
* get the ContentLength field.
* @return int
*/
public int getContentLength() {
return contentLength.intValue();
}
/**
* Set the contentLength member
* @param contentLength int to set
*/
public void setContentLength(int contentLength)
throws InvalidArgumentException {
if (contentLength < 0)
throw new InvalidArgumentException(
"JAIN-SIP Exception"
+ ", ContentLength, setContentLength(), the contentLength parameter is <0");
this.contentLength = Integer.valueOf(contentLength);
}
/**
* Encode into a canonical string.
* @return String
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (contentLength == null)
buffer.append("0");
else
buffer.append(contentLength.toString());
return buffer;
}
/**
* Pattern matcher ignores content length.
*/
public boolean match(Object other) {
if (other instanceof ContentLength)
return true;
else
return false;
}
public boolean equals(Object other) {
if (other instanceof ContentLengthHeader) {
final ContentLengthHeader o = (ContentLengthHeader) other;
return this.getContentLength() == o.getContentLength();
}
return false;
}
}
java/gov/nist/javax/sip/header/ContentType.java 0100644 0000000 0000000 00000014566 13513104763 020570 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.ContentTypeHeader;
import java.text.ParseException;
/**
* ContentType SIP Header
*
*14.17 Content-Type
*
* The Content-Type entity-header field indicates the media type of the
* entity-body sent to the recipient or, in the case of the HEAD method,
* the media type that would have been sent had the request been a GET.
*
* Content-Type = "Content-Type" ":" media-type
*
* Media types are defined in section 3.7. An example of the field is
*
* Content-Type: text/html; charset=ISO-8859-4
*
* Further discussion of methods for identifying the media type of an
* entity is provided in section 7.2.1.
*
* From HTTP RFC 2616
*
*
*
*@version 1.2
*
*@author M. Ranganathan
*@author Olivier Deruelle
*@version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:29 $
*@since 1.1
*
*/
public class ContentType
extends ParametersHeader
implements javax.sip.header.ContentTypeHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 8475682204373446610L;
/** mediaRange field.
*/
protected MediaRange mediaRange;
/** Default constructor.
*/
public ContentType() {
super(CONTENT_TYPE);
}
/** Constructor given a content type and subtype.
*@param contentType is the content type.
*@param contentSubtype is the content subtype
*/
public ContentType(String contentType, String contentSubtype) {
this();
this.setContentType(contentType, contentSubtype);
}
/** compare two MediaRange headers.
* @param media String to set
* @return int.
*/
public int compareMediaRange(String media) {
return (
mediaRange.type + "/" + mediaRange.subtype).compareToIgnoreCase(
media);
}
/**
* Encode into a canonical string.
* @return String.
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
mediaRange.encode(buffer);
if (hasParameters()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
return buffer;
}
/** get the mediaRange field.
* @return MediaRange.
*/
public MediaRange getMediaRange() {
return mediaRange;
}
/** get the Media Type.
* @return String.
*/
public String getMediaType() {
return mediaRange.type;
}
/** get the MediaSubType field.
* @return String.
*/
public String getMediaSubType() {
return mediaRange.subtype;
}
/** Get the content subtype.
*@return the content subtype string (or null if not set).
*/
public String getContentSubType() {
return mediaRange == null ? null : mediaRange.getSubtype();
}
/** Get the content subtype.
*@return the content tyep string (or null if not set).
*/
public String getContentType() {
return mediaRange == null ? null : mediaRange.getType();
}
/** Get the charset parameter.
*/
public String getCharset() {
return this.getParameter("charset");
}
/**
* Set the mediaRange member
* @param m mediaRange field.
*/
public void setMediaRange(MediaRange m) {
mediaRange = m;
}
/**
* set the content type and subtype.
*@param contentType Content type string.
*@param contentSubType content subtype string
*/
public void setContentType(String contentType, String contentSubType) {
if (mediaRange == null)
mediaRange = new MediaRange();
mediaRange.setType(contentType);
mediaRange.setSubtype(contentSubType);
}
/**
* set the content type.
*@param contentType Content type string.
*/
public void setContentType(String contentType) throws ParseException {
if (contentType == null)
throw new NullPointerException("null arg");
if (mediaRange == null)
mediaRange = new MediaRange();
mediaRange.setType(contentType);
}
/** Set the content subtype.
* @param contentType String to set
*/
public void setContentSubType(String contentType) throws ParseException {
if (contentType == null)
throw new NullPointerException("null arg");
if (mediaRange == null)
mediaRange = new MediaRange();
mediaRange.setSubtype(contentType);
}
public Object clone() {
ContentType retval = (ContentType) super.clone();
if (this.mediaRange != null)
retval.mediaRange = (MediaRange) this.mediaRange.clone();
return retval;
}
public boolean equals(Object other) {
if (other instanceof ContentTypeHeader) {
final ContentTypeHeader o = (ContentTypeHeader) other;
return this.getContentType().equalsIgnoreCase( o.getContentType() )
&& this.getContentSubType().equalsIgnoreCase( o.getContentSubType() )
&& equalParameters( o );
}
return false;
}
}
java/gov/nist/javax/sip/header/Credentials.java 0100644 0000000 0000000 00000010545 13513104763 020542 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
/**
* Credentials that are used in authentication and authorization headers.
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:30 $
* @since 1.1
*/
public class Credentials extends SIPObject {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6335592791505451524L;
private static String DOMAIN = ParameterNames.DOMAIN;
private static String REALM = ParameterNames.REALM;
private static String OPAQUE = ParameterNames.OPAQUE;
private static String RESPONSE = ParameterNames.RESPONSE;
private static String URI = ParameterNames.URI;
private static String NONCE = ParameterNames.NONCE;
private static String CNONCE = ParameterNames.CNONCE;
private static String USERNAME = ParameterNames.USERNAME;
protected String scheme;
/**
* parameters list.
*/
protected NameValueList parameters;
/**
* Default constructor
*/
public Credentials() {
parameters = new NameValueList();
parameters.setSeparator(COMMA);
}
/**
* get the parameters list.
* @return NameValueList
*/
public NameValueList getCredentials() {
return parameters;
}
/**
* get the scheme field.
* @return String.
*/
public String getScheme() {
return scheme;
}
/**
* Set the scheme member
* @param s String to set
*/
public void setScheme(String s) {
scheme = s;
}
/**
* Set the parameters member
* @param c NameValueList to set.
*/
public void setCredentials(NameValueList c) {
parameters = c;
}
public String encode() {
String retval = scheme;
if (!parameters.isEmpty()) {
retval += SP + parameters.encode();
}
return retval;
}
/*public void setCredential(NameValue nameValue) {
if (nameValue.getName().compareToIgnoreCase(URI) == 0)
nameValue.setQuotedValue();
else if (nameValue.getName().compareToIgnoreCase(NONCE) == 0)
nameValue.setQuotedValue();
else if (nameValue.getName().compareToIgnoreCase(REALM) == 0)
nameValue.setQuotedValue();
else if (nameValue.getName().compareToIgnoreCase(CNONCE) == 0)
nameValue.setQuotedValue();
else if (nameValue.getName().compareToIgnoreCase(RESPONSE) == 0)
nameValue.setQuotedValue();
else if (nameValue.getName().compareToIgnoreCase(OPAQUE) == 0)
nameValue.setQuotedValue();
else if (nameValue.getName().compareToIgnoreCase(USERNAME) == 0)
nameValue.setQuotedValue();
else if (nameValue.getName().compareToIgnoreCase(DOMAIN) == 0)
nameValue.setQuotedValue();
parameters.set(nameValue);
}*/
public Object clone() {
Credentials retval = (Credentials) super.clone();
if (this.parameters != null)
retval.parameters = (NameValueList) this.parameters.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ErrorInfo.java 0100644 0000000 0000000 00000010373 13513104763 020211 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.address.*;
import javax.sip.header.*;
import javax.sip.address.*;
import java.text.ParseException;
/**
* ErrorInfo SIP Header.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:30 $
* @since 1.1
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*/
public final class ErrorInfo
extends ParametersHeader
implements ErrorInfoHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6347702901964436362L;
protected GenericURI errorInfo;
/**
* Default constructor.
*/
public ErrorInfo() {
super(NAME);
}
/**
* Constructor given the error info
* @param errorInfo -- the error information to set.
*/
public ErrorInfo(GenericURI errorInfo) {
this();
this.errorInfo = errorInfo;
}
/**
* Encode into canonical form.
* @return String
*/
public String encodeBody() {
StringBuffer retval =
new StringBuffer(LESS_THAN).append(errorInfo.toString()).append(
GREATER_THAN);
if (!parameters.isEmpty()) {
retval.append(SEMICOLON).append(parameters.encode());
}
return retval.toString();
}
/**
* Sets the ErrorInfo of the ErrorInfoHeader to the errorInfo
* parameter value.
*
* @param errorInfo the new ErrorInfo of this ErrorInfoHeader.
*/
public void setErrorInfo(javax.sip.address.URI errorInfo) {
this.errorInfo = (GenericURI) errorInfo;
}
/**
* Returns the ErrorInfo value of this ErrorInfoHeader. This message
* may return null if a String message identifies the ErrorInfo.
*
* @return the URI representing the ErrorInfo.
*/
public URI getErrorInfo() {
return errorInfo;
}
/**
* Sets the Error information message to the new message value
* supplied to this method.
*
* @param message - the new string value that represents the error message.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the error message.
*/
public void setErrorMessage(String message) throws ParseException {
if (message == null)
throw new NullPointerException(
"JAIN-SIP Exception "
+ ", ErrorInfoHeader, setErrorMessage(), the message parameter is null");
setParameter("message", message);
}
/**
* Get the Error information message of this ErrorInfoHeader.
*
* @return the stringified version of the ErrorInfo header.
*/
public String getErrorMessage() {
return getParameter("message");
}
public Object clone() {
ErrorInfo retval = (ErrorInfo) super.clone();
if (this.errorInfo != null)
retval.errorInfo = (GenericURI) this.errorInfo.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ErrorInfoList.java 0100644 0000000 0000000 00000004334 13513104763 021045 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* Error Info sip header.
*
*@version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:30 $
*
*@author M. Ranganathan
*@since 1.1
*@see ErrorInfoList
*
*
* 6.24 Error-Info
*
* The Error-Info response header provides a pointer to additional
* information about the error status response. This header field is
* only contained in 3xx, 4xx, 5xx and 6xx responses.
*
*
*
* Error-Info = "Error-Info" ":" # ( "<" URI ">" *( ";" generic-param ))
*
*
*/
public class ErrorInfoList extends SIPHeaderList{
/**
*
*/
private static final long serialVersionUID = 1L;
public Object clone() {
ErrorInfoList retval = new ErrorInfoList();
retval.clonehlist(this.hlist);
return retval;
}
/**
* Default constructor.
*/
public ErrorInfoList() {
super(ErrorInfo.class, ErrorInfoHeader.NAME);
}
}
java/gov/nist/javax/sip/header/Event.java 0100644 0000000 0000000 00000011360 13513104763 017362 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.text.ParseException;
/**
* Event SIP Header.
*
*@version 1.2 $Revision: 1.7 $ $Date: 2007/06/28 15:08:42 $
*@since 1.1
*
*@author M. Ranganathan
*@author Olivier Deruelle
*
*
*/
public class Event extends ParametersHeader implements EventHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6458387810431874841L;
protected String eventType;
/**
* Creates a new instance of Event
*/
public Event() {
super(EVENT);
}
/**
* Sets the eventType to the newly supplied eventType string.
*
* @param eventType - the new string defining the eventType supported
* in this EventHeader
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the eventType value.
*/
public void setEventType(String eventType) throws ParseException {
if (eventType == null)
throw new NullPointerException(" the eventType is null");
this.eventType = eventType;
}
/**
* Gets the eventType of the EventHeader.
*
* @return the string object identifing the eventType of EventHeader.
*/
public String getEventType() {
return eventType;
}
/**
* Sets the id to the newly supplied eventId string.
*
* @param eventId - the new string defining the eventId of this EventHeader
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the eventId value.
*/
public void setEventId(String eventId) throws ParseException {
if (eventId == null)
throw new NullPointerException(" the eventId parameter is null");
setParameter(ParameterNames.ID, eventId);
}
/**
* Gets the id of the EventHeader. This method may return null if the
* "eventId" is not set.
* @return the string object identifing the eventId of EventHeader.
*/
public String getEventId() {
return getParameter(ParameterNames.ID);
}
/**
* Encode in canonical form.
* @return String
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (eventType != null)
buffer.append(eventType);
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
this.parameters.encode(buffer);
}
return buffer;
}
/**
* Return true if the given event header matches the supplied one.
*
* @param matchTarget -- event header to match against.
*/
public boolean match(Event matchTarget) {
if (matchTarget.eventType == null && this.eventType != null)
return false;
else if (matchTarget.eventType != null && this.eventType == null)
return false;
else if (this.eventType == null && matchTarget.eventType == null)
return false;
else if (getEventId() == null && matchTarget.getEventId() != null)
return false;
else if (getEventId() != null && matchTarget.getEventId() == null)
return false;
return matchTarget.eventType.equalsIgnoreCase(this.eventType)
&& ((this.getEventId() == matchTarget.getEventId())
|| this.getEventId().equalsIgnoreCase(matchTarget.getEventId()));
}
}
java/gov/nist/javax/sip/header/Expires.java 0100644 0000000 0000000 00000005646 13513104763 017732 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.*;
/**
* Expires SIP Header.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:30 $
* @since 1.1
*
* @author M. Ranganathan
*
*
*/
public class Expires
extends SIPHeader
implements javax.sip.header.ExpiresHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 3134344915465784267L;
/** expires field
*/
protected int expires;
/** default constructor
*/
public Expires() {
super(NAME);
}
/**
* Return canonical form.
* @return String
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
return buffer.append(expires);
}
/**
* Gets the expires value of the ExpiresHeader. This expires value is
*
* relative time.
*
*
*
* @return the expires value of the ExpiresHeader.
*
*
*/
public int getExpires() {
return expires;
}
/**
* Sets the relative expires value of the ExpiresHeader.
* The expires value MUST be greater than zero and MUST be
* less than 2**31.
*
* @param expires - the new expires value of this ExpiresHeader
*
* @throws InvalidArgumentException if supplied value is less than zero.
*
*
*/
public void setExpires(int expires) throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException("bad argument " + expires);
this.expires = expires;
}
}
java/gov/nist/javax/sip/header/ExtensionHeaderImpl.java 0100644 0000000 0000000 00000007112 13513104763 022210 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
/**
* A generic extension header for the stack.
* The input text of the header gets recorded here.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:30 $
* @since 1.1
*
* @author M. Ranganathan
*
*
*/
public class ExtensionHeaderImpl
extends SIPHeader
implements javax.sip.header.ExtensionHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -8693922839612081849L;
protected String value;
/**
* This was added to allow for automatic cloning of headers.
*/
public ExtensionHeaderImpl() {
}
public ExtensionHeaderImpl(String headerName) {
super(headerName);
}
/**
* Set the name of the header.
* @param headerName is the name of the header to set.
*/
public void setName(String headerName) {
this.headerName = headerName;
}
/**
* Set the value of the header.
*/
public void setValue(String value) {
this.value = value;
}
/**
* Get the value of the extension header.
* @return the value of the extension header.
*/
public String getHeaderValue() {
if (this.value != null) {
return this.value;
} else {
String encodedHdr = null;
try {
// Bug fix submitted by Lamine Brahimi
encodedHdr = this.encode();
} catch (Exception ex) {
return null;
}
StringBuffer buffer = new StringBuffer(encodedHdr);
while (buffer.length() > 0 && buffer.charAt(0) != ':') {
buffer.deleteCharAt(0);
}
buffer.deleteCharAt(0);
this.value = buffer.toString().trim();
return this.value;
}
}
/**
* Return the canonical encoding of this header.
*/
public String encode() {
return new StringBuffer(this.headerName)
.append(COLON)
.append(SP)
.append(this.value)
.append(NEWLINE)
.toString();
}
/**
* Return just the body of this header encoded (leaving out the
* name and the CRLF at the end).
*/
public String encodeBody() {
return this.getHeaderValue();
}
}
java/gov/nist/javax/sip/header/ExtensionHeaderList.java 0100644 0000000 0000000 00000004565 13513104763 022233 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.ListIterator;
import javax.sip.header.ExtensionHeader;
import javax.sip.header.Header;
/**
* A generic extension header list.
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:30 $
* @since 1.1
*/
public class ExtensionHeaderList extends SIPHeaderList {
private static final long serialVersionUID = 4681326807149890197L;
public Object clone() {
ExtensionHeaderList retval = new ExtensionHeaderList(headerName);
retval.clonehlist(this.hlist);
return retval;
}
public ExtensionHeaderList(String hName) {
super( ExtensionHeaderImpl.class, hName);
}
public ExtensionHeaderList() {
super(ExtensionHeaderImpl.class,null);
}
public String encode() {
StringBuffer retval = new StringBuffer();
ListIterator it = this.listIterator();
while(it.hasNext()) {
ExtensionHeaderImpl eh = (ExtensionHeaderImpl) it.next();
retval.append(eh.encode());
}
return retval.toString();
}
}
java/gov/nist/javax/sip/header/From.java 0100644 0000000 0000000 00000010735 13513104763 017211 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.HostPort;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.parser.Parser;
import javax.sip.header.FromHeader;
import java.text.ParseException;
/**
* From SIP Header.
*
* @version 1.2 $Revision: 1.9 $ $Date: 2009/07/17 18:57:31 $
* @since 1.1
*
* @author M. Ranganathan
*
*
*/
public final class From
extends AddressParametersHeader
implements javax.sip.header.FromHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6312727234330643892L;
/** Default constructor
*/
public From() {
super(NAME);
}
/** Generate a FROM header from a TO header
*/
public From(To to) {
super(NAME);
address = to.address;
parameters = to.parameters;
}
/**
* Encode the header content into a String.
*
* @return String
*/
protected String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
buffer.append(LESS_THAN);
}
address.encode(buffer);
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
buffer.append(GREATER_THAN);
}
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
return buffer;
}
/**
* Conveniance accessor function to get the hostPort field from the address.
* Warning -- this assumes that the embedded URI is a SipURL.
*
* @return hostport field
*/
public HostPort getHostPort() {
return address.getHostPort();
}
/**
* Get the display name from the address.
* @return Display name
*/
public String getDisplayName() {
return address.getDisplayName();
}
/**
* Get the tag parameter from the address parm list.
* @return tag field
*/
public String getTag() {
if (parameters == null)
return null;
return getParameter(ParameterNames.TAG);
}
/** Boolean function
* @return true if the Tag exist
*/
public boolean hasTag() {
return hasParameter(ParameterNames.TAG);
}
/** remove Tag member
*/
public void removeTag() {
parameters.delete(ParameterNames.TAG);
}
/**
* Set the address member
* @param address Address to set
*/
public void setAddress(javax.sip.address.Address address) {
this.address = (AddressImpl) address;
}
/**
* Set the tag member
* @param t tag to set. From tags are mandatory.
*/
public void setTag(String t) throws ParseException {
// JvB: check that it is a valid token
Parser.checkToken(t);
this.setParameter(ParameterNames.TAG, t);
}
/** Get the user@host port string.
*/
public String getUserAtHostPort() {
return address.getUserAtHostPort();
}
public boolean equals(Object other) {
return (other instanceof FromHeader) && super.equals(other);
}
}
java/gov/nist/javax/sip/header/HeaderExt.java 0100644 0000000 0000000 00000002331 13513104763 020150 0 ustar 00 0000000 0000000 /*
* JBoss, Home of Professional Open Source
* This code has been contributed to the public domain by the author.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*/
package gov.nist.javax.sip.header;
import javax.sip.header.Header;
/**
* Extensions to the Header interface supported by the implementation and
* will be included in the next spec release.
*
* @author jean.deruelle@gmail.com
*
*/
public interface HeaderExt extends Header {
/**
* Gets the header value (i.e. what follows the name:) as a string
* @return the header value (i.e. what follows the name:)
* @since 2.0
*/
public String getValue();
}
java/gov/nist/javax/sip/header/HeaderFactoryExt.java 0100644 0000000 0000000 00000020637 13513104763 021511 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header;
import java.text.ParseException;
import gov.nist.javax.sip.header.extensions.JoinHeader;
import gov.nist.javax.sip.header.extensions.ReferredByHeader;
import gov.nist.javax.sip.header.extensions.ReplacesHeader;
import gov.nist.javax.sip.header.extensions.SessionExpiresHeader;
import gov.nist.javax.sip.header.ims.PAccessNetworkInfoHeader;
import gov.nist.javax.sip.header.ims.PAssertedIdentityHeader;
import gov.nist.javax.sip.header.ims.PAssertedServiceHeader;
import gov.nist.javax.sip.header.ims.PAssociatedURIHeader;
import gov.nist.javax.sip.header.ims.PCalledPartyIDHeader;
import gov.nist.javax.sip.header.ims.PChargingFunctionAddressesHeader;
import gov.nist.javax.sip.header.ims.PChargingVectorHeader;
import gov.nist.javax.sip.header.ims.PMediaAuthorizationHeader;
import gov.nist.javax.sip.header.ims.PPreferredIdentityHeader;
import gov.nist.javax.sip.header.ims.PPreferredServiceHeader;
import gov.nist.javax.sip.header.ims.PProfileKeyHeader;
import gov.nist.javax.sip.header.ims.PServedUserHeader;
import gov.nist.javax.sip.header.ims.PUserDatabaseHeader;
import gov.nist.javax.sip.header.ims.PVisitedNetworkIDHeader;
import gov.nist.javax.sip.header.ims.PathHeader;
import gov.nist.javax.sip.header.ims.PrivacyHeader;
import gov.nist.javax.sip.header.ims.SecurityClientHeader;
import gov.nist.javax.sip.header.ims.SecurityServerHeader;
import gov.nist.javax.sip.header.ims.SecurityVerifyHeader;
import gov.nist.javax.sip.header.ims.ServiceRouteHeader;
import javax.sip.InvalidArgumentException;
import javax.sip.address.Address;
import javax.sip.header.Header;
import javax.sip.header.HeaderFactory;
/**
* Header factory extensions. These will be included in the next release of
* JAIN-SIP.
*
* @since 2.0
*
*/
public interface HeaderFactoryExt extends HeaderFactory {
/**
* Create a RequestLine from a String
* @throws ParseException
*/
public SipRequestLine createRequestLine(String requestLine) throws ParseException;
/**
* Create a StatusLine from a String.
*/
public SipStatusLine createStatusLine(String statusLine) throws ParseException;
/**
* Create a ReferredBy Header.
*
* @param address --
* address for the header.
*
*/
public ReferredByHeader createReferredByHeader(Address address);
/**
*
* Create a Replaces header with a call Id, to and from tag.
*
* @param callId -
* the call id to use.
* @param toTag -
* the to tag to use.
* @param fromTag -
* the fromTag to use.
*
*/
public ReplacesHeader createReplacesHeader(String callId, String toTag,
String fromTag) throws ParseException;
/**
* creates a P-Access-Network-Info header.
*
* @return newly created P-Access-Network-Info header
*/
public PAccessNetworkInfoHeader createPAccessNetworkInfoHeader();
/**
* P-Asserted-Identity header
*
* @param address -
* Address
* @return newly created P-Asserted-Identity header
* @throws ParseException
* @throws NullPointerException
*/
public PAssertedIdentityHeader createPAssertedIdentityHeader(Address address)
throws NullPointerException, ParseException;
/**
* Creates a new P-Associated-URI header based on the supplied address
*
* @param assocURI -
* Address
* @return newly created P-Associated-URI header
* @throws NullPointerException
* if the supplied address is null
* @throws ParseException
*/
public PAssociatedURIHeader createPAssociatedURIHeader(Address assocURI);
/**
* P-Called-Party-ID header
*
* @param address -
* Address
* @return newly created P-Called-Party-ID header
* @throws NullPointerException
* @throws ParseException
*/
public PCalledPartyIDHeader createPCalledPartyIDHeader(Address address);
/**
* P-Charging-Function-Addresses header
*
* @return newly created P-Charging-Function-Addresses header
*/
public PChargingFunctionAddressesHeader createPChargingFunctionAddressesHeader();
/**
* P-Charging-Vector header
*
* @param icid -
* icid string
* @return newly created P-Charging-Vector header
* @throws NullPointerException
* @throws ParseException
*/
public PChargingVectorHeader createChargingVectorHeader(String icid) throws ParseException;
/**
* P-Media-Authorization header
* @param token - token string
* @return newly created P-Media-Authorizarion header
* @throws InvalidArgumentException
* @throws ParseException
*/
public PMediaAuthorizationHeader createPMediaAuthorizationHeader(String token)
throws InvalidArgumentException, ParseException;
/**
* P-Preferred-Identity header
* @param address - Address
* @return newly created P-Preferred-Identity header
* @throws NullPointerException
*/
public PPreferredIdentityHeader createPPreferredIdentityHeader(Address address);
/**
* P-Visited-Network-ID header
* @return newly created P-Visited-Network-ID header
*/
public PVisitedNetworkIDHeader createPVisitedNetworkIDHeader();
/**
* PATH header
* @param address - Address
* @return newly created Path header
* @throws NullPointerException
* @throws ParseException
*/
public PathHeader createPathHeader(Address address);
/**
* Privacy header
* @param privacyType - privacy type string
* @return newly created Privacy header
* @throws NullPointerException
*/
public PrivacyHeader createPrivacyHeader(String privacyType);
/**
* Service-Route header
* @param address - Address
* @return newly created Service-Route header
* @throws NullPointerException
*/
public ServiceRouteHeader createServiceRouteHeader(Address address);
/**
* Security-Server header
* @return newly created Security-Server header
*/
public SecurityServerHeader createSecurityServerHeader();
/**
* Security-Client header
* @return newly created Security-Client header
*/
public SecurityClientHeader createSecurityClientHeader();
/**
* Security-Verify header
* @return newly created Security-Verify header
*/
public SecurityVerifyHeader createSecurityVerifyHeader();
/**
* Creates a new SessionExpiresHeader based on the newly supplied expires value.
*
* @param expires - the new integer value of the expires.
* @throws InvalidArgumentException if supplied expires is less
* than zero.
* @return the newly created SessionExpiresHeader object.
*
*/
public SessionExpiresHeader createSessionExpiresHeader(int expires) throws InvalidArgumentException ;
/**
*
* Create a Join header with a call Id, to and from tag.
*
* @param callId -
* the call id to use.
* @param toTag -
* the to tag to use.
* @param fromTag -
* the fromTag to use.
*
*/
public JoinHeader createJoinHeader(String callId, String toTag,
String fromTag) throws ParseException;
/**
*
* @return the newly created P-User-Database header
* @param the database name, that may be an IP:port or a domain name.
*/
public PUserDatabaseHeader createPUserDatabaseHeader(String databaseName);
/**
*
* @param address
* @return The newly created P-Profile-Key header
*/
public PProfileKeyHeader createPProfileKeyHeader(Address address);
/**
* @param address of the served user.
* @return The newly created P-Served-User Header.
*/
public PServedUserHeader createPServedUserHeader(Address address);
/**
*
* @return The newly created P-Preferred-Service Header.
*/
public PPreferredServiceHeader createPPreferredServiceHeader();
/**
*
* @return The newly created P-Asserted-Service Header.
*/
public PAssertedServiceHeader createPAssertedServiceHeader();
/**
* Create a header from a string. The string is assumed to be in the
* name:value format. The trailing CRLF (if any ) will be stripped
* before parsing this. The header should be a singleton.
*/
public Header createHeader(String header) throws ParseException;
}
java/gov/nist/javax/sip/header/HeaderFactoryImpl.java 0100644 0000000 0000000 00000157372 13513104763 021661 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.header.ims.*; /* IMS headers - issued by Miguel Freitas */
import gov.nist.javax.sip.header.extensions.*; // extension headers - pmusgrave
import javax.sip.header.*;
import gov.nist.javax.sip.parser.*;
import gov.nist.javax.sip.parser.extensions.ReferencesParser;
import javax.sip.address.*;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import java.util.*;
import gov.nist.javax.sip.address.*;
/*
* This file contains enhancements contributed by Alexandre Silva Santos
* (PT-Inovacao) and Miguel Freitas
*/
/** Implementation of the JAIN SIP HeaderFactory
*
* @version 1.2 $Revision: 1.22 $ $Date: 2010/01/12 18:58:48 $
* @since 1.1
*
*@author M. Ranganathan
*@author Olivier Deruelle
*
*
*/
public class HeaderFactoryImpl implements HeaderFactory , HeaderFactoryExt {
/**
* Determines whether or not we should tolerate and strip address scope
* zones from IPv6 addresses. Address scope zones are sometimes returned
* at the end of IPv6 addresses generated by InetAddress.getHostAddress().
* They are however not part of the SIP semantics so basically this method
* determines whether or not the parser should be stripping them (as
* opposed simply being blunt and throwing an exception).
*/
private boolean stripAddressScopeZones = false;
/**
* Set pretty encoding on / off.
* This splits up via headers into multiple lines for readability ( better for
* debugging ).
*
*/
public void setPrettyEncoding(boolean flag) {
SIPHeaderList.setPrettyEncode(flag);
}
/**
* Creates a new AcceptEncodingHeader based on the newly supplied encoding
* value.
*
* @param encoding - the new string containing the encoding value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the encoding value.
* @return the newly created AcceptEncodingHeader object.
*/
public AcceptEncodingHeader createAcceptEncodingHeader(String encoding)
throws ParseException {
if (encoding == null)
throw new NullPointerException("the encoding parameter is null");
AcceptEncoding acceptEncoding = new AcceptEncoding();
acceptEncoding.setEncoding(encoding);
return acceptEncoding;
}
/**
* Creates a new AcceptHeader based on the newly supplied contentType and
* contentSubType values.
*
* @param contentType The new string content type value.
* @param contentSubType The new string content sub-type value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the content type or content subtype value.
* @return the newly created AcceptHeader object.
*/
public AcceptHeader createAcceptHeader(
String contentType,
String contentSubType)
throws ParseException {
if (contentType == null || contentSubType == null)
throw new NullPointerException("contentType or subtype is null ");
Accept accept = new Accept();
accept.setContentType(contentType);
accept.setContentSubType(contentSubType);
return accept;
}
/**
* Creates a new AcceptLanguageHeader based on the newly supplied
* language value.
*
* @param language - the new Locale value of the language
* @return the newly created AcceptLanguageHeader object.
*/
public AcceptLanguageHeader createAcceptLanguageHeader(Locale language) {
if (language == null)
throw new NullPointerException("null arg");
AcceptLanguage acceptLanguage = new AcceptLanguage();
acceptLanguage.setAcceptLanguage(language);
return acceptLanguage;
}
/**
* Creates a new AlertInfoHeader based on the newly supplied alertInfo value.
*
* @param alertInfo - the new URI value of the alertInfo
* @return the newly created AlertInfoHeader object.
* @since v1.1
*/
public AlertInfoHeader createAlertInfoHeader(URI alertInfo) {
if (alertInfo == null)
throw new NullPointerException("null arg alertInfo");
AlertInfo a = new AlertInfo();
a.setAlertInfo(alertInfo);
return a;
}
/**
* Creates a new AllowEventsHeader based on the newly supplied event type
* value.
*
* @param eventType - the new string containing the eventType value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the eventType value.
* @return the newly created AllowEventsHeader object.
* @since v1.1
*/
public AllowEventsHeader createAllowEventsHeader(String eventType)
throws ParseException {
if (eventType == null)
throw new NullPointerException("null arg eventType");
AllowEvents allowEvents = new AllowEvents();
allowEvents.setEventType(eventType);
return allowEvents;
}
/**
* Creates a new AllowHeader based on the newly supplied method value.
*
* @param method - the new string containing the method value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the method value.
* @return the newly created AllowHeader object.
*/
public AllowHeader createAllowHeader(String method) throws ParseException {
if (method == null)
throw new NullPointerException("null arg method");
Allow allow = new Allow();
allow.setMethod(method);
return allow;
}
/**
* Creates a new AuthenticationInfoHeader based on the newly supplied
* response value.
*
* @param response - the new string value of the response.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the response value.
* @return the newly created AuthenticationInfoHeader object.
* @since v1.1
*/
public AuthenticationInfoHeader createAuthenticationInfoHeader(String response)
throws ParseException {
if (response == null)
throw new NullPointerException("null arg response");
AuthenticationInfo auth = new AuthenticationInfo();
auth.setResponse(response);
return auth;
}
/**
* Creates a new AuthorizationHeader based on the newly supplied
* scheme value.
*
* @param scheme - the new string value of the scheme.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the scheme value.
* @return the newly created AuthorizationHeader object.
*/
public AuthorizationHeader createAuthorizationHeader(String scheme)
throws ParseException {
if (scheme == null)
throw new NullPointerException("null arg scheme ");
Authorization auth = new Authorization();
auth.setScheme(scheme);
return auth;
}
/**
* Creates a new CSeqHeader based on the newly supplied sequence number and
* method values.
*
* @param sequenceNumber - the new integer value of the sequence number.
* @param method - the new string value of the method.
* @throws InvalidArgumentException if supplied sequence number is less
* than zero.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the method value.
* @return the newly created CSeqHeader object.
*/
public CSeqHeader createCSeqHeader( long sequenceNumber, String method)
throws ParseException, InvalidArgumentException {
if (sequenceNumber < 0)
throw new InvalidArgumentException("bad arg " + sequenceNumber);
if (method == null)
throw new NullPointerException("null arg method");
CSeq cseq = new CSeq();
cseq.setMethod(method);
cseq.setSeqNumber(sequenceNumber);
return cseq;
}
/**
* For backwards compatibility, also accept int
* @deprecated
*/
public CSeqHeader createCSeqHeader( int sequenceNumber, String method)
throws ParseException, InvalidArgumentException {
return this.createCSeqHeader( (long) sequenceNumber, method );
}
/**
* Creates a new CallIdHeader based on the newly supplied callId value.
*
* @param callId - the new string value of the call-id.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the callId value.
* @return the newly created CallIdHeader object.
*/
public CallIdHeader createCallIdHeader(String callId)
throws ParseException {
if (callId == null)
throw new NullPointerException("null arg callId");
CallID c = new CallID();
c.setCallId(callId);
return c;
}
/**
* Creates a new CallInfoHeader based on the newly supplied callInfo value.
*
* @param callInfo The new string value of the callInfo.
* @return the newly created CallInfoHeader object.
*/
public CallInfoHeader createCallInfoHeader(URI callInfo) {
if (callInfo == null)
throw new NullPointerException("null arg callInfo");
CallInfo c = new CallInfo();
c.setInfo(callInfo);
return c;
}
/**
* Creates a new ContactHeader based on the newly supplied address value.
*
* @param address - the new Address value of the address.
* @return the newly created ContactHeader object.
*/
public ContactHeader createContactHeader(Address address) {
if (address == null)
throw new NullPointerException("null arg address");
Contact contact = new Contact();
contact.setAddress(address);
return contact;
}
/**
* Creates a new wildcard ContactHeader. This is used in Register requests
* to indicate to the server that it should remove all locations the
* at which the user is currently available. This implies that the
* following conditions are met:
*
* ContactHeader.getAddress.getAddress.getUserInfo() == *;
* ContactHeader.getAddress.getAddress.isWildCard() == true;
* ContactHeader.getExpires() == 0;
*
*
* @return the newly created wildcard ContactHeader.
*/
public ContactHeader createContactHeader() {
Contact contact = new Contact();
contact.setWildCardFlag(true);
contact.setExpires(0);
return contact;
}
/**
* Creates a new ContentDispositionHeader based on the newly supplied
* contentDisposition value.
*
* @param contentDisposition - the new string value of the contentDisposition.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the contentDisposition value.
* @return the newly created ContentDispositionHeader object.
* @since v1.1
*/
public ContentDispositionHeader createContentDispositionHeader(String contentDisposition)
throws ParseException {
if (contentDisposition == null)
throw new NullPointerException("null arg contentDisposition");
ContentDisposition c = new ContentDisposition();
c.setDispositionType(contentDisposition);
return c;
}
/**
* Creates a new ContentEncodingHeader based on the newly supplied encoding
* value.
*
* @param encoding - the new string containing the encoding value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the encoding value.
* @return the newly created ContentEncodingHeader object.
*/
public ContentEncodingHeader createContentEncodingHeader(String encoding)
throws ParseException {
if (encoding == null)
throw new NullPointerException("null encoding");
ContentEncoding c = new ContentEncoding();
c.setEncoding(encoding);
return c;
}
/**
* Creates a new ContentLanguageHeader based on the newly supplied
* contentLanguage value.
*
* @param contentLanguage - the new Locale value of the contentLanguage.
* @return the newly created ContentLanguageHeader object.
* @since v1.1
*/
public ContentLanguageHeader createContentLanguageHeader(Locale contentLanguage) {
if (contentLanguage == null)
throw new NullPointerException("null arg contentLanguage");
ContentLanguage c = new ContentLanguage();
c.setContentLanguage(contentLanguage);
return c;
}
/**
* Creates a new CSeqHeader based on the newly supplied contentLength value.
*
* @param contentLength - the new integer value of the contentLength.
* @throws InvalidArgumentException if supplied contentLength is less
* than zero.
* @return the newly created ContentLengthHeader object.
*/
public ContentLengthHeader createContentLengthHeader(int contentLength)
throws InvalidArgumentException {
if (contentLength < 0)
throw new InvalidArgumentException("bad contentLength");
ContentLength c = new ContentLength();
c.setContentLength(contentLength);
return c;
}
/**
* Creates a new ContentTypeHeader based on the newly supplied contentType and
* contentSubType values.
*
* @param contentType - the new string content type value.
* @param contentSubType - the new string content sub-type value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the content type or content subtype value.
* @return the newly created ContentTypeHeader object.
*/
public ContentTypeHeader createContentTypeHeader(
String contentType,
String contentSubType)
throws ParseException {
if (contentType == null || contentSubType == null)
throw new NullPointerException("null contentType or subType");
ContentType c = new ContentType();
c.setContentType(contentType);
c.setContentSubType(contentSubType);
return c;
}
/**
* Creates a new DateHeader based on the newly supplied date value.
*
* @param date - the new Calender value of the date.
* @return the newly created DateHeader object.
*/
public DateHeader createDateHeader(Calendar date) {
SIPDateHeader d = new SIPDateHeader();
if (date == null)
throw new NullPointerException("null date");
d.setDate(date);
return d;
}
/**
* Creates a new EventHeader based on the newly supplied eventType value.
*
* @param eventType - the new string value of the eventType.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the eventType value.
* @return the newly created EventHeader object.
* @since v1.1
*/
public EventHeader createEventHeader(String eventType)
throws ParseException {
if (eventType == null)
throw new NullPointerException("null eventType");
Event event = new Event();
event.setEventType(eventType);
return event;
}
/**
* Creates a new ExpiresHeader based on the newly supplied expires value.
*
* @param expires - the new integer value of the expires.
* @throws InvalidArgumentException if supplied expires is less
* than zero.
* @return the newly created ExpiresHeader object.
*/
public ExpiresHeader createExpiresHeader(int expires)
throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException("bad value " + expires);
Expires e = new Expires();
e.setExpires(expires);
return e;
}
/**
* Creates a new ExtensionHeader based on the newly supplied name and
* value values.
*
* @param name - the new string name of the ExtensionHeader value.
* @param value - the new string value of the ExtensionHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the name or value values.
* @return the newly created ExtensionHeader object.
*/
public javax.sip.header.ExtensionHeader createExtensionHeader(
String name,
String value)
throws ParseException {
if (name == null)
throw new NullPointerException("bad name");
gov.nist.javax.sip.header.ExtensionHeaderImpl ext =
new gov.nist.javax.sip.header.ExtensionHeaderImpl();
ext.setName(name);
ext.setValue(value);
return ext;
}
/**
* Creates a new FromHeader based on the newly supplied address and
* tag values.
*
* @param address - the new Address object of the address.
* @param tag - the new string value of the tag.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the tag value.
* @return the newly created FromHeader object.
*/
public FromHeader createFromHeader(Address address, String tag)
throws ParseException {
if (address == null)
throw new NullPointerException("null address arg");
From from = new From();
from.setAddress(address);
if (tag != null)
from.setTag(tag);
return from;
}
/**
* Creates a new InReplyToHeader based on the newly supplied callId
* value.
*
* @param callId - the new string containing the callId value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the callId value.
* @return the newly created InReplyToHeader object.
* @since v1.1
*/
public InReplyToHeader createInReplyToHeader(String callId)
throws ParseException {
if (callId == null)
throw new NullPointerException("null callId arg");
InReplyTo inReplyTo = new InReplyTo();
inReplyTo.setCallId(callId);
return inReplyTo;
}
/**
* Creates a new MaxForwardsHeader based on the newly
* supplied maxForwards value.
*
* @param maxForwards The new integer value of the maxForwards.
* @throws InvalidArgumentException if supplied maxForwards is less
* than zero or greater than 255.
* @return the newly created MaxForwardsHeader object.
*/
public MaxForwardsHeader createMaxForwardsHeader(int maxForwards)
throws InvalidArgumentException {
if (maxForwards < 0 || maxForwards > 255)
throw new InvalidArgumentException(
"bad maxForwards arg " + maxForwards);
MaxForwards m = new MaxForwards();
m.setMaxForwards(maxForwards);
return m;
}
/**
* Creates a new MimeVersionHeader based on the newly
* supplied mimeVersion value.
*
* @param majorVersion - the new integer value of the majorVersion.
* @param minorVersion - the new integer value of the minorVersion.
* @throws InvalidArgumentException if supplied mimeVersion is less
* than zero.
* @return the newly created MimeVersionHeader object.
* @since v1.1
*/
public MimeVersionHeader createMimeVersionHeader(
int majorVersion,
int minorVersion)
throws InvalidArgumentException {
if (majorVersion < 0 || minorVersion < 0)
throw new javax.sip.InvalidArgumentException(
"bad major/minor version");
MimeVersion m = new MimeVersion();
m.setMajorVersion(majorVersion);
m.setMinorVersion(minorVersion);
return m;
}
/**
* Creates a new MinExpiresHeader based on the newly supplied minExpires value.
*
* @param minExpires - the new integer value of the minExpires.
* @throws InvalidArgumentException if supplied minExpires is less
* than zero.
* @return the newly created MinExpiresHeader object.
* @since v1.1
*/
public MinExpiresHeader createMinExpiresHeader(int minExpires)
throws InvalidArgumentException {
if (minExpires < 0)
throw new InvalidArgumentException("bad minExpires " + minExpires);
MinExpires min = new MinExpires();
min.setExpires(minExpires);
return min;
}
/**
* Creates a new MinSEHeader based on the newly supplied expires value.
*
* @param expires - the new integer value of the expires.
* @throws InvalidArgumentException if supplied expires is less
* than zero.
* @return the newly created ExpiresHeader object.
*
* TODO: Once interfaces are in javax, change the type to MinSEHeader
* and add to HeaderFactory. - pmusgrave
*
* pmusgrave
*/
public ExtensionHeader createMinSEHeader(int expires)
throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException("bad value " + expires);
MinSE e = new MinSE();
e.setExpires(expires);
return e;
}
/**
* Creates a new OrganizationHeader based on the newly supplied
* organization value.
*
* @param organization - the new string value of the organization.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the organization value.
* @return the newly created OrganizationHeader object.
*/
public OrganizationHeader createOrganizationHeader(String organization)
throws ParseException {
if (organization == null)
throw new NullPointerException("bad organization arg");
Organization o = new Organization();
o.setOrganization(organization);
return o;
}
/**
* Creates a new PriorityHeader based on the newly supplied priority value.
*
* @param priority - the new string value of the priority.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the priority value.
* @return the newly created PriorityHeader object.
*/
public PriorityHeader createPriorityHeader(String priority)
throws ParseException {
if (priority == null)
throw new NullPointerException("bad priority arg");
Priority p = new Priority();
p.setPriority(priority);
return p;
}
/**
* Creates a new ProxyAuthenticateHeader based on the newly supplied
* scheme value.
*
* @param scheme - the new string value of the scheme.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the scheme value.
* @return the newly created ProxyAuthenticateHeader object.
*/
public ProxyAuthenticateHeader createProxyAuthenticateHeader(String scheme)
throws ParseException {
if (scheme == null)
throw new NullPointerException("bad scheme arg");
ProxyAuthenticate p = new ProxyAuthenticate();
p.setScheme(scheme);
return p;
}
/**
* Creates a new ProxyAuthorizationHeader based on the newly supplied
* scheme value.
*
* @param scheme - the new string value of the scheme.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the scheme value.
* @return the newly created ProxyAuthorizationHeader object.
*/
public ProxyAuthorizationHeader createProxyAuthorizationHeader(String scheme)
throws ParseException {
if (scheme == null)
throw new NullPointerException("bad scheme arg");
ProxyAuthorization p = new ProxyAuthorization();
p.setScheme(scheme);
return p;
}
/**
* Creates a new ProxyRequireHeader based on the newly supplied optionTag
* value.
*
* @param optionTag - the new string OptionTag value.
* @return the newly created ProxyRequireHeader object.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the optionTag value.
*/
public ProxyRequireHeader createProxyRequireHeader(String optionTag)
throws ParseException {
if (optionTag == null)
throw new NullPointerException("bad optionTag arg");
ProxyRequire p = new ProxyRequire();
p.setOptionTag(optionTag);
return p;
}
/**
* Creates a new RAckHeader based on the newly supplied rSeqNumber,
* cSeqNumber and method values.
*
* @param rSeqNumber - the new integer value of the rSeqNumber.
* @param cSeqNumber - the new integer value of the cSeqNumber.
* @param method - the new string value of the method.
* @throws InvalidArgumentException if supplied rSeqNumber or cSeqNumber is
* less than zero or greater than than 2**31-1.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the method value.
* @return the newly created RAckHeader object.
* @since v1.1
*/
public RAckHeader createRAckHeader(
long rSeqNumber,
long cSeqNumber,
String method)
throws InvalidArgumentException, ParseException {
if (method == null)
throw new NullPointerException("Bad method");
if (cSeqNumber < 0 || rSeqNumber < 0)
throw new InvalidArgumentException("bad cseq/rseq arg");
RAck rack = new RAck();
rack.setMethod(method);
rack.setCSequenceNumber(cSeqNumber);
rack.setRSequenceNumber(rSeqNumber);
return rack;
}
/**
* @deprecated
* @see javax.sip.header.HeaderFactory#createRAckHeader(int, int, java.lang.String)
*/
public RAckHeader createRAckHeader(int rSeqNumber, int cSeqNumber, String method) throws InvalidArgumentException, ParseException {
return createRAckHeader((long)rSeqNumber, (long)cSeqNumber, method);
}
/**
* @deprecated
* @see javax.sip.header.HeaderFactory#createRSeqHeader(int)
*/
public RSeqHeader createRSeqHeader(int sequenceNumber) throws InvalidArgumentException {
return createRSeqHeader((long) sequenceNumber) ;
}
/**
* Creates a new RSeqHeader based on the newly supplied sequenceNumber value.
*
* @param sequenceNumber - the new integer value of the sequenceNumber.
* @throws InvalidArgumentException if supplied sequenceNumber is
* less than zero or greater than than 2**31-1.
* @return the newly created RSeqHeader object.
* @since v1.1
*/
public RSeqHeader createRSeqHeader(long sequenceNumber)
throws InvalidArgumentException {
if (sequenceNumber < 0)
throw new InvalidArgumentException(
"invalid sequenceNumber arg " + sequenceNumber);
RSeq rseq = new RSeq();
rseq.setSeqNumber(sequenceNumber);
return rseq;
}
/**
* Creates a new ReasonHeader based on the newly supplied reason value.
*
* @param protocol - the new string value of the protocol.
* @param cause - the new integer value of the cause.
* @param text - the new string value of the text.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the protocol, cause or text value.
* @return the newly created ReasonHeader object.
* @since v1.1
*/
public ReasonHeader createReasonHeader(
String protocol,
int cause,
String text)
throws InvalidArgumentException, ParseException {
if (protocol == null)
throw new NullPointerException("bad protocol arg");
if (cause < 0)
throw new InvalidArgumentException("bad cause");
Reason reason = new Reason();
reason.setProtocol(protocol);
reason.setCause(cause);
reason.setText(text);
return reason;
}
/**
* Creates a new RecordRouteHeader based on the newly supplied address value.
*
* @param address - the new Address object of the address.
* @return the newly created RecordRouteHeader object.
*/
public RecordRouteHeader createRecordRouteHeader(Address address) {
if ( address == null) throw new NullPointerException("Null argument!");
RecordRoute recordRoute = new RecordRoute();
recordRoute.setAddress(address);
return recordRoute;
}
/**
* Creates a new ReplyToHeader based on the newly supplied address value.
*
* @param address - the new Address object of the address.
* @return the newly created ReplyToHeader object.
* @since v1.1
*/
public ReplyToHeader createReplyToHeader(Address address) {
if (address == null)
throw new NullPointerException("null address");
ReplyTo replyTo = new ReplyTo();
replyTo.setAddress(address);
return replyTo;
}
/**
* Creates a new RequireHeader based on the newly supplied optionTag
* value.
*
* @param optionTag - the new string value containing the optionTag value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the List of optionTag value.
* @return the newly created RequireHeader object.
*/
public RequireHeader createRequireHeader(String optionTag)
throws ParseException {
if (optionTag == null)
throw new NullPointerException("null optionTag");
Require require = new Require();
require.setOptionTag(optionTag);
return require;
}
/**
* Creates a new RetryAfterHeader based on the newly supplied retryAfter
* value.
*
* @param retryAfter - the new integer value of the retryAfter.
* @throws InvalidArgumentException if supplied retryAfter is less
* than zero.
* @return the newly created RetryAfterHeader object.
*/
public RetryAfterHeader createRetryAfterHeader(int retryAfter)
throws InvalidArgumentException {
if (retryAfter < 0)
throw new InvalidArgumentException("bad retryAfter arg");
RetryAfter r = new RetryAfter();
r.setRetryAfter(retryAfter);
return r;
}
/**
* Creates a new RouteHeader based on the newly supplied address value.
*
* @param address - the new Address object of the address.
* @return the newly created RouteHeader object.
*/
public RouteHeader createRouteHeader(Address address) {
if (address == null)
throw new NullPointerException("null address arg");
Route route = new Route();
route.setAddress(address);
return route;
}
/**
* Creates a new ServerHeader based on the newly supplied product value.
*
* @param product - the new list value of the product.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the product value.
* @return the newly created ServerHeader object.
*/
public ServerHeader createServerHeader(List product)
throws ParseException {
if (product == null)
throw new NullPointerException("null productList arg");
Server server = new Server();
server.setProduct(product);
return server;
}
/**
* Creates a new SubjectHeader based on the newly supplied subject value.
*
* @param subject - the new string value of the subject.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the subject value.
* @return the newly created SubjectHeader object.
*/
public SubjectHeader createSubjectHeader(String subject)
throws ParseException {
if (subject == null)
throw new NullPointerException("null subject arg");
Subject s = new Subject();
s.setSubject(subject);
return s;
}
/**
* Creates a new SubscriptionStateHeader based on the newly supplied
* subscriptionState value.
*
* @param subscriptionState - the new string value of the subscriptionState.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the subscriptionState value.
* @return the newly created SubscriptionStateHeader object.
* @since v1.1
*/
public SubscriptionStateHeader createSubscriptionStateHeader(String subscriptionState)
throws ParseException {
if (subscriptionState == null)
throw new NullPointerException("null subscriptionState arg");
SubscriptionState s = new SubscriptionState();
s.setState(subscriptionState);
return s;
}
/**
* Creates a new SupportedHeader based on the newly supplied optionTag
* value.
*
* @param optionTag - the new string containing the optionTag value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the optionTag value.
* @return the newly created SupportedHeader object.
*/
public SupportedHeader createSupportedHeader(String optionTag)
throws ParseException {
if (optionTag == null)
throw new NullPointerException("null optionTag arg");
Supported supported = new Supported();
supported.setOptionTag(optionTag);
return supported;
}
/**
* Creates a new TimeStampHeader based on the newly supplied timeStamp value.
*
* @param timeStamp - the new float value of the timeStamp.
* @throws InvalidArgumentException if supplied timeStamp is less
* than zero.
* @return the newly created TimeStampHeader object.
*/
public TimeStampHeader createTimeStampHeader(float timeStamp)
throws InvalidArgumentException {
if (timeStamp < 0)
throw new IllegalArgumentException("illegal timeStamp");
TimeStamp t = new TimeStamp();
t.setTimeStamp(timeStamp);
return t;
}
/**
* Creates a new ToHeader based on the newly supplied address and
* tag values.
*
* @param address - the new Address object of the address.
* @param tag - the new string value of the tag.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the tag value.
* @return the newly created ToHeader object.
*/
public ToHeader createToHeader(Address address, String tag)
throws ParseException {
if (address == null)
throw new NullPointerException("null address");
To to = new To();
to.setAddress(address);
if (tag != null)
to.setTag(tag);
return to;
}
/**
* Creates a new UnsupportedHeader based on the newly supplied optionTag
* value.
*
* @param optionTag - the new string containing the optionTag value.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the List of optionTag value.
* @return the newly created UnsupportedHeader object.
*/
public UnsupportedHeader createUnsupportedHeader(String optionTag)
throws ParseException {
if (optionTag == null)
throw new NullPointerException(optionTag);
Unsupported unsupported = new Unsupported();
unsupported.setOptionTag(optionTag);
return unsupported;
}
/**
* Creates a new UserAgentHeader based on the newly supplied product value.
*
* @param product - the new list value of the product.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the product value.
* @return the newly created UserAgentHeader object.
*/
public UserAgentHeader createUserAgentHeader(List product)
throws ParseException {
if (product == null)
throw new NullPointerException("null user agent");
UserAgent userAgent = new UserAgent();
userAgent.setProduct(product);
return userAgent;
}
/**
* Creates a new ViaHeader based on the newly supplied uri and branch values.
*
* @param host the new host value of uri.
* @param port the new port value of uri.
* @param transport the new transport value of uri.
* @param branch the new string value of the branch.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the branch value.
* @return the newly created ViaHeader object.
*/
public ViaHeader createViaHeader(
String host,
int port,
String transport,
String branch)
throws ParseException, InvalidArgumentException {
// This should be changed.
if (host == null || transport == null)
throw new NullPointerException("null arg");
Via via = new Via();
if (branch != null)
via.setBranch(branch);
// for supporting IPv6 addresses
if(host.indexOf(':') >= 0
&& host.indexOf('[') < 0)
{
//strip address scope zones if any
if(stripAddressScopeZones)
{
int zoneStart = host.indexOf('%');
if(zoneStart != -1)
host = host.substring(0, zoneStart);
}
host = '[' + host + ']';
}
via.setHost(host);
via.setPort(port);
via.setTransport(transport);
return via;
}
/**
* Creates a new WWWAuthenticateHeader based on the newly supplied
* scheme value.
*
* @param scheme - the new string value of the scheme.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the scheme values.
* @return the newly created WWWAuthenticateHeader object.
*/
public WWWAuthenticateHeader createWWWAuthenticateHeader(String scheme)
throws ParseException {
if (scheme == null)
throw new NullPointerException("null scheme");
WWWAuthenticate www = new WWWAuthenticate();
www.setScheme(scheme);
return www;
}
/**
* Creates a new WarningHeader based on the newly supplied
* agent, code and comment values.
*
* @param agent - the new string value of the agent.
* @param code - the new boolean integer of the code.
* @param comment - the new string value of the comment.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the agent or comment values.
* @throws InvalidArgumentException if an invalid integer code is given for
* the WarningHeader.
* @return the newly created WarningHeader object.
*/
public WarningHeader createWarningHeader(
String agent,
int code,
String comment)
throws ParseException, InvalidArgumentException {
if (agent == null)
throw new NullPointerException("null arg");
Warning warning = new Warning();
warning.setAgent(agent);
warning.setCode(code);
warning.setText(comment);
return warning;
}
/** Creates a new ErrorInfoHeader based on the newly
* supplied errorInfo value.
*
* @param errorInfo - the new URI value of the errorInfo.
* @return the newly created ErrorInfoHeader object.
*/
public ErrorInfoHeader createErrorInfoHeader(URI errorInfo) {
if (errorInfo == null)
throw new NullPointerException("null arg");
return new ErrorInfo((GenericURI) errorInfo);
}
/**
* Create a header from the given header text.
* Header should not have the trailng crlf.
* @throws ParseException
*/
public javax.sip.header.Header createHeader(String headerText) throws ParseException {
StringMsgParser smp = new StringMsgParser();
SIPHeader sipHeader = smp.parseSIPHeader(headerText.trim());
if (sipHeader instanceof SIPHeaderList) {
if (((SIPHeaderList) sipHeader).size() > 1) {
throw new ParseException(
"Only singleton allowed " + headerText,
0);
} else if (((SIPHeaderList) sipHeader).size() == 0) {
try {
return (Header) ((SIPHeaderList) sipHeader)
.getMyClass()
.newInstance();
} catch (InstantiationException ex) {
ex.printStackTrace();
return null;
} catch (IllegalAccessException ex) {
ex.printStackTrace();
return null;
}
} else {
return (Header) ((SIPHeaderList) sipHeader).getFirst();
}
} else {
return (Header) sipHeader;
}
}
/** Create and parse a header.
*
* @param headerName -- header name for the header to parse.
* @param headerValue -- header value for the header to parse.
* @throws ParseException
* @return the parsed sip header
*/
public javax.sip.header.Header createHeader(
String headerName,
String headerValue)
throws java.text.ParseException {
if (headerName == null)
throw new NullPointerException("header name is null");
String hdrText =
new StringBuffer()
.append(headerName)
.append(":")
.append(headerValue)
.toString();
return createHeader(hdrText);
}
/** Create and return a list of headers.
*@param headers -- list of headers.
*@throws ParseException -- if a parse exception occurs or a List
* of that type of header is not alowed.
*@return a List containing the headers.
*/
public java.util.List createHeaders(String headers)
throws java.text.ParseException {
if (headers == null)
throw new NullPointerException("null arg!");
StringMsgParser smp = new StringMsgParser();
SIPHeader shdr = smp.parseSIPHeader(headers);
if (shdr instanceof SIPHeaderList)
return (SIPHeaderList) shdr;
else
throw new ParseException(
"List of headers of this type is not allowed in a message",
0);
}
/** Create a ReferTo Header.
*@param address -- address for the header.
*/
public ReferToHeader createReferToHeader(Address address) {
if (address == null)
throw new NullPointerException("null address!");
ReferTo referTo = new ReferTo();
referTo.setAddress(address);
return referTo;
}
/** Create a ReferredBy Header.
*
* pmusgrave
*
*@param address -- address for the header.
*
* TODO: Once interfaces are in javax, change the type to MinSEHeader
* and add to HeaderFactory. - pmusgrave
*/
public ReferredByHeader createReferredByHeader(Address address) {
if (address == null)
throw new NullPointerException("null address!");
ReferredBy referredBy = new ReferredBy();
referredBy.setAddress(address);
return referredBy;
}
/**
* Create a Replaces header with a call Id, to and from tag.
*
* TODO: Once interfaces are in javax, change the type to MinSEHeader
* and add to HeaderFactory. - pmusgrave
* pmusgrave
*/
public ReplacesHeader createReplacesHeader(String callId, String toTag,
String fromTag) throws ParseException
{
Replaces replaces = new Replaces();
replaces.setCallId(callId);
replaces.setFromTag(fromTag);
replaces.setToTag(toTag);
return replaces;
}
/**
* Create a Join header with a call Id, to and from tag.
*
*/
public JoinHeader createJoinHeader(String callId, String toTag,
String fromTag) throws ParseException
{
Join join = new Join();
join.setCallId(callId);
join.setFromTag(fromTag);
join.setToTag(toTag);
return join;
}
/*
* (non-Javadoc)
* @see javax.sip.header.HeaderFactory#createSIPETagHeader(java.lang.String)
*/
public SIPETagHeader createSIPETagHeader(String etag) throws ParseException {
return new SIPETag(etag);
}
/*
* (non-Javadoc)
* @see javax.sip.header.HeaderFactory#createSIPIfMatchHeader(java.lang.String)
*/
public SIPIfMatchHeader createSIPIfMatchHeader(String etag) throws ParseException {
return new SIPIfMatch(etag);
}
//////////////////////////////////////////////////////////////////////////
// The following headers are not part of the JSIP spec.
// They are IMS headers
// (contributed by Miguel Freitas - PT Inovacao and Telecommunications Institute)
///////////////////////////////////////////////////////////////////////////
/**
* creates a P-Access-Network-Info header
* @return newly created P-Access-Network-Info header
*/
public PAccessNetworkInfoHeader createPAccessNetworkInfoHeader()
{
PAccessNetworkInfo accessNetworkInfo = new PAccessNetworkInfo();
return accessNetworkInfo;
}
/**
* P-Asserted-Identity header
* @param address - Address
* @return newly created P-Asserted-Identity header
* @throws ParseException
* @throws NullPointerException
*/
public PAssertedIdentityHeader createPAssertedIdentityHeader(Address address)
throws NullPointerException, ParseException
{
if (address == null)
throw new NullPointerException("null address!");
PAssertedIdentity assertedIdentity = new PAssertedIdentity();
assertedIdentity.setAddress(address);
return assertedIdentity;
}
/**
* Creates a new P-Associated-URI header based on the supplied address
* @param assocURI - Address
* @return newly created P-Associated-URI header
* @throws NullPointerException if the supplied address is null
* @throws ParseException
*/
public PAssociatedURIHeader createPAssociatedURIHeader(Address assocURI)
{
if (assocURI == null)
throw new NullPointerException("null associatedURI!");
PAssociatedURI associatedURI = new PAssociatedURI();
associatedURI.setAddress(assocURI);
return associatedURI;
}
/**
* P-Called-Party-ID header
* @param address - Address
* @return newly created P-Called-Party-ID header
* @throws NullPointerException
* @throws ParseException
*/
public PCalledPartyIDHeader createPCalledPartyIDHeader(Address address)
{
if (address == null)
throw new NullPointerException("null address!");
PCalledPartyID calledPartyID = new PCalledPartyID();
calledPartyID.setAddress(address);
return calledPartyID;
}
/**
* P-Charging-Function-Addresses header
* @return newly created P-Charging-Function-Addresses header
*/
public PChargingFunctionAddressesHeader createPChargingFunctionAddressesHeader()
{
PChargingFunctionAddresses cfa = new PChargingFunctionAddresses();
return cfa;
}
/**
* P-Charging-Vector header
* @param icid - icid string
* @return newly created P-Charging-Vector header
* @throws NullPointerException
* @throws ParseException
*/
public PChargingVectorHeader createChargingVectorHeader(String icid)
throws ParseException
{
if (icid == null)
throw new NullPointerException("null icid arg!");
PChargingVector chargingVector = new PChargingVector();
chargingVector.setICID(icid);
return chargingVector;
}
/**
* P-Media-Authorization header
* @param token - token string
* @return newly created P-Media-Authorizarion header
* @throws InvalidArgumentException
* @throws ParseException
*/
public PMediaAuthorizationHeader createPMediaAuthorizationHeader(String token)
throws InvalidArgumentException, ParseException
{
if (token == null || token == "")
throw new InvalidArgumentException("The Media-Authorization-Token parameter is null or empty");
PMediaAuthorization mediaAuthorization = new PMediaAuthorization();
mediaAuthorization.setMediaAuthorizationToken(token);
return mediaAuthorization;
}
/**
* P-Preferred-Identity header
* @param address - Address
* @return newly created P-Preferred-Identity header
* @throws NullPointerException
*/
public PPreferredIdentityHeader createPPreferredIdentityHeader(Address address)
{
if (address == null)
throw new NullPointerException("null address!");
PPreferredIdentity preferredIdentity = new PPreferredIdentity();
preferredIdentity.setAddress(address);
return preferredIdentity;
}
/**
* P-Visited-Network-ID header
* @return newly created P-Visited-Network-ID header
*/
public PVisitedNetworkIDHeader createPVisitedNetworkIDHeader()
{
PVisitedNetworkID visitedNetworkID = new PVisitedNetworkID();
return visitedNetworkID;
}
/**
* PATH header
* @param address - Address
* @return newly created Path header
* @throws NullPointerException
* @throws ParseException
*/
public PathHeader createPathHeader(Address address)
{
if (address == null)
throw new NullPointerException("null address!");
Path path = new Path();
path.setAddress(address);
return path;
}
/**
* Privacy header
* @param privacyType - privacy type string
* @return newly created Privacy header
* @throws NullPointerException
*/
public PrivacyHeader createPrivacyHeader(String privacyType)
{
if (privacyType == null)
throw new NullPointerException("null privacyType arg");
Privacy privacy = new Privacy(privacyType);
return privacy;
}
/**
* Service-Route header
* @param address - Address
* @return newly created Service-Route header
* @throws NullPointerException
*/
public ServiceRouteHeader createServiceRouteHeader(Address address)
{
if (address == null)
throw new NullPointerException("null address!");
ServiceRoute serviceRoute = new ServiceRoute();
serviceRoute.setAddress(address);
return serviceRoute;
}
/**
* Security-Server header
* @return newly created Security-Server header
*/
public SecurityServerHeader createSecurityServerHeader()
{
SecurityServer secServer = new SecurityServer();
return secServer;
}
/**
* Security-Client header
* @return newly created Security-Client header
*/
public SecurityClientHeader createSecurityClientHeader()
{
SecurityClient secClient = new SecurityClient();
return secClient;
}
/**
* Security-Verify header
* @return newly created Security-Verify header
*/
public SecurityVerifyHeader createSecurityVerifyHeader()
{
SecurityVerify secVerify = new SecurityVerify();
return secVerify;
}
/**
* @return the newly create P-User-Database header.
* Please note that this is not a SIP/TEL uri. It is a
* DIAMETER AAA URI.
*/
public PUserDatabaseHeader createPUserDatabaseHeader(String databaseName)
{
if((databaseName ==null)||(databaseName.equals(" ")))
throw new NullPointerException("Database name is null");
PUserDatabase pUserDatabase = new PUserDatabase();
pUserDatabase.setDatabaseName(databaseName);
return pUserDatabase;
}
/**
*
* @return The newly created P-Profile-Key header.
*
*/
public PProfileKeyHeader createPProfileKeyHeader(Address address)
{
if (address ==null)
throw new NullPointerException("Address is null");
PProfileKey pProfileKey = new PProfileKey();
pProfileKey.setAddress(address);
return pProfileKey;
}
/**
*
* @return The newly created P-Served-User header.
*/
public PServedUserHeader createPServedUserHeader(Address address)
{
if(address==null)
throw new NullPointerException("Address is null");
PServedUser psu = new PServedUser();
psu.setAddress(address);
return psu;
}
/**
* @return The newly created P-Preferred-Service header.
*/
public PPreferredServiceHeader createPPreferredServiceHeader()
{
PPreferredService pps = new PPreferredService();
return pps;
}
/**
*
* @return The newly created P-Asserted-Service header.
*/
public PAssertedServiceHeader createPAssertedServiceHeader()
{
PAssertedService pas = new PAssertedService();
return pas;
}
/**
* Creates a new SessionExpiresHeader based on the newly supplied expires value.
*
* @param expires - the new integer value of the expires.
* @throws InvalidArgumentException if supplied expires is less
* than zero.
* @return the newly created SessionExpiresHeader object.
*
*/
public SessionExpiresHeader createSessionExpiresHeader(int expires)
throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException("bad value " + expires);
SessionExpires s = new SessionExpires();
s.setExpires(expires);
return s;
}
/**
* Create a new Request Line from a String.
*
*/
public SipRequestLine createRequestLine(String requestLine) throws ParseException {
RequestLineParser requestLineParser = new RequestLineParser(requestLine);
return (SipRequestLine) requestLineParser.parse();
}
/**
* Create a new StatusLine from a String.
*/
public SipStatusLine createStatusLine(String statusLine) throws ParseException {
StatusLineParser statusLineParser = new StatusLineParser(statusLine);
return (SipStatusLine) statusLineParser.parse();
}
/**
* Create and return a references header.
*
* @param callId
* @param rel
* @return
* @throws ParseException
*/
public ReferencesHeader createReferencesHeader(String callId, String rel) throws ParseException {
ReferencesHeader retval = new References();
retval.setCallId(callId);
retval.setRel(rel);
return retval;
}
//////////////////////////////////////////////////////////
// Constructor
//////////////////////////////////////////////////////////
/**
* Default constructor.
*/
public HeaderFactoryImpl() {
stripAddressScopeZones
= Boolean.getBoolean("gov.nist.core.STRIP_ADDR_SCOPES");
}
}
java/gov/nist/javax/sip/header/InReplyTo.java 0100644 0000000 0000000 00000006542 13513104763 020174 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.text.ParseException;
/**
* InReplyTo SIP Header.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:31 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*/
public class InReplyTo extends SIPHeader implements InReplyToHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 1682602905733508890L;
protected CallIdentifier callId;
/** Default constructor
*/
public InReplyTo() {
super(IN_REPLY_TO);
}
/** constructor
* @param cid CallIdentifier to set
*/
public InReplyTo(CallIdentifier cid) {
super(IN_REPLY_TO);
callId = cid;
}
/**
* Sets the Call-Id of the InReplyToHeader. The CallId parameter uniquely
* identifies a serious of messages within a dialogue.
*
* @param callId - the string value of the Call-Id of this InReplyToHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the callId value.
*/
public void setCallId(String callId) throws ParseException {
try {
this.callId = new CallIdentifier(callId);
} catch (Exception e) {
throw new ParseException(e.getMessage(), 0);
}
}
/**
* Returns the Call-Id of InReplyToHeader. The CallId parameter uniquely
* identifies a series of messages within a dialogue.
*
* @return the String value of the Call-Id of this InReplyToHeader
*/
public String getCallId() {
if (callId == null)
return null;
return callId.encode();
}
/**
* Generate canonical form of the header.
* @return String
*/
public String encodeBody() {
return callId.encode();
}
public Object clone() {
InReplyTo retval = (InReplyTo) super.clone();
if (this.callId != null)
retval.callId = (CallIdentifier) this.callId.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/InReplyToList.java 0100644 0000000 0000000 00000003661 13513104763 021027 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* In-Reply-To SIP header. Keeps a list of InReplyToHeader
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:31 $
* @since 1.1
*
*@author M. Ranganathan
*
*
*
*/
public final class InReplyToList extends SIPHeaderList {
private static final long serialVersionUID = -7993498496830999237L;
public Object clone() {
InReplyToList retval = new InReplyToList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor
*/
public InReplyToList() {
super(InReplyTo.class, InReplyToHeader.NAME);
}
}
java/gov/nist/javax/sip/header/Indentation.java 0100644 0000000 0000000 00000005216 13513104763 020560 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
/**
* Internal utility class for pretty printing and header formatting.
*
* @author M. Ranganathan
* @author O. Deruelle
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:31 $
*/
class Indentation {
private int indentation;
/**
* Default constructor
*/
protected Indentation() {
indentation = 0;
}
/**
* Constructor
*
* @param initval
* int to set
*/
protected Indentation(int initval) {
indentation = initval;
}
/**
* set the indentation field
*
* @param initval
* int to set
*/
protected void setIndentation(int initval) {
indentation = initval;
}
/**
* get the number of indentation.
*
* @return int
*/
protected int getCount() {
return indentation;
}
/**
* increment the indentation field
*/
protected void increment() {
indentation++;
}
/**
* decrement the indentation field
*/
protected void decrement() {
indentation--;
}
/**
* get the indentation
*
* @return String
*/
protected String getIndentation() {
char[] chars = new char[indentation];
java.util.Arrays.fill(chars, ' ');
return new String(chars);
}
}
java/gov/nist/javax/sip/header/MaxForwards.java 0100644 0000000 0000000 00000007133 13513104763 020541 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import javax.sip.InvalidArgumentException;
/**
* MaxForwards SIPHeader
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:32 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*/
public class MaxForwards extends SIPHeader implements MaxForwardsHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3096874323347175943L;
/** maxForwards field.
*/
protected int maxForwards;
/** Default constructor.
*/
public MaxForwards() {
super(NAME);
}
public MaxForwards( int m ) throws InvalidArgumentException {
super(NAME);
this.setMaxForwards( m );
}
/** get the MaxForwards field.
* @return the maxForwards member.
*/
public int getMaxForwards() {
return maxForwards;
}
/**
* Set the maxForwards member
* @param maxForwards maxForwards parameter to set
*/
public void setMaxForwards(int maxForwards)
throws InvalidArgumentException {
if (maxForwards < 0 || maxForwards > 255)
throw new InvalidArgumentException(
"bad max forwards value " + maxForwards);
this.maxForwards = maxForwards;
}
/**
* Encode into a string.
* @return encoded string.
*
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
return buffer.append(maxForwards);
}
/** Boolean function
* @return true if MaxForwards field reached zero.
*/
public boolean hasReachedZero() {
return maxForwards == 0;
}
/** decrement MaxForwards field one by one.
*/
public void decrementMaxForwards() throws TooManyHopsException {
if (maxForwards > 0)
maxForwards--;
else throw new TooManyHopsException ("has already reached 0!");
}
public boolean equals(Object other) {
if (this==other) return true;
if (other instanceof MaxForwardsHeader) {
final MaxForwardsHeader o = (MaxForwardsHeader) other;
return this.getMaxForwards() == o.getMaxForwards();
}
return false;
}
}
java/gov/nist/javax/sip/header/MediaRange.java 0100644 0000000 0000000 00000006264 13513104763 020304 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
* See ../../../../doc/uncopyright.html for conditions of use. *
* Author: M. Ranganathan (mranga@nist.gov) *
* Modified By: O. Deruelle (deruelle@nist.gov) *
* Questions/Comments: nist-sip-dev@antd.nist.gov *
*******************************************************************************/
package gov.nist.javax.sip.header;
/**
* Media Range
* @see Accept
* @since 0.9
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:32 $
*
* Revisions:
*
* Version 1.0
* 1. Added encode method.
*
* media-range = ( "STAR/STAR"
* | ( type "/" STAR )
* | ( type "/" subtype )
* ) *( ";" parameter )
*
* HTTP RFC 2616 Section 14.1
*
*/
public class MediaRange extends SIPObject {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6297125815438079210L;
/** type field
*/
protected String type;
/** subtype field
*/
protected String subtype;
/** Default constructor
*/
public MediaRange() {
}
/** get type field
* @return String
*/
public String getType() {
return type;
}
/** get the subType field.
* @return String
*/
public String getSubtype() {
return subtype;
}
/**
* Set the type member
* @param t String to set
*/
public void setType(String t) {
type = t;
}
/**
* Set the subtype member
* @param s String to set
*/
public void setSubtype(String s) {
subtype = s;
}
/**
* Encode the object.
* @return String
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
return buffer.append(type)
.append(SLASH)
.append(subtype);
}
}
java/gov/nist/javax/sip/header/MimeVersion.java 0100644 0000000 0000000 00000014772 13513104763 020550 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.InvalidArgumentException;
import javax.sip.header.*;
/**
* MimeVersion SIP Header.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/10/18 13:46:35 $
* @since 1.1
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*/
public class MimeVersion extends SIPHeader implements MimeVersionHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -7951589626435082068L;
/**
* mimeVersion field
*/
protected int minorVersion;
/**
* majorVersion field
*/
protected int majorVersion;
/**
* Default constructor
*/
public MimeVersion() {
super(MIME_VERSION);
}
/**
* Gets the Minor version value of this MimeVersionHeader.
*
* @return the Minor version of this MimeVersionHeader
*/
public int getMinorVersion() {
return minorVersion;
}
/**
* Gets the Major version value of this MimeVersionHeader.
*
* @return the Major version of this MimeVersionHeader
*/
public int getMajorVersion() {
return majorVersion;
}
/**
* Sets the Minor-Version argument of this MimeVersionHeader to the supplied
* minorVersion value.
*
* @param minorVersion - the new integer Minor version
* @throws InvalidArgumentException
*/
public void setMinorVersion(int minorVersion)
throws InvalidArgumentException {
if (minorVersion < 0)
throw new InvalidArgumentException(
"JAIN-SIP Exception"
+ ", MimeVersion, setMinorVersion(), the minorVersion parameter is null");
this.minorVersion = minorVersion;
}
/**
* Sets the Major-Version argument of this MimeVersionHeader to the supplied
* majorVersion value.
*
* @param majorVersion - the new integer Major version
* @throws InvalidArgumentException
*/
public void setMajorVersion(int majorVersion)
throws InvalidArgumentException {
if (majorVersion < 0)
throw new InvalidArgumentException(
"JAIN-SIP Exception"
+ ", MimeVersion, setMajorVersion(), the majorVersion parameter is null");
this.majorVersion = majorVersion;
}
/**
* Return canonical form.
* @return String
*/
public String encodeBody() {
return Integer.toString(majorVersion)
+ DOT
+ Integer.toString(minorVersion);
}
}
/*
* $Log: MimeVersion.java,v $
* Revision 1.6 2009/10/18 13:46:35 deruelle_jean
* FindBugs Fixes (Category Performance Warnings)
*
* Issue number:
* Obtained from:
* Submitted by: Jean Deruelle
* Reviewed by:
*
* Revision 1.5 2009/07/17 18:57:32 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:33 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:34 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/MinExpires.java 0100644 0000000 0000000 00000013004 13513104763 020361 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.*;
import javax.sip.header.*;
/**
* MinExpires SIP Header.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/10/18 13:46:35 $
* @since 1.1
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class MinExpires extends SIPHeader implements MinExpiresHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 7001828209606095801L;
/** expires field
*/
protected int expires;
/** default constructor
*/
public MinExpires() {
super(NAME);
}
/**
* Return canonical form.
* @return String
*/
public String encodeBody() {
return Integer.toString(expires);
}
/**
* Gets the expires value of the ExpiresHeader. This expires value is
* relative time.
*
* @return the expires value of the ExpiresHeader.
*
*/
public int getExpires() {
return expires;
}
/**
* Sets the relative expires value of the ExpiresHeader.
* The expires value MUST be greater than zero and MUST be
* less than 2**31.
*
* @param expires - the new expires value of this ExpiresHeader
*
* @throws InvalidArgumentException if supplied value is less than zero.
*
*
*
*/
public void setExpires(int expires) throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException("bad argument " + expires);
this.expires = expires;
}
}
/*
* $Log: MinExpires.java,v $
* Revision 1.6 2009/10/18 13:46:35 deruelle_jean
* FindBugs Fixes (Category Performance Warnings)
*
* Issue number:
* Obtained from:
* Submitted by: Jean Deruelle
* Reviewed by:
*
* Revision 1.5 2009/07/17 18:57:32 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:20 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:34 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/NameMap.java 0100644 0000000 0000000 00000015626 13513104763 017630 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
import gov.nist.javax.sip.header.ims.*;
import java.util.Hashtable;
/**
* A mapping class that returns the SIPHeader for a given header name.
* Add new classes to this map if you are implementing new header types if
* you want some of the introspection based methods to work.
* @version 1.2 $Revision: 1.11 $ $Date: 2009/07/17 18:57:32 $
* @since 1.1
*/
public class NameMap implements SIPHeaderNames, PackageNames {
static Hashtable nameMap;
static {
initializeNameMap();
}
protected static void putNameMap(String headerName, String className) {
nameMap.put(
headerName.toLowerCase(),
className);
}
public static Class getClassFromName(String headerName) {
String className = (String) nameMap.get(headerName.toLowerCase());
if (className == null)
return null;
else {
try {
return Class.forName(className);
} catch (ClassNotFoundException ex) {
return null;
}
}
}
/** add an extension header to this map.
*@param headerName is the extension header name.
*@param className is the fully qualified class name that implements
* the header (does not have to belong to the nist-sip package).
* Use this if you want to use the introspection-based methods.
*/
public static void addExtensionHeader(
String headerName,
String className) {
nameMap.put(headerName.toLowerCase(), className);
}
private static void initializeNameMap() {
nameMap = new Hashtable();
putNameMap(MinExpires.NAME, MinExpires.class.getName()); // 1
putNameMap(ErrorInfo.NAME, ErrorInfo.class.getName()); // 2
putNameMap(MimeVersion.NAME, MimeVersion.class.getName()); // 3
putNameMap(InReplyTo.NAME, InReplyTo.class.getName()); // 4
putNameMap(Allow.NAME, Allow.class.getName()); // 5
putNameMap(ContentLanguage.NAME, ContentLanguage.class.getName()); // 6
putNameMap(CALL_INFO, CallInfo.class.getName()); //7
putNameMap(CSEQ, CSeq.class.getName()); //8
putNameMap(ALERT_INFO, AlertInfo.class.getName()); //9
putNameMap(ACCEPT_ENCODING, AcceptEncoding.class.getName()); //10
putNameMap(ACCEPT, Accept.class.getName()); //11
putNameMap(ACCEPT_LANGUAGE, AcceptLanguage.class.getName()); //12
putNameMap(RECORD_ROUTE, RecordRoute.class.getName()); //13
putNameMap(TIMESTAMP, TimeStamp.class.getName()); //14
putNameMap(TO, To.class.getName()); //15
putNameMap(VIA, Via.class.getName()); //16
putNameMap(FROM, From.class.getName()); //17
putNameMap(CALL_ID, CallID.class.getName()); //18
putNameMap(AUTHORIZATION, Authorization.class.getName()); //19
putNameMap(PROXY_AUTHENTICATE, ProxyAuthenticate.class.getName()); //20
putNameMap(SERVER, Server.class.getName()); //21
putNameMap(UNSUPPORTED, Unsupported.class.getName()); //22
putNameMap(RETRY_AFTER, RetryAfter.class.getName()); //23
putNameMap(CONTENT_TYPE, ContentType.class.getName()); //24
putNameMap(CONTENT_ENCODING, ContentEncoding.class.getName()); //25
putNameMap(CONTENT_LENGTH, ContentLength.class.getName()); //26
putNameMap(ROUTE, Route.class.getName()); //27
putNameMap(CONTACT, Contact.class.getName()); //28
putNameMap(WWW_AUTHENTICATE, WWWAuthenticate.class.getName()); //29
putNameMap(MAX_FORWARDS, MaxForwards.class.getName()); //30
putNameMap(ORGANIZATION, Organization.class.getName()); //31
putNameMap(PROXY_AUTHORIZATION, ProxyAuthorization.class.getName()); //32
putNameMap(PROXY_REQUIRE, ProxyRequire.class.getName()); //33
putNameMap(REQUIRE, Require.class.getName()); //34
putNameMap(CONTENT_DISPOSITION, ContentDisposition.class.getName()); //35
putNameMap(SUBJECT, Subject.class.getName()); //36
putNameMap(USER_AGENT, UserAgent.class.getName()); //37
putNameMap(WARNING, Warning.class.getName()); //38
putNameMap(PRIORITY, Priority.class.getName()); //39
putNameMap(DATE, SIPDateHeader.class.getName()); //40
putNameMap(EXPIRES, Expires.class.getName()); //41
putNameMap(SUPPORTED, Supported.class.getName()); //42
putNameMap(REPLY_TO, ReplyTo.class.getName()); // 43
putNameMap(SUBSCRIPTION_STATE, SubscriptionState.class.getName()); //44
putNameMap(EVENT, Event.class.getName()); //45
putNameMap(ALLOW_EVENTS, AllowEvents.class.getName()); //46
// pmusgrave - extensions
putNameMap(REFERRED_BY, "ReferredBy");
putNameMap(SESSION_EXPIRES, "SessionExpires");
putNameMap(MIN_SE, "MinSE");
putNameMap(REPLACES, "Replaces");
// jean deruelle
putNameMap(JOIN, "Join");
// IMS Specific headers.
putNameMap(PAccessNetworkInfoHeader.NAME, PAccessNetworkInfo.class.getName());
putNameMap(PAssertedIdentityHeader.NAME, PAssertedIdentity.class.getName());
putNameMap(PAssociatedURIHeader.NAME, PAssociatedURI.class.getName());
putNameMap(PCalledPartyIDHeader.NAME, PCalledPartyID.class.getName());
putNameMap(PChargingFunctionAddressesHeader.NAME, PChargingFunctionAddresses.class.getName());
putNameMap(PChargingVectorHeader.NAME,PChargingVector.class.getName());
putNameMap(PMediaAuthorizationHeader.NAME,PMediaAuthorization.class.getName());
putNameMap(Path.NAME, Path.class.getName());
putNameMap(PPreferredIdentity.NAME, PPreferredIdentity.class.getName());
putNameMap(Privacy.NAME,Privacy.class.getName());
putNameMap(ServiceRoute.NAME, ServiceRoute.class.getName());
putNameMap(PVisitedNetworkID.NAME, PVisitedNetworkID.class.getName());
}
}
java/gov/nist/javax/sip/header/Organization.java 0100644 0000000 0000000 00000012165 13513104763 020751 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
import javax.sip.header.*;
/**
* Organization SIP Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:32 $
* @since 1.1
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class Organization extends SIPHeader implements OrganizationHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -2775003113740192712L;
/**
* Organization field
*/
protected String organization;
/**
* Return encoding of value of the header.
* @return String
*/
public String encodeBody() {
return organization;
}
/**
* Default constructor
*/
public Organization() {
super(ORGANIZATION);
}
/**
* Get the organization field.
* @return String
*/
public String getOrganization() {
return organization;
}
/**
* Set the organization member
* @param o String to set
*/
public void setOrganization(String o) throws ParseException {
if (o == null)
throw new NullPointerException(
"JAIN-SIP Exception,"
+ " Organization, setOrganization(), the organization parameter is null");
organization = o;
}
}
/*
* $Log: Organization.java,v $
* Revision 1.5 2009/07/17 18:57:32 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:15 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:34 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ParameterNames.java 0100644 0000000 0000000 00000011036 13513104763 021205 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
package gov.nist.javax.sip.header;
/**
* A list of commonly occuring parameter names. These are for conveniance so as
* to avoid typo's
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:33 $
* @since 1.1
*
* @author M. Ranganathan
*
*
*
*/
public interface ParameterNames {
// Issue reported by larryb
public static final String NEXT_NONCE = "nextnonce";
public static final String TAG = "tag";
public static final String USERNAME = "username";
public static final String URI = "uri";
public static final String DOMAIN = "domain";
public static final String CNONCE = "cnonce";
public static final String PASSWORD = "password";
public static final String RESPONSE = "response";
public static final String RESPONSE_AUTH = "rspauth";
public static final String OPAQUE = "opaque";
public static final String ALGORITHM = "algorithm";
public static final String DIGEST = "Digest";
public static final String SIGNED_BY = "signed-by";
public static final String SIGNATURE = "signature";
public static final String NONCE = "nonce";
// Issue reported by larryb
public static final String NONCE_COUNT = "nc";
public static final String PUBKEY = "pubkey";
public static final String COOKIE = "cookie";
public static final String REALM = "realm";
public static final String VERSION = "version";
public static final String STALE = "stale";
public static final String QOP = "qop";
public static final String NC = "nc";
public static final String PURPOSE = "purpose";
public static final String CARD = "card";
public static final String INFO = "info";
public static final String ACTION = "action";
public static final String PROXY = "proxy";
public static final String REDIRECT = "redirect";
public static final String EXPIRES = "expires";
public static final String Q = "q";
public static final String RENDER = "render";
public static final String SESSION = "session";
public static final String ICON = "icon";
public static final String ALERT = "alert";
public static final String HANDLING = "handling";
public static final String REQUIRED = "required";
public static final String OPTIONAL = "optional";
public static final String EMERGENCY = "emergency";
public static final String URGENT = "urgent";
public static final String NORMAL = "normal";
public static final String NON_URGENT = "non-urgent";
public static final String DURATION = "duration";
public static final String BRANCH = "branch";
public static final String HIDDEN = "hidden";
public static final String RECEIVED = "received";
public static final String MADDR = "maddr";
public static final String TTL = "ttl";
public static final String TRANSPORT = "transport";
public static final String TEXT = "text";
public static final String CAUSE = "cause";
public static final String ID = "id";
// @@@ hagai
public static final String RPORT = "rport";
// Added pmusgrave (Replaces support)
public static final String TO_TAG = "to-tag";
public static final String FROM_TAG = "from-tag";
// pmusgrave (outbound and gruu)
// draft-sip-outbouund-08
// draft-sip-gruu-12
public static final String SIP_INSTANCE = "+sip.instance";
public static final String PUB_GRUU = "pub-gruu";
public static final String TEMP_GRUU = "temp-gruu";
public static final String GRUU = "gruu";
}
java/gov/nist/javax/sip/header/ParametersHeader.java 0100644 0000000 0000000 00000045012 13513104763 021516 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/**************************************************************************/
/* Product of NIST Advanced Networking Technologies Division */
/**************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.DuplicateNameValueList;
import gov.nist.core.NameValue;
import gov.nist.core.NameValueList;
import gov.nist.javax.sip.address.GenericURI;
import java.io.Serializable;
import java.text.ParseException;
import java.util.Iterator;
import javax.sip.header.Parameters;
/**
* Parameters header. Suitable for extension by headers that have parameters.
*
* @author M. Ranganathan
*
*
* @version 1.2 $Revision: 1.15 $ $Date: 2010/01/12 00:05:27 $
*
*/
public abstract class ParametersHeader
extends SIPHeader
implements javax.sip.header.Parameters, Serializable {
protected NameValueList parameters;
protected DuplicateNameValueList duplicates;
protected ParametersHeader() {
this.parameters = new NameValueList();
this.duplicates = new DuplicateNameValueList();
}
protected ParametersHeader(String hdrName) {
super(hdrName);
this.parameters = new NameValueList();
this.duplicates = new DuplicateNameValueList();
}
protected ParametersHeader(String hdrName, boolean sync) {
super(hdrName);
this.parameters = new NameValueList(sync);
this.duplicates = new DuplicateNameValueList();
}
/**
* Returns the value of the named parameter, or null if it is not set. A
* zero-length String indicates flag parameter.
*
* @param name name of parameter to retrieve
* @return the value of specified parameter
*/
public String getParameter(String name) {
return this.parameters.getParameter(name);
}
/**
* Return the parameter as an object (dont convert to string).
*
* @param name is the name of the parameter to get.
* @return the object associated with the name.
*/
public Object getParameterValue(String name) {
return this.parameters.getValue(name);
}
/**
* Returns an Iterator over the names (Strings) of all parameters present
* in this ParametersHeader.
*
* @return an Iterator over all the parameter names
*/
public Iterator getParameterNames() {
return parameters.getNames();
}
/** Return true if you have a parameter and false otherwise.
*
*@return true if the parameters list is non-empty.
*/
public boolean hasParameters() {
return parameters != null && !parameters.isEmpty();
}
/**
* Removes the specified parameter from Parameters of this ParametersHeader.
* This method returns silently if the parameter is not part of the
* ParametersHeader.
*
* @param name - a String specifying the parameter name
*/
public void removeParameter(String name) {
this.parameters.delete(name);
}
/**
* Sets the value of the specified parameter. If the parameter already had
*
* a value it will be overwritten. A zero-length String indicates flag
*
* parameter.
*
*
*
* @param name - a String specifying the parameter name
*
* @param value - a String specifying the parameter value
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the parameter name or value.
*
*/
public void setParameter(String name, String value) throws ParseException {
NameValue nv = parameters.getNameValue(name);
if (nv != null) {
nv.setValueAsObject(value);
} else {
nv = new NameValue(name, value);
this.parameters.set(nv);
}
}
/**
* Sets the value of the specified parameter. If the parameter already had
*
* a value it will be overwritten. A zero-length String indicates flag
*
* parameter.
*
*
*
* @param name - a String specifying the parameter name
*
* @param value - a String specifying the parameter value
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the parameter name or value.
*
*/
public void setQuotedParameter(String name, String value)
throws ParseException {
NameValue nv = parameters.getNameValue(name);
if (nv != null) {
nv.setValueAsObject(value);
nv.setQuotedValue();
} else {
nv = new NameValue(name, value);
nv.setQuotedValue();
this.parameters.set(nv);
}
}
/**
* Sets the value of the specified parameter. If the parameter already had
*
* a value it will be overwritten.
*
*
* @param name - a String specifying the parameter name
*
* @param value - an int specifying the parameter value
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the parameter name or value.
*
*/
protected void setParameter(String name, int value) {
Integer val = Integer.valueOf(value);
this.parameters.set(name,val);
}
/**
* Sets the value of the specified parameter. If the parameter already had
*
* a value it will be overwritten.
*
*
* @param name - a String specifying the parameter name
*
* @param value - a boolean specifying the parameter value
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the parameter name or value.
*
*/
protected void setParameter(String name, boolean value) {
Boolean val = Boolean.valueOf(value);
this.parameters.set(name,val);
}
/**
* Sets the value of the specified parameter. If the parameter already had
*
* a value it will be overwritten.
*
* @param name - a String specifying the parameter name
*
* @param value - a boolean specifying the parameter value
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the parameter name or value.
*
*/
protected void setParameter(String name, float value) {
Float val = Float.valueOf(value);
NameValue nv = parameters.getNameValue(name);
if (nv != null) {
nv.setValueAsObject(val);
} else {
nv = new NameValue(name, val);
this.parameters.set(nv);
}
}
/**
* Sets the value of the specified parameter. If the parameter already had
*
* a value it will be overwritten. A zero-length String indicates flag
*
* parameter.
*
*
*
* @param name - a String specifying the parameter name
*
* @param value - a String specifying the parameter value
*
* @throws ParseException which signals that an error has been reached
*
* unexpectedly while parsing the parameter name or value.
*
*/
protected void setParameter(String name, Object value) {
this.parameters.set(name,value);
}
/**
* Return true if has a parameter.
*
* @param parameterName is the name of the parameter.
*
* @return true if the parameter exists and false if not.
*/
public boolean hasParameter(String parameterName) {
return this.parameters.hasNameValue(parameterName);
}
/**
*Remove all parameters.
*/
public void removeParameters() {
this.parameters = new NameValueList();
}
/**
* get the parameter list.
* @return parameter list
*/
public NameValueList getParameters() {
return parameters;
}
/** Set the parameter given a name and value.
*
* @param nameValue - the name value of the parameter to set.
*/
public void setParameter(NameValue nameValue) {
this.parameters.set(nameValue);
}
/**
* Set the parameter list.
*
* @param parameters The name value list to set as the parameter list.
*/
public void setParameters(NameValueList parameters) {
this.parameters = parameters;
}
/**
* Get the parameter as an integer value.
*
* @param parameterName -- the parameter name to fetch.
*
* @return -1 if the parameter is not defined in the header.
*/
protected int getParameterAsInt(String parameterName) {
if (this.getParameterValue(parameterName) != null) {
try {
if (this.getParameterValue(parameterName) instanceof String) {
return Integer.parseInt(this.getParameter(parameterName));
} else {
return ((Integer) getParameterValue(parameterName))
.intValue();
}
} catch (NumberFormatException ex) {
return -1;
}
} else
return -1;
}
/** Get the parameter as an integer when it is entered as a hex.
*
*@param parameterName -- The parameter name to fetch.
*
*@return -1 if the parameter is not defined in the header.
*/
protected int getParameterAsHexInt(String parameterName) {
if (this.getParameterValue(parameterName) != null) {
try {
if (this.getParameterValue(parameterName) instanceof String) {
return Integer.parseInt(
this.getParameter(parameterName),
16);
} else {
return ((Integer) getParameterValue(parameterName))
.intValue();
}
} catch (NumberFormatException ex) {
return -1;
}
} else
return -1;
}
/** Get the parameter as a float value.
*
*@param parameterName -- the parameter name to fetch
*
*@return -1 if the parameter is not defined or the parameter as a float.
*/
protected float getParameterAsFloat(String parameterName) {
if (this.getParameterValue(parameterName) != null) {
try {
if (this.getParameterValue(parameterName) instanceof String) {
return Float.parseFloat(this.getParameter(parameterName));
} else {
return ((Float) getParameterValue(parameterName))
.floatValue();
}
} catch (NumberFormatException ex) {
return -1;
}
} else
return -1;
}
/**
* Get the parameter as a long value.
*
* @param parameterName -- the parameter name to fetch.
*
* @return -1 if the parameter is not defined or the parameter as a long.
*/
protected long getParameterAsLong(String parameterName) {
if (this.getParameterValue(parameterName) != null) {
try {
if (this.getParameterValue(parameterName) instanceof String) {
return Long.parseLong(this.getParameter(parameterName));
} else {
return ((Long) getParameterValue(parameterName))
.longValue();
}
} catch (NumberFormatException ex) {
return -1;
}
} else
return -1;
}
/**
* Get the parameter value as a URI.
*
* @param parameterName -- the parameter name
*
* @return value of the parameter as a URI or null if the parameter
* not present.
*/
protected GenericURI getParameterAsURI(String parameterName) {
Object val = getParameterValue(parameterName);
if (val instanceof GenericURI)
return (GenericURI) val;
else {
try {
return new GenericURI((String) val);
} catch (ParseException ex) {
//catch ( URISyntaxException ex) {
return null;
}
}
}
/**
* Get the parameter value as a boolean.
*
* @param parameterName -- the parameter name
* @return boolean value of the parameter.
*/
protected boolean getParameterAsBoolean(String parameterName) {
Object val = getParameterValue(parameterName);
if (val == null) {
return false;
} else if (val instanceof Boolean) {
return ((Boolean) val).booleanValue();
} else if (val instanceof String) {
return Boolean.valueOf((String) val).booleanValue();
} else
return false;
}
/**
* This is for the benifit of the TCK.
*
* @return the name value pair for the given parameter name.
*/
public NameValue getNameValue(String parameterName) {
return parameters.getNameValue(parameterName);
}
public Object clone() {
ParametersHeader retval = (ParametersHeader) super.clone();
if (this.parameters != null)
retval.parameters = (NameValueList) this.parameters.clone();
return retval;
}
//-------------------------
/**
* Introduced specifically for the P-Charging-Function-Addresses Header and
* all other headers that may have multiple header parameters of the same name, but
* with multiple possible values.
*
* Example: P-Charging-Function-Addresses: ccf=[5555::b99:c88:d77:e66]; ccf=[5555::a55:b44:c33:d22];
* ecf=[5555::1ff:2ee:3dd:4cc]; ecf=[5555::6aa:7bb:8cc:9dd]
* @param name of the parameter
* @param value of the parameter
*/
public void setMultiParameter(String name, String value)
{
NameValue nv = new NameValue();
nv.setName(name);
nv.setValue(value);
duplicates.set(nv);
}
/** Set the parameter given a name and value.
*
* @param nameValue - the name value of the parameter to set.
*/
public void setMultiParameter(NameValue nameValue) {
this.duplicates.set(nameValue);
}
/**
* Returns the parameter name
* @param name
* @return
*/
public String getMultiParameter(String name) {
return this.duplicates.getParameter(name);
}
public DuplicateNameValueList getMultiParameters() {
return duplicates;
}
/**
* Return the parameter as an object (dont convert to string).
*
* @param name is the name of the parameter to get.
* @return the object associated with the name.
*/
public Object getMultiParameterValue(String name) {
return this.duplicates.getValue(name);
}
/**
* Returns an Iterator over the names (Strings) of all parameters present
* in this ParametersHeader.
*
* @return an Iterator over all the parameter names
*/
public Iterator getMultiParameterNames() {
return duplicates.getNames();
}
/** Return true if you have a parameter and false otherwise.
*
*@return true if the parameters list is non-empty.
*/
public boolean hasMultiParameters() {
return duplicates != null && !duplicates.isEmpty();
}
/**
* Removes the specified parameter from Parameters of this ParametersHeader.
* This method returns silently if the parameter is not part of the
* ParametersHeader.
*
* @param name - a String specifying the parameter name
*/
public void removeMultiParameter(String name) {
this.duplicates.delete(name);
}
/**
* Return true if has a parameter.
*
* @param parameterName is the name of the parameter.
*
* @return true if the parameter exists and false if not.
*/
public boolean hasMultiParameter(String parameterName) {
return this.duplicates.hasNameValue(parameterName);
}
/**
*Remove all parameters.
*/
public void removeMultiParameters() {
this.duplicates = new DuplicateNameValueList();
}
//-------------------------------
@SuppressWarnings("unchecked")
protected final boolean equalParameters( Parameters other ) {
if (this==other) return true;
for ( Iterator i = this.getParameterNames(); i.hasNext();) {
String pname = (String) i.next();
String p1 = this.getParameter( pname );
String p2 = other.getParameter( pname );
// getting them based on this.getParameterNames. Note that p1 may be null
// if this is a name-only parameter like rport or lr.
if (p1 == null ^ p2 == null) return false;
else if (p1 != null && !p1.equalsIgnoreCase(p2) ) return false;
}
// Also compare other's parameters; some duplicate testing here...
for ( Iterator i = other.getParameterNames(); i.hasNext();) {
String pname = (String) i.next();
String p1 = other.getParameter( pname );
String p2 = this.getParameter( pname );
// assert( p1 != null );
// if ( p1 == null ) throw new RuntimeException("Assertion check failed!");
// if (p2==null) return false;
// getting them based on this.getParameterNames. Note that p1 may be null
// if this is a name-only parameter like rport or lr.
if (p1 == null ^ p2 == null) return false;
else if (p1 != null && !p1.equalsIgnoreCase(p2) ) return false;
}
return true;
}
// ----------- Abstract methods --------------
protected abstract String encodeBody();
}
java/gov/nist/javax/sip/header/Priority.java 0100644 0000000 0000000 00000005612 13513104763 020125 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.text.ParseException;
/**
* the Priority header.
*
* @author Olivier Deruelle
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:33 $
*
*
*
*/
public class Priority extends SIPHeader implements PriorityHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 3837543366074322106L;
/** constant EMERGENCY field
*/
public static final String EMERGENCY = ParameterNames.EMERGENCY;
/** constant URGENT field
*/
public static final String URGENT = ParameterNames.URGENT;
/** constant NORMAL field
*/
public static final String NORMAL = ParameterNames.NORMAL;
/** constant NON_URGENT field
*/
public static final String NON_URGENT = ParameterNames.NON_URGENT;
/** priority field
*/
protected String priority;
/** Default constructor
*/
public Priority() {
super(NAME);
}
/**
* Encode into canonical form.
* @return String
*/
public String encodeBody() {
return priority;
}
/**
* get the priority value.
* @return String
*/
public String getPriority() {
return priority;
}
/**
* Set the priority member
* @param p String to set
*/
public void setPriority(String p) throws ParseException {
if (p == null)
throw new NullPointerException(
"JAIN-SIP Exception,"
+ "Priority, setPriority(), the priority parameter is null");
priority = p;
}
}
java/gov/nist/javax/sip/header/Protocol.java 0100644 0000000 0000000 00000015460 13513104763 020107 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
/**
* Protocol name and version.
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:33 $
*
* @author M. Ranganathan
*
*
*
*/
public class Protocol extends SIPObject {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 2216758055974073280L;
/** protocolName field
*/
protected String protocolName;
/** protocolVersion field
*/
protected String protocolVersion;
/** transport field
*/
protected String transport;
/**
* Return canonical form.
* @return String
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
buffer.append(protocolName.toUpperCase())
.append(SLASH)
.append(protocolVersion)
.append(SLASH)
.append(transport.toUpperCase());
return buffer;
}
/** get the protocol name
* @return String
*/
public String getProtocolName() {
return protocolName;
}
/** get the protocol version
* @return String
*/
public String getProtocolVersion() {
return protocolVersion;
}
/**
* Get the protocol name + version
* JvB: This is what is returned in the ViaHeader interface for 'getProtocol()'
*
* @return String : protocolname + '/' + version
*/
public String getProtocol() {
return protocolName + '/' + protocolVersion;
}
public void setProtocol( String name_and_version ) throws ParseException {
int slash = name_and_version.indexOf('/');
if (slash>0) {
this.protocolName = name_and_version.substring(0,slash);
this.protocolVersion = name_and_version.substring( slash+1 );
} else throw new ParseException( "Missing '/' in protocol", 0 );
}
/** get the transport
* @return String
*/
public String getTransport() {
return transport;
}
/**
* Set the protocolName member
* @param p String to set
*/
public void setProtocolName(String p) {
protocolName = p;
}
/**
* Set the protocolVersion member
* @param p String to set
*/
public void setProtocolVersion(String p) {
protocolVersion = p;
}
/**
* Set the transport member
* @param t String to set
*/
public void setTransport(String t) {
transport = t;
}
/**
* Default constructor.
*/
public Protocol() {
protocolName = "SIP";
protocolVersion = "2.0";
transport = "UDP";
}
}
/*
* $Log: Protocol.java,v $
* Revision 1.8 2009/07/17 18:57:33 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.7 2007/02/12 15:19:23 belangery
* Changed the encode() and encodeBody() methods of SIP headers and basic classes to make them use the same StringBuffer instance during the encoding phase.
*
* Revision 1.6 2006/07/13 09:01:24 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.4 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.3 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.2 2005/10/09 18:47:53 jeroen
* defined equals() in terms of API calls
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ProxyAuthenticate.java 0100644 0000000 0000000 00000012263 13513104763 021764 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.address.URI;
import javax.sip.header.*;
/**
* Proxy Authenticate SIP (HTTP ) header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:33 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class ProxyAuthenticate
extends AuthenticationHeader
implements ProxyAuthenticateHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 3826145955463251116L;
/**
* Default Constructor
*/
public ProxyAuthenticate() {
super(NAME);
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AuthenticationHeader#getURI()
*
* @since 1.2 this method is deprecated, uri is not a valid paramter for this header
* Fail silently for backwards compatibility
*/
public URI getURI() {
return null;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AuthenticationHeader#setURI(javax.sip.address.URI)
*
* @since 1.2 this method is deprecated, uri is not a valid paramter for this header
* Fail silently for backwards compatibility
*/
public void setURI(URI uri) {
// empty, fail silently
}
}
/*
* $Log: ProxyAuthenticate.java,v $
* Revision 1.5 2009/07/17 18:57:33 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:19 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.4 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.3 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.2 2005/10/09 10:50:06 jeroen
* get/setURI is deprecated for WWW-Authenticate and Proxy-Authenticate,
* but not for other AAA related headers
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ProxyAuthenticateList.java 0100644 0000000 0000000 00000003765 13513104763 022627 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* List of ProxyAuthenticate headers.
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:34 $
*
* @author M. Ranganathan
*
*
*
*/
public class ProxyAuthenticateList extends SIPHeaderList {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 1L;
public Object clone() {
ProxyAuthenticateList retval = new ProxyAuthenticateList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor
*/
public ProxyAuthenticateList() {
super(ProxyAuthenticate.class, ProxyAuthenticateHeader.NAME);
}
}
java/gov/nist/javax/sip/header/ProxyAuthorization.java 0100644 0000000 0000000 00000010575 13513104763 022212 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* ProxyAuthorization Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:34 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class ProxyAuthorization
extends AuthenticationHeader
implements ProxyAuthorizationHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6374966905199799098L;
/** default constructor
*/
public ProxyAuthorization() {
super(PROXY_AUTHORIZATION);
}
}
/*
* $Log: ProxyAuthorization.java,v $
* Revision 1.5 2009/07/17 18:57:34 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:46 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ProxyAuthorizationList.java 0100644 0000000 0000000 00000003774 13513104763 023051 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* List of ProxyAuthorization headers.
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:34 $
*
* @author M. Ranganathan
*
*
*
*/
public class ProxyAuthorizationList extends SIPHeaderList{
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -1L;
public Object clone() {
ProxyAuthorizationList retval = new ProxyAuthorizationList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor
*/
public ProxyAuthorizationList() {
super(ProxyAuthorization.class, ProxyAuthorizationHeader.NAME);
}
}
java/gov/nist/javax/sip/header/ProxyRequire.java 0100644 0000000 0000000 00000012760 13513104763 020764 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
import javax.sip.header.*;
/**
* ProxyRequire Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:34 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class ProxyRequire extends SIPHeader implements ProxyRequireHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3269274234851067893L;
/**
* Optiontag field
*/
protected String optionTag;
/**
* Default Constructor
*/
public ProxyRequire() {
super(PROXY_REQUIRE);
}
/** Constructor
* @param s String to set
*/
public ProxyRequire(String s) {
super(PROXY_REQUIRE);
optionTag = s;
}
/**
* Encode in canonical form.
* @return String
*/
public String encodeBody() {
return optionTag;
}
/**
* Sets the option tag value to the new supplied optionTag
* parameter.
*
* @param optionTag - the new string value of the option tag.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the optionTag value.
*/
public void setOptionTag(String optionTag) throws ParseException {
if (optionTag == null)
throw new NullPointerException("JAIN-SIP Exception, ProxyRequire, setOptionTag(), the optionTag parameter is null");
this.optionTag = optionTag;
}
/**
* Gets the option tag of this OptionTag class.
*
* @return the string that identifies the option tag value.
*/
public String getOptionTag() {
return optionTag;
}
}
/*
* $Log: ProxyRequire.java,v $
* Revision 1.5 2009/07/17 18:57:34 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:26 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ProxyRequireList.java 0100644 0000000 0000000 00000003765 13513104763 021625 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* Proxy Require SIPSIPObject (list of option tags)
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:34 $
*
* @author M. Ranganathan
*
*
*
*/
public class ProxyRequireList extends SIPHeaderList {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 5648630649476486042L;
public Object clone() {
ProxyRequireList retval = new ProxyRequireList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default Constructor
*/
public ProxyRequireList() {
super(ProxyRequire.class, ProxyRequireHeader.NAME);
}
}
java/gov/nist/javax/sip/header/RAck.java 0100644 0000000 0000000 00000010663 13513104763 017126 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.InvalidArgumentException;
import java.text.ParseException;
/**
* RAck SIP Header implementation
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:34 $
*
* @author M. Ranganathan
*
*
*/
public class RAck extends SIPHeader implements javax.sip.header.RAckHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 743999286077404118L;
protected long cSeqNumber;
protected long rSeqNumber;
protected String method;
/** Creates a new instance of RAck */
public RAck() {
super(NAME);
}
/**
* Encode the body of this header (the stuff that follows headerName). A.K.A
* headerValue.
*
*/
protected String encodeBody() {
// Bug reported by Bruno Konik - was encoded in
// the wrong order.
return new StringBuffer().append(rSeqNumber).append(SP).append(
cSeqNumber).append(SP).append(method).toString();
}
/**
* Gets the CSeq sequence number of this RAckHeader.
*
* @deprecated
* @return the integer value of the cSeq number of the RAckHeader
*/
public int getCSeqNumber() {
return (int) cSeqNumber;
}
/**
* Gets the CSeq sequence number of this RAckHeader.
*
* @return the integer value of the cSeq number of the RAckHeader
*/
public long getCSeqNumberLong() {
return cSeqNumber;
}
/**
* Gets the method of RAckHeader
*
* @return method of RAckHeader
*/
public String getMethod() {
return this.method;
}
/**
* Gets the RSeq sequence number of this RAckHeader.
*
* @deprecated
* @return the integer value of the RSeq number of the RAckHeader
*/
public int getRSeqNumber() {
return (int) rSeqNumber;
}
/**
* @deprecated
* @see javax.sip.header.RAckHeader#setCSeqNumber(int)
*/
public void setCSeqNumber(int cSeqNumber) throws InvalidArgumentException {
this.setCSequenceNumber(cSeqNumber);
}
public void setMethod(String method) throws ParseException {
this.method = method;
}
public long getCSequenceNumber() {
return this.cSeqNumber;
}
public long getRSequenceNumber() {
return this.rSeqNumber;
}
public void setCSequenceNumber(long cSeqNumber)
throws InvalidArgumentException {
if (cSeqNumber <= 0 || cSeqNumber > ((long) 1) << 32 - 1)
throw new InvalidArgumentException("Bad CSeq # " + cSeqNumber);
this.cSeqNumber = cSeqNumber;
}
/**
*@deprecated
* @see javax.sip.header.RAckHeader#setRSeqNumber(int)
*/
public void setRSeqNumber(int rSeqNumber) throws InvalidArgumentException {
this.setRSequenceNumber(rSeqNumber);
}
public void setRSequenceNumber(long rSeqNumber)
throws InvalidArgumentException {
if (rSeqNumber <= 0 || cSeqNumber > ((long) 1) << 32 - 1)
throw new InvalidArgumentException("Bad rSeq # " + rSeqNumber);
this.rSeqNumber = rSeqNumber;
}
}
java/gov/nist/javax/sip/header/RSeq.java 0100644 0000000 0000000 00000005173 13513104763 017160 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.header;
import javax.sip.InvalidArgumentException;
/**
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/10/18 13:46:35 $
*
* @author M. Ranganathan
*
*
*/
public class RSeq extends SIPHeader implements javax.sip.header.RSeqHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 8765762413224043394L;
protected long sequenceNumber;
/** Creates a new instance of RSeq */
public RSeq() {
super(NAME);
}
/** Gets the sequence number of this RSeqHeader.
* @deprecated
* @return the integer value of the Sequence number of the RSeqHeader
*/
public int getSequenceNumber() {
return (int)this.sequenceNumber;
}
/** Encode the body of this header (the stuff that follows headerName).
* A.K.A headerValue.
*/
protected String encodeBody() {
return Long.toString(this.sequenceNumber);
}
public long getSeqNumber() {
return this.sequenceNumber;
}
public void setSeqNumber(long sequenceNumber) throws InvalidArgumentException {
if (sequenceNumber <= 0 ||sequenceNumber > ((long)1)<<32 - 1)
throw new InvalidArgumentException(
"Bad seq number " + sequenceNumber);
this.sequenceNumber = sequenceNumber;
}
/**
* @deprecated
* @see javax.sip.header.RSeqHeader#setSequenceNumber(int)
*/
public void setSequenceNumber(int sequenceNumber) throws InvalidArgumentException {
this.setSeqNumber(sequenceNumber);
}
}
java/gov/nist/javax/sip/header/Reason.java 0100644 0000000 0000000 00000017417 13513104763 017541 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*
* Reason.java
* Reason = "Reason" HCOLON reason-value *(COMMA reason-value)
* reason-value = protocol *(SEMI reason-params)
* protocol = "SIP" / "Q.850" / token
* reason-params = protocol-cause / reason-text
* / reason-extension
* protocol-cause = "cause" EQUAL cause
* cause = 1*DIGIT
* reason-text = "text" EQUAL quoted-string
* reason-extension = generic-param
*/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.Utils;
import java.text.ParseException;
/**
* Definition of the Reason SIP Header.
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/10/18 13:46:34 $
*
* @author M. Ranganathan
*
*
*/
public class Reason
extends ParametersHeader
implements javax.sip.header.ReasonHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -8903376965568297388L;
public final String TEXT = ParameterNames.TEXT;
public final String CAUSE = ParameterNames.CAUSE;
protected String protocol;
/** Get the cause token.
*@return the cause code.
*/
public int getCause() {
return getParameterAsInt(CAUSE);
}
/**
* Set the cause.
*
*@param cause - cause to set.
*/
public void setCause(int cause) throws javax.sip.InvalidArgumentException {
this.parameters.set("cause", Integer.valueOf(cause));
}
/** Set the protocol
*
*@param protocol - protocol to set.
*/
public void setProtocol(String protocol) throws ParseException {
this.protocol = protocol;
}
/** Return the protocol.
*
*@return the protocol.
*/
public String getProtocol() {
return this.protocol;
}
/** Set the text.
*
*@param text -- string text to set.
*/
public void setText(String text) throws ParseException {
// JvB: MUST be quoted
if ( text.charAt(0) != '"' ) {
text = Utils.getQuotedString(text);
}
this.parameters.set("text", text);
}
/** Get the text.
*
*@return text parameter.
*
*/
public String getText() {
return this.parameters.getParameter("text");
}
/** Set the cause.
/** Creates a new instance of Reason */
public Reason() {
super(NAME);
}
/** Gets the unique string name of this Header. A name constant is defined in
* each individual Header identifying each Header.
*
* @return the name of this specific Header
*/
public String getName() {
return NAME;
}
/**
* Encode the body of this header (the stuff that follows headerName).
* A.K.A headerValue.
*/
protected String encodeBody() {
StringBuffer s = new StringBuffer();
s.append(protocol);
if (parameters != null && !parameters.isEmpty())
s.append(SEMICOLON).append(parameters.encode());
return s.toString();
}
}
/*
* $Log: Reason.java,v $
* Revision 1.8 2009/10/18 13:46:34 deruelle_jean
* FindBugs Fixes (Category Performance Warnings)
*
* Issue number:
* Obtained from:
* Submitted by: Jean Deruelle
* Reviewed by:
*
* Revision 1.7 2009/07/17 18:57:35 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.6 2008/11/19 10:56:27 jbemmel
* Ensure that reason text is quoted
*
* Revision 1.5 2006/11/01 02:22:56 mranga
* Issue number: 83
* Obtained from:
* Submitted by:
* Reviewed by: mranga
* fix thread safety issue in NameValueList and clean up some mess.
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.4 2006/07/13 09:01:19 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ReasonList.java 0100644 0000000 0000000 00000003612 13513104763 020365 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.List;
import javax.sip.header.*;
/**
* List of Reason headers.
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:35 $
*
* @author M. Ranganathan
*
*
*/
public final class ReasonList extends SIPHeaderList {
private static final long serialVersionUID = 7459989997463160670L;
public Object clone() {
ReasonList retval = new ReasonList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor
*/
public ReasonList() {
super(Reason.class, ReasonHeader.NAME);
}
}
java/gov/nist/javax/sip/header/RecordRoute.java 0100644 0000000 0000000 00000005467 13513104763 020551 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.address.*;
/**
* The Request-Route header is added to a request by any proxy that insists on
* being in the path of subsequent requests for the same call leg.
*
*@version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:35 $
*
*@author M. Ranganathan
*
*
*
*/
public class RecordRoute
extends AddressParametersHeader
implements javax.sip.header.RecordRouteHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 2388023364181727205L;
/**
* constructor
* @param address address to set
*/
public RecordRoute(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* default constructor
*/
public RecordRoute() {
super(RECORD_ROUTE);
}
/** Encode into canonical form.
*@return String containing the canonicaly encoded header.
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
buffer.append(LESS_THAN);
}
address.encode(buffer);
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
buffer.append(GREATER_THAN);
}
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
this.parameters.encode(buffer);
}
return buffer;
}
}
java/gov/nist/javax/sip/header/RecordRouteList.java 0100644 0000000 0000000 00000003665 13513104763 021403 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* RecordRoute List of SIP headers (a collection of Addresses)
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:35 $
*
* @author M. Ranganathan
*
*
*
*/
public class RecordRouteList extends SIPHeaderList {
private static final long serialVersionUID = 1724940469426766691L;
public Object clone() {
RecordRouteList retval = new RecordRouteList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor
*/
public RecordRouteList() {
super(RecordRoute.class, RecordRouteHeader.NAME);
}
}
java/gov/nist/javax/sip/header/ReferTo.java 0100644 0000000 0000000 00000011667 13513104763 017661 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.address.*;
/**
* ReferTo SIP Header.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:35 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public final class ReferTo
extends AddressParametersHeader
implements javax.sip.header.ReferToHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -1666700428440034851L;
/** default Constructor.
*/
public ReferTo() {
super(NAME);
}
/**
* Encode the header content into a String.
* @return String
*/
protected String encodeBody() {
if (address == null)
return null;
String retval = "";
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval += LESS_THAN;
}
retval += address.encode();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval += GREATER_THAN;
}
if (!parameters.isEmpty()) {
retval += SEMICOLON + parameters.encode();
}
return retval;
}
}
/*
* $Log: ReferTo.java,v $
* Revision 1.6 2009/07/17 18:57:35 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.5 2006/07/13 09:01:40 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.3 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/ReplyTo.java 0100644 0000000 0000000 00000013227 13513104763 017703 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
import gov.nist.javax.sip.address.*;
import javax.sip.header.*;
/**
* ReplyTo Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:36 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public final class ReplyTo
extends AddressParametersHeader
implements ReplyToHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -9103698729465531373L;
/** Default constructor
*/
public ReplyTo() {
super(NAME);
}
/** Default constructor given an address.
*
*@param address -- address of this header.
*
*/
public ReplyTo(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* Encode the header into a String.
* @return String
*/
public String encode() {
return headerName + COLON + SP + encodeBody() + NEWLINE;
}
/**
* Encode the header content into a String.
* @return String
*/
public String encodeBody() {
String retval = "";
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval += LESS_THAN;
}
retval += address.encode();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval += GREATER_THAN;
}
if (!parameters.isEmpty()) {
retval += SEMICOLON + parameters.encode();
}
return retval;
}
/**
* Conveniance accessor function to get the hostPort field from the address
* @return HostPort
*/
public HostPort getHostPort() {
return address.getHostPort();
}
/**
* Get the display name from the address.
* @return String
*/
public String getDisplayName() {
return address.getDisplayName();
}
}
/*
* $Log: ReplyTo.java,v $
* Revision 1.5 2009/07/17 18:57:36 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:31 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/RequestLine.java 0100644 0000000 0000000 00000022135 13513104763 020543 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.address.URI;
import gov.nist.javax.sip.address.*;
/**
* RequestLine of SIP Request.
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/09/15 02:55:27 $
* @author M. Ranganathan
*/
public class RequestLine extends SIPObject implements SipRequestLine {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3286426172326043129L;
/** uri field. Note that this can be a SIP URI or a generic URI
* like tel URI.
*/
protected GenericURI uri;
/** method field.
*/
protected String method;
/** sipVersion field
*/
protected String sipVersion;
/** Default constructor
*/
public RequestLine() {
sipVersion = "SIP/2.0";
}
/** Encode the request line as a String.
*
* @return requestLine encoded as a string.
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
if (method != null) {
buffer.append(method);
buffer.append(SP);
}
if (uri != null) {
uri.encode(buffer);
buffer.append(SP);
}
buffer.append(sipVersion);
buffer.append(NEWLINE);
return buffer;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#getUri()
*/
public GenericURI getUri() {
return uri;
}
/** Constructor given the request URI and the method.
*/
public RequestLine(GenericURI requestURI, String method) {
this.uri = requestURI;
this.method = method;
this.sipVersion = "SIP/2.0";
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#getMethod()
*/
public String getMethod() {
return method;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#getSipVersion()
*/
public String getSipVersion() {
return sipVersion;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#setUri(gov.nist.javax.sip.address.GenericURI)
*/
public void setUri(URI uri) {
this.uri = (GenericURI)uri;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#setMethod(java.lang.String)
*/
public void setMethod(String method) {
this.method = method;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#setSipVersion(java.lang.String)
*/
public void setSipVersion(String version) {
this.sipVersion = version;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#getVersionMajor()
*/
public String getVersionMajor() {
if (sipVersion == null)
return null;
String major = null;
boolean slash = false;
for (int i = 0; i < sipVersion.length(); i++) {
if (sipVersion.charAt(i) == '.')
break;
if (slash) {
if (major == null)
major = "" + sipVersion.charAt(i);
else
major += sipVersion.charAt(i);
}
if (sipVersion.charAt(i) == '/')
slash = true;
}
return major;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipRequestLine#getVersionMinor()
*/
public String getVersionMinor() {
if (sipVersion == null)
return null;
String minor = null;
boolean dot = false;
for (int i = 0; i < sipVersion.length(); i++) {
if (dot) {
if (minor == null)
minor = "" + sipVersion.charAt(i);
else
minor += sipVersion.charAt(i);
}
if (sipVersion.charAt(i) == '.')
dot = true;
}
return minor;
}
/**
* Compare for equality.
*
*@param other object to compare with. We assume that all fields
* are set.
*/
public boolean equals(Object other) {
boolean retval;
if (!other.getClass().equals(this.getClass())) {
return false;
}
RequestLine that = (RequestLine) other;
try {
retval =
this.method.equals(that.method)
&& this.uri.equals(that.uri)
&& this.sipVersion.equals(that.sipVersion);
} catch (NullPointerException ex) {
retval = false;
}
return retval;
}
public Object clone() {
RequestLine retval = (RequestLine) super.clone();
if (this.uri != null)
retval.uri = (GenericURI) this.uri.clone();
return retval;
}
}
/*
* $Log: RequestLine.java,v $
* Revision 1.8 2009/09/15 02:55:27 mranga
* Issue number: 222
* Add HeaderFactoryExt.createStatusLine(String) and HeaderFactoryExt.createRequestLine(String)
* Allows users to easily parse SipFrag bodies (for example NOTIFY bodies
* during call transfer).
*
* Revision 1.7 2009/07/17 18:57:36 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.6 2007/02/12 15:19:23 belangery
* Changed the encode() and encodeBody() methods of SIP headers and basic classes to make them use the same StringBuffer instance during the encoding phase.
*
* Revision 1.5 2006/07/13 09:01:26 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.3 2005/04/16 20:38:50 dmuresan
* Canonical clone() implementations for the GenericObject and GenericObjectList hierarchies
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/Require.java 0100644 0000000 0000000 00000012744 13513104763 017724 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
import javax.sip.header.*;
/**
* Require SIP Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:36 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*/
public class Require extends SIPHeader implements RequireHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3743425404884053281L;
/** optionTag field
*/
protected String optionTag;
/**
* Default constructor
*/
public Require() {
super(REQUIRE);
}
/** constructor
* @param s String to set
*/
public Require(String s) {
super(REQUIRE);
optionTag = s;
}
/**
* Encode in canonical form.
* @return String
*/
public String encodeBody() {
return optionTag;
}
/**
* Sets the option tag value to the new supplied optionTag
* parameter.
*
* @param optionTag - the new string value of the option tag.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the optionTag value.
*/
public void setOptionTag(String optionTag) throws ParseException {
if (optionTag == null)
throw new NullPointerException(
"JAIN-SIP Exception, Require, "
+ "setOptionTag(), the optionTag parameter is null");
this.optionTag = optionTag;
}
/**
* Gets the option tag of this OptionTag class.
*
* @return the string that identifies the option tag value.
*/
public String getOptionTag() {
return optionTag;
}
}
/*
* $Log: Require.java,v $
* Revision 1.5 2009/07/17 18:57:36 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:22 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/RequireList.java 0100644 0000000 0000000 00000003674 13513104763 020562 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* List of Require headers.
*
* Require = "Require" ":" 1#option-tag
*
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:36 $
*
* @author M. Ranganathan
*
*
*/
public final class RequireList extends SIPHeaderList {
private static final long serialVersionUID = -1760629092046963213L;
public Object clone() {
RequireList retval = new RequireList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default constructor
*/
public RequireList() {
super(Require.class, RequireHeader.NAME);
}
}
java/gov/nist/javax/sip/header/RetryAfter.java 0100644 0000000 0000000 00000012653 13513104763 020376 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.*;
import java.text.ParseException;
import javax.sip.header.*;
/**
* Retry-After SIP Header.
*
* @version 1.2 $Revision: 1.9 $ $Date: 2009/11/04 17:35:55 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*/
public class RetryAfter extends ParametersHeader implements RetryAfterHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -1029458515616146140L;
/** constant DURATION parameter.
*/
public static final String DURATION = ParameterNames.DURATION;
/** duration field
*/
protected Integer retryAfter = new Integer(0);
/** comment field
*/
protected String comment;
/** Default constructor
*/
public RetryAfter() {
super(NAME);
}
/** Encode body of this into cannonical form.
* @return encoded body
*/
public String encodeBody() {
StringBuffer s = new StringBuffer();
if (retryAfter != null)
s.append(retryAfter);
if (comment != null)
s.append(SP + LPAREN + comment + RPAREN);
if (!parameters.isEmpty()) {
s.append(SEMICOLON + parameters.encode());
}
return s.toString();
}
/** Boolean function
* @return true if comment exist, false otherwise
*/
public boolean hasComment() {
return comment != null;
}
/** remove comment field
*/
public void removeComment() {
comment = null;
}
/** remove duration field
*/
public void removeDuration() {
super.removeParameter(DURATION);
}
/**
* Sets the retry after value of the RetryAfterHeader.
* The retry after value MUST be greater than zero and
* MUST be less than 2**31.
*
* @param retryAfter - the new retry after value of this RetryAfterHeader
* @throws InvalidArgumentException if supplied value is less than zero.
*
*/
public void setRetryAfter(int retryAfter) throws InvalidArgumentException {
if (retryAfter < 0)
throw new InvalidArgumentException(
"invalid parameter " + retryAfter);
this.retryAfter = Integer.valueOf(retryAfter);
}
/**
* Gets the retry after value of the RetryAfterHeader. This retry after
* value is relative time.
*
* @return the retry after value of the RetryAfterHeader.
*
*/
public int getRetryAfter() {
return retryAfter.intValue();
}
/**
* Gets the comment of RetryAfterHeader.
*
* @return the comment of this RetryAfterHeader, return null if no comment
* is available.
*/
public String getComment() {
return comment;
}
/**
* Sets the comment value of the RetryAfterHeader.
*
* @param comment - the new comment string value of the RetryAfterHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the comment.
*/
public void setComment(String comment) throws ParseException {
if (comment == null)
throw new NullPointerException("the comment parameter is null");
this.comment = comment;
}
/**
* Sets the duration value of the RetryAfterHeader. The retry after value
* MUST be greater than zero and MUST be less than 2**31.
*
* @param duration - the new duration value of this RetryAfterHeader
* @throws InvalidArgumentException if supplied value is less than zero.
*
*/
public void setDuration(int duration) throws InvalidArgumentException {
if (duration < 0)
throw new InvalidArgumentException("the duration parameter is <0");
this.setParameter(DURATION, duration);
}
/**
* Gets the duration value of the RetryAfterHeader. This duration value
* is relative time.
*
* @return the duration value of the RetryAfterHeader, return zero if not
* set.
*
*/
public int getDuration() {
if (this.getParameter(DURATION) == null) return -1;
else return super.getParameterAsInt(DURATION);
}
}
java/gov/nist/javax/sip/header/Route.java 0100644 0000000 0000000 00000006265 13513104763 017407 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.address.AddressImpl;
import javax.sip.header.RouteHeader;
/**
* Route SIPHeader Object
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:36 $
*
* @author M. Ranganathan
*
*
*/
public class Route
extends AddressParametersHeader
implements javax.sip.header.RouteHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 5683577362998368846L;
/** Default constructor
*/
public Route() {
super(NAME);
}
/** Default constructor given an address.
*
*@param address -- address of this header.
*
*/
public Route(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* Hashcode so this header can be inserted into a set.
*
*@return the hashcode of the encoded address.
*/
public int hashCode() {
return this.address.getHostPort().encode().toLowerCase().hashCode();
}
/**
* Encode into canonical form.
* Acknowledgement: contains a bug fix for a bug reported by
* Laurent Schwizer
*
*@return a canonical encoding of the header.
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
boolean addrFlag = address.getAddressType() == AddressImpl.NAME_ADDR;
if (!addrFlag) {
buffer.append('<');
address.encode(buffer);
buffer.append('>');
} else {
address.encode(buffer);
}
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
return buffer;
}
public boolean equals(Object other) {
return (other instanceof RouteHeader) && super.equals(other);
}
}
java/gov/nist/javax/sip/header/RouteList.java 0100644 0000000 0000000 00000005156 13513104763 020241 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.util.*;
/**
* A list of Route Headers.
*
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:36 $
*
* @author M. Ranganathan
*
*
*
*/
public class RouteList extends SIPHeaderList {
private static final long serialVersionUID = 3407603519354809748L;
/** default constructor
*/
public RouteList() {
super(Route.class, RouteHeader.NAME);
}
public Object clone() {
RouteList retval = new RouteList();
retval.clonehlist(this.hlist);
return retval;
}
public String encode() {
if ( super.hlist.isEmpty()) return "";
else return super.encode();
}
/**
* Order is important when comparing route lists.
*/
public boolean equals(Object other) {
if (!(other instanceof RouteList))
return false;
RouteList that = (RouteList) other;
if (this.size() != that.size())
return false;
ListIterator it = this.listIterator();
ListIterator it1 = that.listIterator();
while (it.hasNext()) {
Route route = (Route) it.next();
Route route1 = (Route) it1.next();
if (!route.equals(route1))
return false;
}
return true;
}
}
java/gov/nist/javax/sip/header/SIPDate.java 0100644 0000000 0000000 00000044217 13513104763 017541 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.*;
import java.util.Calendar;
import java.util.TimeZone;
import java.util.Locale;
import java.util.GregorianCalendar;
import java.io.Serializable;
import java.lang.IllegalArgumentException;
/**
* Implements a parser class for tracking expiration time
* when specified as a Date value.
*
* From the HTTP 1.1 spec
*14.18 Date
*
* The Date general-header field represents the date and time at which
* the message was originated, having the same semantics as orig-date in
* RFC 822. The field value is an HTTP-date, as described in section
* 3.3.1; it MUST be sent in RFC 1123 [8]-date format.
* Date = "Date" ":" HTTP-date
*
* An example is
*
* Date: Tue, 15 Nov 1994 08:12:31 GMT
*
*
*@version 1.2 $Revision: 1.9 $ $Date: 2009/10/18 13:46:33 $
*
*@author M. Ranganathan
*
*
*
*
*/
public class SIPDate implements Cloneable,Serializable {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 8544101899928346909L;
public static final String GMT = "GMT";
public static final String MON = "Mon";
public static final String TUE = "Tue";
public static final String WED = "Wed";
public static final String THU = "Thu";
public static final String FRI = "Fri";
public static final String SAT = "Sat";
public static final String SUN = "Sun";
public static final String JAN = "Jan";
public static final String FEB = "Feb";
public static final String MAR = "Mar";
public static final String APR = "Apr";
public static final String MAY = "May";
public static final String JUN = "Jun";
public static final String JUL = "Jul";
public static final String AUG = "Aug";
public static final String SEP = "Sep";
public static final String OCT = "Oct";
public static final String NOV = "Nov";
public static final String DEC = "Dec";
/** sipWkDay member
*/
protected String sipWkDay;
/** sipMonth member
*/
protected String sipMonth;
/** wkday member
*/
protected int wkday;
/** day member
*/
protected int day;
/** month member
*/
protected int month;
/** year member
*/
protected int year;
/** hour member
*/
protected int hour;
/** minute member
*/
protected int minute;
/** second member
*/
protected int second;
/** javaCal member
*/
private java.util.Calendar javaCal;
/** equality check.
*
*@return true if the two date fields are equals
*/
public boolean equals(Object that){
if (that.getClass() != this.getClass())return false;
SIPDate other = (SIPDate)that;
return this.wkday == other.wkday &&
this.day == other.day &&
this.month == other.month &&
this.year == other.year &&
this.hour == other.hour &&
this.minute == other.minute &&
this.second == other.second;
}
/**
* Initializer, sets all the fields to invalid values.
*/
public SIPDate() {
wkday = -1;
day = -1;
month = -1;
year = -1;
hour = -1;
minute = -1;
second = -1;
javaCal = null;
}
/**
* Construct a SIP date from the time offset given in miliseconds
* @param timeMillis long to set
*/
public SIPDate(long timeMillis) {
javaCal =
new GregorianCalendar(
TimeZone.getTimeZone("GMT:0"),
Locale.getDefault());
java.util.Date date = new java.util.Date(timeMillis);
javaCal.setTime(date);
wkday = javaCal.get(Calendar.DAY_OF_WEEK);
switch (wkday) {
case Calendar.MONDAY :
sipWkDay = MON;
break;
case Calendar.TUESDAY :
sipWkDay = TUE;
break;
case Calendar.WEDNESDAY :
sipWkDay = WED;
break;
case Calendar.THURSDAY :
sipWkDay = THU;
break;
case Calendar.FRIDAY :
sipWkDay = FRI;
break;
case Calendar.SATURDAY :
sipWkDay = SAT;
break;
case Calendar.SUNDAY :
sipWkDay = SUN;
break;
default :
InternalErrorHandler.handleException(
"No date map for wkday " + wkday);
}
day = javaCal.get(Calendar.DAY_OF_MONTH);
month = javaCal.get(Calendar.MONTH);
switch (month) {
case Calendar.JANUARY :
sipMonth = JAN;
break;
case Calendar.FEBRUARY :
sipMonth = FEB;
break;
case Calendar.MARCH :
sipMonth = MAR;
break;
case Calendar.APRIL :
sipMonth = APR;
break;
case Calendar.MAY :
sipMonth = MAY;
break;
case Calendar.JUNE :
sipMonth = JUN;
break;
case Calendar.JULY :
sipMonth = JUL;
break;
case Calendar.AUGUST :
sipMonth = AUG;
break;
case Calendar.SEPTEMBER :
sipMonth = SEP;
break;
case Calendar.OCTOBER :
sipMonth = OCT;
break;
case Calendar.NOVEMBER :
sipMonth = NOV;
break;
case Calendar.DECEMBER :
sipMonth = DEC;
break;
default :
InternalErrorHandler.handleException(
"No date map for month " + month);
}
year = javaCal.get(Calendar.YEAR);
// Bug report by Bruno Konik
hour = javaCal.get(Calendar.HOUR_OF_DAY);
minute = javaCal.get(Calendar.MINUTE);
second = javaCal.get(Calendar.SECOND);
}
/**
* Get canonical string representation.
* @return String
*/
public String encode() {
String dayString;
if (day < 10) {
dayString = "0" + day;
} else
dayString = "" + day;
String hourString;
if (hour < 10) {
hourString = "0" + hour;
} else
hourString = "" + hour;
String minuteString;
if (minute < 10) {
minuteString = "0" + minute;
} else
minuteString = "" + minute;
String secondString;
if (second < 10) {
secondString = "0" + second;
} else
secondString = "" + second;
String encoding = "";
if (sipWkDay != null)
encoding += sipWkDay + Separators.COMMA + Separators.SP;
encoding += dayString + Separators.SP;
if (sipMonth != null)
encoding += sipMonth + Separators.SP;
encoding += year
+ Separators.SP
+ hourString
+ Separators.COLON
+ minuteString
+ Separators.COLON
+ secondString
+ Separators.SP
+ GMT;
return encoding;
}
/**
* The only accessor we allow is to the java calendar record.
* All other fields are for this package only.
* @return Calendar
*/
public java.util.Calendar getJavaCal() {
if (javaCal == null)
setJavaCal();
return javaCal;
}
/** get the WkDay field
* @return String
*/
public String getWkday() {
return sipWkDay;
}
/** get the month
* @return String
*/
public String getMonth() {
return sipMonth;
}
/** get the hour
* @return int
*/
public int getHour() {
return hour;
}
/** get the minute
* @return int
*/
public int getMinute() {
return minute;
}
/** get the second
* @return int
*/
public int getSecond() {
return second;
}
/**
* convert the SIP Date of this structure to a Java Date.
* SIP Dates are forced to be GMT. Stores the converted time
* as a java Calendar class.
*/
private void setJavaCal() {
javaCal =
new GregorianCalendar(
TimeZone.getTimeZone("GMT:0"),
Locale.getDefault());
if (year != -1)
javaCal.set(Calendar.YEAR, year);
if (day != -1)
javaCal.set(Calendar.DAY_OF_MONTH, day);
if (month != -1)
javaCal.set(Calendar.MONTH, month);
if (wkday != -1)
javaCal.set(Calendar.DAY_OF_WEEK, wkday);
if (hour != -1)
javaCal.set(Calendar.HOUR, hour);
if (minute != -1)
javaCal.set(Calendar.MINUTE, minute);
if (second != -1)
javaCal.set(Calendar.SECOND, second);
}
/**
* Set the wkday member
* @param w String to set
* @throws IllegalArgumentException if w is not a valid day.
*/
public void setWkday(String w) throws IllegalArgumentException {
sipWkDay = w;
if (sipWkDay.compareToIgnoreCase(MON) == 0) {
wkday = Calendar.MONDAY;
} else if (sipWkDay.compareToIgnoreCase(TUE) == 0) {
wkday = Calendar.TUESDAY;
} else if (sipWkDay.compareToIgnoreCase(WED) == 0) {
wkday = Calendar.WEDNESDAY;
} else if (sipWkDay.compareToIgnoreCase(THU) == 0) {
wkday = Calendar.THURSDAY;
} else if (sipWkDay.compareToIgnoreCase(FRI) == 0) {
wkday = Calendar.FRIDAY;
} else if (sipWkDay.compareToIgnoreCase(SAT) == 0) {
wkday = Calendar.SATURDAY;
} else if (sipWkDay.compareToIgnoreCase(SUN) == 0) {
wkday = Calendar.SUNDAY;
} else {
throw new IllegalArgumentException("Illegal Week day :" + w);
}
}
/**
* Set the day member
* @param d int to set
* @throws IllegalArgumentException if d is not a valid day
*/
public void setDay(int d) throws IllegalArgumentException {
if (d < 1 || d > 31)
throw new IllegalArgumentException(
"Illegal Day of the month " + Integer.toString(d));
day = d;
}
/**
* Set the month member
* @param m String to set.
* @throws IllegalArgumentException if m is not a valid month
*/
public void setMonth(String m) throws IllegalArgumentException {
sipMonth = m;
if (sipMonth.compareToIgnoreCase(JAN) == 0) {
month = Calendar.JANUARY;
} else if (sipMonth.compareToIgnoreCase(FEB) == 0) {
month = Calendar.FEBRUARY;
} else if (sipMonth.compareToIgnoreCase(MAR) == 0) {
month = Calendar.MARCH;
} else if (sipMonth.compareToIgnoreCase(APR) == 0) {
month = Calendar.APRIL;
} else if (sipMonth.compareToIgnoreCase(MAY) == 0) {
month = Calendar.MAY;
} else if (sipMonth.compareToIgnoreCase(JUN) == 0) {
month = Calendar.JUNE;
} else if (sipMonth.compareToIgnoreCase(JUL) == 0) {
month = Calendar.JULY;
} else if (sipMonth.compareToIgnoreCase(AUG) == 0) {
month = Calendar.AUGUST;
} else if (sipMonth.compareToIgnoreCase(SEP) == 0) {
month = Calendar.SEPTEMBER;
} else if (sipMonth.compareToIgnoreCase(OCT) == 0) {
month = Calendar.OCTOBER;
} else if (sipMonth.compareToIgnoreCase(NOV) == 0) {
month = Calendar.NOVEMBER;
} else if (sipMonth.compareToIgnoreCase(DEC) == 0) {
month = Calendar.DECEMBER;
} else {
throw new IllegalArgumentException("Illegal Month :" + m);
}
}
/**
* Set the year member
* @param y int to set
* @throws IllegalArgumentException if y is not a valid year.
*/
public void setYear(int y) throws IllegalArgumentException {
if (y < 0)
throw new IllegalArgumentException("Illegal year : " + y);
javaCal = null;
year = y;
}
/**
* Get the year member.
*/
public int getYear() {
return year;
}
/**
* Set the hour member
* @param h int to set
* @throws IllegalArgumentException if h is not a valid hour.
*/
public void setHour(int h) throws IllegalArgumentException {
if (h < 0 || h > 24)
throw new IllegalArgumentException("Illegal hour : " + h);
javaCal = null;
hour = h;
}
/**
* Set the minute member
* @param m int to set
* @throws IllegalArgumentException if m is not a valid minute
*/
public void setMinute(int m) throws IllegalArgumentException {
if (m < 0 || m >= 60)
throw new IllegalArgumentException(
"Illegal minute : " + (Integer.toString(m)));
javaCal = null;
minute = m;
}
/**
* Set the second member
* @param s int to set
* @throws IllegalArgumentException if s is not a valid second
*/
public void setSecond(int s) throws IllegalArgumentException {
if (s < 0 || s >= 60)
throw new IllegalArgumentException(
"Illegal second : " + Integer.toString(s));
javaCal = null;
second = s;
}
/** Get the time offset from the current time.
*
*@return offset from the current time.
*/
public int getDeltaSeconds() {
// long ctime = this.getJavaCal().getTimeInMillis();
long ctime = this.getJavaCal().getTime().getTime();
return (int) (ctime - System.currentTimeMillis()) / 1000;
}
public Object clone() {
SIPDate retval;
try {
retval = (SIPDate) super.clone();
} catch (CloneNotSupportedException e) {
throw new RuntimeException("Internal error");
}
if (javaCal != null)
retval.javaCal = (java.util.Calendar) javaCal.clone();
return retval;
}
}
/*
* $Log: SIPDate.java,v $
* Revision 1.9 2009/10/18 13:46:33 deruelle_jean
* FindBugs Fixes (Category Performance Warnings)
*
* Issue number:
* Obtained from:
* Submitted by: Jean Deruelle
* Reviewed by:
*
* Revision 1.8 2009/07/17 18:57:37 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.7 2006/07/13 09:01:16 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.5 2005/04/16 20:35:10 dmuresan
* SIPDate made cloneable.
*
* Revision 1.4 2004/07/28 14:41:53 mranga
* Submitted by: mranga
*
* fixed equality check for SIPDate.
*
* Revision 1.3 2004/04/05 21:46:08 mranga
* Submitted by: Bruno Konik
* Reviewed by: mranga
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/SIPDateHeader.java 0100644 0000000 0000000 00000013064 13513104763 020646 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.*;
import javax.sip.header.*;
/**
* Date Header.
*
*@version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:37 $
*
*@author M. Ranganathan
*@author Olivier Deruelle
*
*
*/
public class SIPDateHeader extends SIPHeader implements DateHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 1734186339037274664L;
/** date field
*/
protected SIPDate date;
/** Default constructor.
*/
public SIPDateHeader() {
super(DATE);
}
/** Encode the header into a String.
* @return String
*/
public String encodeBody() {
return date.encode();
}
/**
* Set the date member
* @param d SIPDate to set
*/
public void setDate(SIPDate d) {
date = d;
}
/**
* Sets date of DateHeader. The date is repesented by the Calendar object.
*
* @param dat the Calendar object date of this header.
*/
public void setDate(Calendar dat) {
if (dat != null)
date = new SIPDate(dat.getTime().getTime());
}
/**
* Gets the date of DateHeader. The date is repesented by the Calender
* object.
*
* @return the Calendar object representing the date of DateHeader
*/
public Calendar getDate() {
if (date == null)
return null;
return date.getJavaCal();
}
public Object clone() {
SIPDateHeader retval = (SIPDateHeader) super.clone();
if (this.date != null)
retval.date = (SIPDate) this.date.clone();
return retval;
}
}
/*
* $Log: SIPDateHeader.java,v $
* Revision 1.6 2009/07/17 18:57:37 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.5 2006/07/13 09:01:23 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:26 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.3 2005/04/16 20:38:50 dmuresan
* Canonical clone() implementations for the GenericObject and GenericObjectList hierarchies
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/SIPETag.java 0100644 0000000 0000000 00000005646 13513104763 017507 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.text.ParseException;
/**
* the SIP-ETag header.
*
* @author Jeroen van Bemmel
* @version 1.2 $Revision: 1.3 $ $Date: 2009/07/17 18:57:37 $
* @since 1.2
*/
public class SIPETag extends SIPHeader implements SIPETagHeader , ExtensionHeader{
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 3837543366074322107L;
/**
* entity tag field
*/
protected String entityTag;
/** Default constructor
*/
public SIPETag() {
super(NAME);
}
public SIPETag( String tag ) throws ParseException {
this();
this.setETag( tag );
}
/**
* Encode into canonical form.
* @return String
*/
public String encodeBody() {
return entityTag;
}
/**
* get the priority value.
* @return String
*/
public String getETag() {
return entityTag;
}
/**
* Set the priority member
* @param etag String to set
*/
public void setETag(String etag) throws ParseException {
if (etag == null)
throw new NullPointerException(
"JAIN-SIP Exception,"
+ "SIP-ETag, setETag(), the etag parameter is null");
this.entityTag = etag;
}
/**
* This method needs to be added for backwards compatibility to
* avoid ClassCast exception on V1.1 applications
*
* @see javax.sip.header.ExtensionHeader#setValue(java.lang.String)
*/
public void setValue(String value) throws ParseException {
this.setETag(value);
}
}
java/gov/nist/javax/sip/header/SIPHeader.java 0100644 0000000 0000000 00000010410 13513104763 020040 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
/**
* Root class from which all SIPHeader objects are subclassed.
*
* @author M. Ranganathan
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:37 $
*
*
*/
public abstract class SIPHeader
extends SIPObject
implements SIPHeaderNames, javax.sip.header.Header, HeaderExt {
/** name of this header
*/
protected String headerName;
/** Value of the header.
*/
/** Constructor
* @param hname String to set
*/
protected SIPHeader(String hname) {
headerName = hname;
}
/** Default constructor
*/
public SIPHeader() {
}
/**
* Name of the SIPHeader
* @return String
*/
public String getHeaderName() {
return headerName;
}
/** Alias for getHaderName above.
*
*@return String headerName
*
*/
public String getName() {
return this.headerName;
}
/**
* Set the name of the header .
* @param hdrname String to set
*/
public void setHeaderName(String hdrname) {
headerName = hdrname;
}
/** Get the header value (i.e. what follows the name:).
* This merely goes through and lops off the portion that follows
* the headerName:
*/
public String getHeaderValue() {
String encodedHdr = null;
try {
encodedHdr = this.encode();
} catch (Exception ex) {
return null;
}
StringBuffer buffer = new StringBuffer(encodedHdr);
while (buffer.length() > 0 && buffer.charAt(0) != ':') {
buffer.deleteCharAt(0);
}
if (buffer.length() > 0)
buffer.deleteCharAt(0);
return buffer.toString().trim();
}
/** Return false if this is not a header list
* (SIPHeaderList overrrides this method).
*@return false
*/
public boolean isHeaderList() {
return false;
}
/** Encode this header into canonical form.
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
buffer.append(this.headerName).append(COLON).append(SP);
this.encodeBody(buffer);
buffer.append(NEWLINE);
return buffer;
}
/** Encode the body of this header (the stuff that follows headerName).
* A.K.A headerValue.
*/
protected abstract String encodeBody();
/** Encode the body of this header in the given buffer.
* Default implementation calls encodeBody();
*/
protected StringBuffer encodeBody(StringBuffer buffer) {
return buffer.append(encodeBody());
}
/** Alias for getHeaderValue.
*/
public String getValue() {
return this.getHeaderValue();
}
/**
* This is a pretty simple hashCode but satisfies requirements.
*
*/
public int hashCode() {
return this.headerName.hashCode();
}
public final String toString() {
return this.encode();
}
}
java/gov/nist/javax/sip/header/SIPHeaderList.java 0100644 0000000 0000000 00000043744 13513104763 020714 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.GenericObject;
import gov.nist.core.Separators;
import gov.nist.javax.sip.header.ims.PrivacyHeader;
import javax.sip.header.Header;
import java.lang.reflect.Constructor;
import java.util.*;
/**
*
* This is the root class for all lists of SIP headers. It imbeds a
* SIPObjectList object and extends SIPHeader Lists of ContactSIPObjects etc.
* derive from this class. This supports homogeneous lists (all elements in the
* list are of the same class). We use this for building type homogeneous lists
* of SIPObjects that appear in SIPHeaders
*
* @version 1.2 $Revision: 1.15 $ $Date: 2005/10/09 18:47:53
*/
public abstract class SIPHeaderList extends SIPHeader implements java.util.List, Header {
private static boolean prettyEncode = false;
/**
* hlist field.
*/
protected List hlist;
private Class myClass;
public String getName() {
return this.headerName;
}
private SIPHeaderList() {
hlist = new LinkedList();
}
/**
* Constructor
*
* @param objclass
* Class to set
* @param hname
* String to set
*/
protected SIPHeaderList(Class objclass, String hname) {
this();
this.headerName = hname;
this.myClass = objclass;
}
/**
* Concatenate the list of stuff that we are keeping around and also the
* text corresponding to these structures (that we parsed).
*
* @param objectToAdd
*/
public boolean add(HDR objectToAdd) {
hlist.add((HDR)objectToAdd);
return true;
}
/**
* Concatenate the list of stuff that we are keeping around and also the
* text corresponding to these structures (that we parsed).
*
* @param obj
* Genericobject to set
*/
public void addFirst(HDR obj) {
hlist.add(0,(HDR) obj);
}
/**
* Add to this list.
*
* @param sipheader
* SIPHeader to add.
* @param top
* is true if we want to add to the top of the list.
*/
public void add(HDR sipheader, boolean top) {
if (top)
this.addFirst(sipheader);
else
this.add(sipheader);
}
/**
* Concatenate two compatible lists. This appends or prepends the new list
* to the end of this list.
*
* @param other
* SIPHeaderList to set
* @param topFlag
* flag which indicates which end to concatenate
* the lists.
* @throws IllegalArgumentException
* if the two lists are not compatible
*/
public void concatenate(SIPHeaderList other, boolean topFlag)
throws IllegalArgumentException {
if (!topFlag) {
this.addAll(other);
} else {
// add given items to the top end of the list.
this.addAll(0, other);
}
}
/**
* Encode a list of sip headers. Headers are returned in cannonical form.
*
* @return String encoded string representation of this list of headers.
* (Contains string append of each encoded header).
*/
public String encode() {
return encode(new StringBuffer()).toString();
}
public StringBuffer encode(StringBuffer buffer) {
if (hlist.isEmpty()) {
buffer.append(headerName).append(':').append(Separators.NEWLINE);
}
else {
// The following headers do not have comma separated forms for
// multiple headers. Thus, they must be encoded separately.
if (this.headerName.equals(SIPHeaderNames.WWW_AUTHENTICATE)
|| this.headerName.equals(SIPHeaderNames.PROXY_AUTHENTICATE)
|| this.headerName.equals(SIPHeaderNames.AUTHORIZATION)
|| this.headerName.equals(SIPHeaderNames.PROXY_AUTHORIZATION)
|| (prettyEncode &&
(this.headerName.equals(SIPHeaderNames.VIA) || this.headerName.equals(SIPHeaderNames.ROUTE) || this.headerName.equals(SIPHeaderNames.RECORD_ROUTE))) // Less confusing to read
|| this.getClass().equals( ExtensionHeaderList.class) ) {
ListIterator li = hlist.listIterator();
while (li.hasNext()) {
HDR sipheader = (HDR) li.next();
sipheader.encode(buffer);
}
} else {
// These can be concatenated together in an comma separated
// list.
buffer.append(headerName).append(Separators.COLON).append(Separators.SP);
this.encodeBody(buffer);
buffer.append(Separators.NEWLINE);
}
}
return buffer;
}
/**
* Return a list of encoded strings (one for each sipheader).
*
* @return LinkedList containing encoded strings in this header list. an
* empty list is returned if this header list contains no sip
* headers.
*/
public List getHeadersAsEncodedStrings() {
List retval = new LinkedList();
ListIterator li = hlist.listIterator();
while (li.hasNext()) {
Header sipheader = li.next();
retval.add(sipheader.toString());
}
return retval;
}
/**
* Get the first element of this list.
*
* @return SIPHeader first element of the list.
*/
public Header getFirst() {
if (hlist == null || hlist.isEmpty())
return null;
else
return hlist.get(0);
}
/**
* Get the last element of this list.
*
* @return SIPHeader last element of the list.
*/
public Header getLast() {
if (hlist == null || hlist.isEmpty())
return null;
return hlist.get(hlist.size() - 1);
}
/**
* Get the class for the headers of this list.
*
* @return Class of header supported by this list.
*/
public Class getMyClass() {
return this.myClass;
}
/**
* Empty check
*
* @return boolean true if list is empty
*/
public boolean isEmpty() {
return hlist.isEmpty();
}
/**
* Get an initialized iterator for my imbedded list
*
* @return the generated ListIterator
*/
public ListIterator listIterator() {
return hlist.listIterator(0);
}
/**
* Get the imbedded linked list.
*
* @return the imedded linked list of SIP headers.
*/
public List getHeaderList() {
return this.hlist;
}
/**
* Get the list iterator for a given position.
*
* @param position
* position for the list iterator to return
* @return the generated list iterator
*/
public ListIterator listIterator(int position) {
return hlist.listIterator(position);
}
/**
* Remove the first element of this list.
*/
public void removeFirst() {
if (hlist.size() != 0)
hlist.remove(0);
}
/**
* Remove the last element of this list.
*/
public void removeLast() {
if (hlist.size() != 0)
hlist.remove(hlist.size() - 1);
}
/**
* Remove a sip header from this list of sip headers.
*
* @param obj
* SIPHeader to remove
* @return boolean
*/
public boolean remove(HDR obj) {
if (hlist.size() == 0)
return false;
else
return hlist.remove(obj);
}
/**
* Set the root class for all objects inserted into my list (for assertion
* check)
*
* @param cl
* class to set
*/
protected void setMyClass(Class cl) {
this.myClass = cl;
}
/**
* convert to a string representation (for printing).
*
* @param indentation
* int to set
* @return String string representation of object (for printing).
*/
public String debugDump(int indentation) {
stringRepresentation = "";
String indent = new Indentation(indentation).getIndentation();
String className = this.getClass().getName();
sprint(indent + className);
sprint(indent + "{");
for (Iterator it = hlist.iterator(); it.hasNext();) {
HDR sipHeader = (HDR) it.next();
sprint(indent + sipHeader.debugDump());
}
sprint(indent + "}");
return stringRepresentation;
}
/**
* convert to a string representation
*
* @return String
*/
public String debugDump() {
return debugDump(0);
}
/**
* Array conversion.
*
* @return SIPHeader []
*/
public Object[] toArray() {
return hlist.toArray();
}
/**
* index of an element.
*
* @return index of the given element (-1) if element does not exist.
*/
public int indexOf(GenericObject gobj) {
return hlist.indexOf(gobj);
}
/**
* insert at a location.
*
* @param index
* location where to add the sipHeader.
* @param sipHeader
* SIPHeader structure to add.
*/
public void add(int index, HDR sipHeader)
throws IndexOutOfBoundsException {
hlist.add(index, sipHeader);
}
/**
* Equality comparison operator.
*
* @param other
* the other object to compare with. true is returned iff the
* classes match and list of headers herein is equal to the list
* of headers in the target (order of the headers is not
* important).
*/
@SuppressWarnings("unchecked")
public boolean equals(Object other) {
if (other == this)
return true;
if (other instanceof SIPHeaderList) {
SIPHeaderList that = (SIPHeaderList) other;
if (this.hlist == that.hlist)
return true;
else if (this.hlist == null)
return that.hlist == null || that.hlist.size() == 0;
return this.hlist.equals(that.hlist);
}
return false;
}
/**
* Template match against a template. null field in template indicates wild
* card match.
*/
public boolean match(SIPHeaderList template) {
if (template == null)
return true;
if (!this.getClass().equals(template.getClass()))
return false;
SIPHeaderList that = (SIPHeaderList) template;
if (this.hlist == that.hlist)
return true;
else if (this.hlist == null)
return false;
else {
for (Iterator it = that.hlist.iterator(); it.hasNext();) {
SIPHeader sipHeader = (SIPHeader) it.next();
boolean found = false;
for (Iterator it1 = this.hlist.iterator(); it1.hasNext()
&& !found;) {
SIPHeader sipHeader1 = (SIPHeader) it1.next();
found = sipHeader1.match(sipHeader);
}
if (!found)
return false;
}
return true;
}
}
/**
* make a clone of this header list.
*
* @return clone of this Header.
*/
public Object clone() {
try {
Class clazz = this.getClass();
Constructor cons = clazz.getConstructor((Class[])null);
SIPHeaderList retval = (SIPHeaderList) cons.newInstance((Object[])null);
retval.headerName = this.headerName;
retval.myClass = this.myClass;
return retval.clonehlist(this.hlist);
} catch (Exception ex) {
throw new RuntimeException("Could not clone!", ex);
}
}
protected final SIPHeaderList clonehlist(List hlistToClone) {
if (hlistToClone != null) {
for (Iterator it = (Iterator) hlistToClone.iterator(); it.hasNext();) {
Header h = it.next();
this.hlist.add((HDR)h.clone());
}
}
return this;
}
/**
* Get the number of headers in the list.
*/
public int size() {
return hlist.size();
}
/**
* Return true if this is a header list (overrides the base class method
* which returns false).
*
* @return true
*/
public boolean isHeaderList() {
return true;
}
/**
* Encode the body of this header (the stuff that follows headerName). A.K.A
* headerValue. This will not give a reasonable result for WWW-Authenticate,
* Authorization, Proxy-Authenticate and Proxy-Authorization and hence this
* is protected.
*/
protected String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
ListIterator iterator = this.listIterator();
while (true) {
SIPHeader sipHeader = (SIPHeader) iterator.next();
if ( sipHeader == this ) throw new RuntimeException ("Unexpected circularity in SipHeaderList");
sipHeader.encodeBody(buffer);
// if (body.equals("")) System.out.println("BODY == ");
if (iterator.hasNext()) {
if (!this.headerName.equals(PrivacyHeader.NAME))
buffer.append(Separators.COMMA);
else
buffer.append(Separators.SEMICOLON);
continue;
} else
break;
}
return buffer;
}
public boolean addAll(Collection collection) {
return this.hlist.addAll(collection);
}
public boolean addAll(int index, Collection collection) {
return this.hlist.addAll(index, collection);
}
public boolean containsAll(Collection collection) {
return this.hlist.containsAll(collection);
}
public void clear() {
this.hlist.clear();
}
public boolean contains(Object header) {
return this.hlist.contains(header);
}
/**
* Get the object at the specified location.
*
* @param index --
* location from which to get the object.
*
*/
public HDR get(int index) {
return this.hlist.get(index);
}
/**
* Return the index of a given object.
*
* @param obj --
* object whose index to compute.
*/
public int indexOf(Object obj) {
return this.hlist.indexOf(obj);
}
/**
* Return the iterator to the imbedded list.
*
* @return iterator to the imbedded list.
*
*/
public java.util.Iterator iterator() {
return this.hlist.listIterator();
}
/**
* Get the last index of the given object.
*
* @param obj --
* object whose index to find.
*/
public int lastIndexOf(Object obj) {
return this.hlist.lastIndexOf(obj);
}
/**
* Remove the given object.
*
* @param obj --
* object to remove.
*
*/
public boolean remove(Object obj) {
return this.hlist.remove(obj);
}
/**
* Remove the object at a given index.
*
* @param index --
* index at which to remove the object
*/
public HDR remove(int index) {
return this.hlist.remove(index);
}
/**
* Remove all the elements.
* @see List#removeAll(java.util.Collection)
*/
public boolean removeAll(java.util.Collection collection) {
return this.hlist.removeAll(collection);
}
/**
* @see List#retainAll(java.util.Collection)
* @param collection
*/
public boolean retainAll(java.util.Collection collection) {
return this.hlist.retainAll(collection);
}
/**
* Get a sublist of the list.
*
* @see List#subList(int, int)
*/
public java.util.List subList(int index1, int index2) {
return this.hlist.subList(index1, index2);
}
/**
* @see Object#hashCode()
* @return -- the computed hashcode.
*/
public int hashCode() {
return this.headerName.hashCode();
}
/**
* Set a SIPHeader at a particular position in the list.
*
* @see List#set(int, java.lang.Object)
*/
public HDR set(int position, HDR sipHeader) {
return hlist.set(position, sipHeader);
}
public static void setPrettyEncode(boolean flag) {
prettyEncode = flag;
}
public T[] toArray(T[] array) {
return this.hlist.toArray(array);
}
}
java/gov/nist/javax/sip/header/SIPHeaderNames.java 0100644 0000000 0000000 00000013226 13513104763 021034 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import gov.nist.javax.sip.header.extensions.*;
/**
* SIPHeader names that are supported by this parser
*
* @version 1.2 $Revision: 1.9 $ $Date: 2009/07/17 18:57:37 $
*
* @author M. Ranganathan
*
*
*/
public interface SIPHeaderNames {
public static final String MIN_EXPIRES = MinExpiresHeader.NAME; //1
public static final String ERROR_INFO = ErrorInfoHeader.NAME; //2
public static final String MIME_VERSION = MimeVersionHeader.NAME; //3
public static final String IN_REPLY_TO = InReplyToHeader.NAME; //4
public static final String ALLOW = AllowHeader.NAME; //5
public static final String CONTENT_LANGUAGE = ContentLanguageHeader.NAME;
//6
public static final String CALL_INFO = CallInfoHeader.NAME; //7
public static final String CSEQ = CSeqHeader.NAME; //8
public static final String ALERT_INFO = AlertInfoHeader.NAME; //9
public static final String ACCEPT_ENCODING = AcceptEncodingHeader.NAME;
//10
public static final String ACCEPT = AcceptHeader.NAME; //11
public static final String ACCEPT_LANGUAGE = AcceptLanguageHeader.NAME;
//12
public static final String RECORD_ROUTE = RecordRouteHeader.NAME; //13
public static final String TIMESTAMP = TimeStampHeader.NAME; //14
public static final String TO = ToHeader.NAME; //15
public static final String VIA = ViaHeader.NAME; //16
public static final String FROM = FromHeader.NAME; //17
public static final String CALL_ID = CallIdHeader.NAME; //18
public static final String AUTHORIZATION = AuthorizationHeader.NAME; //19
public static final String PROXY_AUTHENTICATE =
ProxyAuthenticateHeader.NAME;
//20
public static final String SERVER = ServerHeader.NAME; //21
public static final String UNSUPPORTED = UnsupportedHeader.NAME; //22
public static final String RETRY_AFTER = RetryAfterHeader.NAME; //23
public static final String CONTENT_TYPE = ContentTypeHeader.NAME; //24
public static final String CONTENT_ENCODING = ContentEncodingHeader.NAME;
//25
public static final String CONTENT_LENGTH = ContentLengthHeader.NAME; //26
public static final String ROUTE = RouteHeader.NAME; //27
public static final String CONTACT = ContactHeader.NAME; //28
public static final String WWW_AUTHENTICATE = WWWAuthenticateHeader.NAME;
//29
public static final String MAX_FORWARDS = MaxForwardsHeader.NAME; //30
public static final String ORGANIZATION = OrganizationHeader.NAME; //31
public static final String PROXY_AUTHORIZATION =
ProxyAuthorizationHeader.NAME;
//32
public static final String PROXY_REQUIRE = ProxyRequireHeader.NAME; //33
public static final String REQUIRE = RequireHeader.NAME; //34
public static final String CONTENT_DISPOSITION =
ContentDispositionHeader.NAME;
//35
public static final String SUBJECT = SubjectHeader.NAME; //36
public static final String USER_AGENT = UserAgentHeader.NAME; //37
public static final String WARNING = WarningHeader.NAME; //38
public static final String PRIORITY = PriorityHeader.NAME; //39
public static final String DATE = DateHeader.NAME; //40
public static final String EXPIRES = ExpiresHeader.NAME; //41
public static final String SUPPORTED = SupportedHeader.NAME; //42
public static final String AUTHENTICATION_INFO =
AuthenticationInfoHeader.NAME;
//43
public static final String REPLY_TO = ReplyToHeader.NAME; //44
public static final String RACK = RAckHeader.NAME; //45
public static final String RSEQ = RSeqHeader.NAME; //46
public static final String REASON = ReasonHeader.NAME; //47
public static final String SUBSCRIPTION_STATE =
SubscriptionStateHeader.NAME;
//48
public static final String EVENT = EventHeader.NAME; //44
public static final String ALLOW_EVENTS = AllowEventsHeader.NAME; //45
public static final String SIP_ETAG = SIPETagHeader.NAME; //46
public static final String SIP_IF_MATCH = SIPIfMatchHeader.NAME; //47
// NewHeights pmusgrave
public static final String REFERRED_BY = ReferredByHeader.NAME; //48
public static final String SESSION_EXPIRES = SessionExpiresHeader.NAME; //49
public static final String MIN_SE = MinSEHeader.NAME; //50
public static final String REPLACES = ReplacesHeader.NAME; //51
public static final String JOIN = JoinHeader.NAME; //52
}
java/gov/nist/javax/sip/header/SIPHeaderNamesCache.java 0100644 0000000 0000000 00000002217 13513104763 021756 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header;
import java.util.HashMap;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
/**
* @author yanick.belanger
*/
public abstract class SIPHeaderNamesCache
{
private static final HashMap lowercaseMap = new HashMap();
static {
Field[] fields = SIPHeaderNames.class.getFields();
for (int i = 0; i < fields.length; i++) {
Field field = fields[i];
if (field.getType().equals(String.class) && Modifier.isStatic(field.getModifiers())) {
try {
String value = (String) field.get(null);
String lowerCase = value.toLowerCase();
lowercaseMap.put(value, lowerCase);
lowercaseMap.put(lowerCase, lowerCase);
} catch (IllegalAccessException e) {
}
}
}
}
public static String toLowerCase(String headerName) {
String lowerCase = (String) lowercaseMap.get(headerName);
if (lowerCase == null) {
return headerName.toLowerCase();
}
else {
return lowerCase;
}
}
}
java/gov/nist/javax/sip/header/SIPIfMatch.java 0100644 0000000 0000000 00000005525 13513104763 020176 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.text.ParseException;
/**
* the SIP-If-Match header.
*
* @author Jeroen van Bemmel
* @version 1.2 $Revision: 1.3 $ $Date: 2009/07/17 18:57:38 $
* @since 1.2
*/
public class SIPIfMatch extends SIPHeader implements SIPIfMatchHeader,ExtensionHeader {
/**
* unique serial id
*/
private static final long serialVersionUID = 3833745477828359730L;
/**
* entity tag field
*/
protected String entityTag;
/** Default constructor
*/
public SIPIfMatch() {
super(NAME);
}
public SIPIfMatch(String etag) throws ParseException {
this();
this.setETag( etag );
}
/**
* Encode into canonical form.
* @return String
*/
public String encodeBody() {
return entityTag;
}
/**
* get the priority value.
* @return String
*/
public String getETag() {
return entityTag;
}
/**
* Set the priority member
* @param etag -- the entity tag to set.
*/
public void setETag(String etag) throws ParseException {
if (etag == null)
throw new NullPointerException(
"JAIN-SIP Exception,"
+ "SIP-If-Match, setETag(), the etag parameter is null");
this.entityTag = etag;
}
/**
* For v 1.1 backwards compatibility.
* @see javax.sip.header.ExtensionHeader#setValue(java.lang.String)
*/
public void setValue(String value) throws ParseException {
this.setETag(value);
}
}
java/gov/nist/javax/sip/header/SIPObject.java 0100644 0000000 0000000 00000040652 13513104763 020071 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*****************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*****************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.GenericObject;
import gov.nist.core.GenericObjectList;
import gov.nist.core.InternalErrorHandler;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
/**
* Root class for all singleton objects in this package:
* specializes the gov.nist.sip.header.GenericObject class for SIPHeader
* related objects.
*
* @version 1.2 $Revision: 1.10 $ $Date: 2009/07/17 18:57:38 $
*
* @author M. Ranganathan
*
*
*
*/
public abstract class SIPObject extends GenericObject {
/** default Constructor
*/
protected SIPObject() {
super();
}
/** Debug function
*/
public void dbgPrint() {
super.dbgPrint();
}
/** Encode the header into a String.
* @return String
*/
public abstract String encode();
/** Encode the header into the given StringBuffer.
* Default implemation calls encode().
*/
public StringBuffer encode(StringBuffer buffer) {
return buffer.append(encode());
}
/**
* An introspection based equality predicate for SIPObjects.
*@param other the other object to test against.
*/
public boolean equals(Object other) {
if (!this.getClass().equals(other.getClass()))
return false;
SIPObject that = (SIPObject) other;
Class myclass = this.getClass();
Class hisclass = other.getClass();
while (true) {
Field[] fields = myclass.getDeclaredFields();
if (!hisclass.equals(myclass))
return false;
Field[] hisfields = hisclass.getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
Field f = fields[i];
Field g = hisfields[i];
// Only print protected and public members.
int modifier = f.getModifiers();
if ((modifier & Modifier.PRIVATE) == Modifier.PRIVATE)
continue;
Class fieldType = f.getType();
String fieldName = f.getName();
if (fieldName.compareTo("stringRepresentation") == 0) {
continue;
}
if (fieldName.compareTo("indentation") == 0) {
continue;
}
try {
// Primitive fields are printed with type: value
if (fieldType.isPrimitive()) {
String fname = fieldType.toString();
if (fname.compareTo("int") == 0) {
if (f.getInt(this) != g.getInt(that))
return false;
} else if (fname.compareTo("short") == 0) {
if (f.getShort(this) != g.getShort(that))
return false;
} else if (fname.compareTo("char") == 0) {
if (f.getChar(this) != g.getChar(that))
return false;
} else if (fname.compareTo("long") == 0) {
if (f.getLong(this) != g.getLong(that))
return false;
} else if (fname.compareTo("boolean") == 0) {
if (f.getBoolean(this) != g.getBoolean(that))
return false;
} else if (fname.compareTo("double") == 0) {
if (f.getDouble(this) != g.getDouble(that))
return false;
} else if (fname.compareTo("float") == 0) {
if (f.getFloat(this) != g.getFloat(that))
return false;
}
} else if (g.get(that) == f.get(this))
continue;
else if (f.get(this) == null && g.get(that) != null)
return false;
else if (g.get(that) == null && f.get(this) != null)
return false;
else if (!f.get(this).equals(g.get(that)))
return false;
} catch (IllegalAccessException ex1) {
System.out.println("accessed field " + fieldName);
System.out.println("modifier " + modifier);
System.out.println("modifier.private " + Modifier.PRIVATE);
InternalErrorHandler.handleException(ex1);
}
}
if (myclass.equals(SIPObject.class))
break;
else {
myclass = myclass.getSuperclass();
hisclass = hisclass.getSuperclass();
}
}
return true;
}
/** An introspection based predicate matching using a template
* object. Allows for partial match of two protocl Objects.
* You can set a generalized matcher (using regular expressions
* for example) by implementing the Match interface and registering
* it with the template.
*@param other the match pattern to test against. The match object
* has to be of the same type (class). Primitive types
* and non-sip fields that are non null are matched for equality.
* Null in any field matches anything. Some book-keeping fields
* are ignored when making the comparison.
*
*/
public boolean match(Object other) {
if (other == null) {
return true;
}
if (!this.getClass().equals(other.getClass()))
return false;
GenericObject that = (GenericObject) other;
Class myclass = this.getClass();
Class hisclass = other.getClass();
while (true) {
Field[] fields = myclass.getDeclaredFields();
Field[] hisfields = hisclass.getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
Field f = fields[i];
Field g = hisfields[i];
// Only print protected and public members.
int modifier = f.getModifiers();
if ((modifier & Modifier.PRIVATE) == Modifier.PRIVATE)
continue;
Class fieldType = f.getType();
String fieldName = f.getName();
if (fieldName.compareTo("stringRepresentation") == 0) {
continue;
}
if (fieldName.compareTo("indentation") == 0) {
continue;
}
try {
if (fieldType.isPrimitive()) {
String fname = fieldType.toString();
if (fname.compareTo("int") == 0) {
if (f.getInt(this) != g.getInt(that))
return false;
} else if (fname.compareTo("short") == 0) {
if (f.getShort(this) != g.getShort(that))
return false;
} else if (fname.compareTo("char") == 0) {
if (f.getChar(this) != g.getChar(that))
return false;
} else if (fname.compareTo("long") == 0) {
if (f.getLong(this) != g.getLong(that))
return false;
} else if (fname.compareTo("boolean") == 0) {
if (f.getBoolean(this) != g.getBoolean(that))
return false;
} else if (fname.compareTo("double") == 0) {
if (f.getDouble(this) != g.getDouble(that))
return false;
} else if (fname.compareTo("float") == 0) {
if (f.getFloat(this) != g.getFloat(that))
return false;
} else {
InternalErrorHandler.handleException(
"unknown type");
}
} else {
Object myObj = f.get(this);
Object hisObj = g.get(that);
if (hisObj != null && myObj == null)
return false;
else if (hisObj == null && myObj != null)
continue;
else if (hisObj == null && myObj == null)
continue;
else if (
hisObj instanceof java.lang.String
&& myObj instanceof java.lang.String) {
if ((((String) hisObj).trim()).equals(""))
continue;
if (((String) myObj)
.compareToIgnoreCase((String) hisObj)
!= 0)
return false;
} else if (
hisObj != null
&& GenericObject.isMySubclass(myObj.getClass())
&& GenericObject.isMySubclass(hisObj.getClass())
&& myObj.getClass().equals(hisObj.getClass())
&& ((GenericObject) hisObj).getMatcher()
!= null) {
String myObjEncoded =
((GenericObject) myObj).encode();
boolean retval =
((GenericObject) hisObj).getMatcher().match(
myObjEncoded);
if (!retval)
return false;
} else if (
GenericObject.isMySubclass(myObj.getClass())
&& !((GenericObject) myObj).match(hisObj))
return false;
else if (
GenericObjectList.isMySubclass(myObj.getClass())
&& !((GenericObjectList) myObj).match(hisObj))
return false;
}
} catch (IllegalAccessException ex1) {
InternalErrorHandler.handleException(ex1);
}
}
if (myclass.equals(SIPObject.class))
break;
else {
myclass = myclass.getSuperclass();
hisclass = hisclass.getSuperclass();
}
}
return true;
}
/**
* An introspection based string formatting method. We need this because
* in this package (although it is an exact duplicate of the one in
* the superclass) because it needs to access the protected members
* of the other objects in this class.
* @return String
*/
public String debugDump() {
stringRepresentation = "";
Class myclass = getClass();
sprint(myclass.getName());
sprint("{");
Field[] fields = myclass.getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
Field f = fields[i];
// Only print protected and public members.
int modifier = f.getModifiers();
if ((modifier & Modifier.PRIVATE) == Modifier.PRIVATE)
continue;
Class fieldType = f.getType();
String fieldName = f.getName();
if (fieldName.compareTo("stringRepresentation") == 0) {
// avoid nasty recursions...
continue;
}
if (fieldName.compareTo("indentation") == 0) {
// formatting stuff - not relevant here.
continue;
}
sprint(fieldName + ":");
try {
// Primitive fields are printed with type: value
if (fieldType.isPrimitive()) {
String fname = fieldType.toString();
sprint(fname + ":");
if (fname.compareTo("int") == 0) {
int intfield = f.getInt(this);
sprint(intfield);
} else if (fname.compareTo("short") == 0) {
short shortField = f.getShort(this);
sprint(shortField);
} else if (fname.compareTo("char") == 0) {
char charField = f.getChar(this);
sprint(charField);
} else if (fname.compareTo("long") == 0) {
long longField = f.getLong(this);
sprint(longField);
} else if (fname.compareTo("boolean") == 0) {
boolean booleanField = f.getBoolean(this);
sprint(booleanField);
} else if (fname.compareTo("double") == 0) {
double doubleField = f.getDouble(this);
sprint(doubleField);
} else if (fname.compareTo("float") == 0) {
float floatField = f.getFloat(this);
sprint(floatField);
}
} else if (GenericObject.class.isAssignableFrom(fieldType)) {
if (f.get(this) != null) {
sprint(
((GenericObject) f.get(this)).debugDump(
indentation + 1));
} else {
sprint("");
}
} else if (
GenericObjectList.class.isAssignableFrom(fieldType)) {
if (f.get(this) != null) {
sprint(
((GenericObjectList) f.get(this)).debugDump(
indentation + 1));
} else {
sprint("");
}
} else {
// Dont do recursion on things that are not
// of our header type...
if (f.get(this) != null) {
sprint(f.get(this).getClass().getName() + ":");
} else {
sprint(fieldType.getName() + ":");
}
sprint("{");
if (f.get(this) != null) {
sprint(f.get(this).toString());
} else {
sprint("");
}
sprint("}");
}
} catch (IllegalAccessException ex1) {
continue; // we are accessing a private field...
}
}
sprint("}");
return stringRepresentation;
}
/**
* Formatter with a given starting indentation (for nested structs).
* @param indent int to set
* @return String
*/
public String debugDump(int indent) {
int save = indentation;
indentation = indent;
String retval = this.debugDump();
indentation = save;
return retval;
}
public String toString() {
return this.encode();
}
}
java/gov/nist/javax/sip/header/SIPObjectList.java 0100644 0000000 0000000 00000010374 13513104763 020723 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.ListIterator;
import java.util.LinkedList;
import java.util.Iterator;
import java.lang.reflect.*;
import gov.nist.core.*;
/**
* Root class for all the collection objects in this list:
* a wrapper class on the GenericObjectList class for lists of objects
* that can appear in SIPObjects.
* IMPORTANT NOTE: SIPObjectList cannot derive from SIPObject.
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:38 $
*
* @author M. Ranganathan
*
*
*/
public class SIPObjectList extends GenericObjectList {
private static final long serialVersionUID = -3015154738977508905L;
/**
* Construct a SIPObject List given a list name.
* @param lname String to set
*/
public SIPObjectList(String lname) {
super(lname);
}
/**
* Construct an empty SIPObjectList.
*/
public SIPObjectList() {
super();
}
/**
* Do a merge of the GenericObjects contained in this list with the
* GenericObjects in the mergeList. Note that this does an inplace
* modification of the given list. This does an object by object
* merge of the given objects.
*
*@param mergeList is the list of Generic objects that we want to do
* an object by object merge with. Note that no new objects are
* added to this list.
*
*/
public void mergeObjects(GenericObjectList mergeList) {
Iterator it1 = this.listIterator();
Iterator it2 = mergeList.listIterator();
while (it1.hasNext()) {
GenericObject outerObj = (GenericObject) it1.next();
while (it2.hasNext()) {
Object innerObj = it2.next();
outerObj.merge(innerObj);
}
}
}
/**
* Append a given list to the end of this list.
* @param otherList SIPObjectList to set
*/
public void concatenate(SIPObjectList otherList) {
super.concatenate(otherList);
}
/**
* Append or prepend a given list to this list.
* @param otherList SIPObjectList to set
* @param topFlag boolean to set
*/
public void concatenate(SIPObjectList otherList, boolean topFlag) {
super.concatenate(otherList, topFlag);
}
/**
* Get the first object of this list.
* @return GenericObject
*/
public GenericObject first() {
return (SIPObject) super.first();
}
/**
* Get the next object of this list (assumes that first() has been
* called prior to calling this method.)
* @return GenericObject
*/
public GenericObject next() {
return (SIPObject) super.next();
}
/**
* Convert to a string given an indentation(for pretty printing).
* This is useful for debugging the system in lieu of a debugger.
*
* @param indent int to set
* @return an indentation
*/
public String debugDump(int indent) {
return super.debugDump(indent);
}
}
java/gov/nist/javax/sip/header/Server.java 0100644 0000000 0000000 00000014131 13513104763 017546 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
import javax.sip.header.*;
import java.util.*;
/**
* Supported SIP Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:38 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class Server extends SIPHeader implements ServerHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3587764149383342973L;
/** Product tokens.
*/
protected List productTokens;
/**
* Return canonical form.
* @return String
*/
private String encodeProduct() {
StringBuffer tokens = new StringBuffer();
ListIterator it = productTokens.listIterator();
while (it.hasNext()) {
tokens.append((String) it.next());
if (it.hasNext())
tokens.append('/');
else
break;
}
return tokens.toString();
}
/** set the productToken field
* @param pt String to set
*/
public void addProductToken(String pt) {
productTokens.add(pt);
}
/**
* Constructor.
*/
public Server() {
super(NAME);
productTokens = new LinkedList();
}
/** Encode only the body of this header.
*@return encoded value of the header.
*/
public String encodeBody() {
return encodeProduct();
}
/**
* Returns the list value of the product parameter.
*
* @return the software of this UserAgentHeader
*/
public ListIterator getProduct() {
if (productTokens == null || productTokens.isEmpty())
return null;
else
return productTokens.listIterator();
}
/**
* Sets the product value of the UserAgentHeader.
*
* @param product - a List specifying the product value
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the product value.
*/
public void setProduct(List product) throws ParseException {
if (product == null)
throw new NullPointerException(
"JAIN-SIP Exception, UserAgent, "
+ "setProduct(), the "
+ " product parameter is null");
productTokens = product;
}
}
/*
* $Log: Server.java,v $
* Revision 1.5 2009/07/17 18:57:38 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:04 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:27 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/SipRequestLine.java 0100644 0000000 0000000 00000002265 13513104763 021221 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header;
import javax.sip.address.URI;
/**
* The SIP Request Line.
*
* @since 2.0
*/
public interface SipRequestLine {
/** get the Request-URI.
*
* @return the request URI
*/
public abstract URI getUri();
/**
* Get the Method
*
* @return method string.
*/
public abstract String getMethod();
/**
* Get the SIP version.
*
* @return String
*/
public abstract String getSipVersion();
/**
* Set the URI.
*
* @param uri URI to set.
*/
public abstract void setUri(URI uri);
/**
* Set the method member
*
* @param method String to set
*/
public abstract void setMethod(String method);
/**
* Set the sipVersion member
*
* @param s String to set
*/
public abstract void setSipVersion(String version);
/**
* Get the major verrsion number.
*
*@return String major version number
*/
public abstract String getVersionMajor();
/**
* Get the minor version number.
*
*@return String minor version number
*
*/
public abstract String getVersionMinor();
}
java/gov/nist/javax/sip/header/SipStatusLine.java 0100644 0000000 0000000 00000002244 13513104763 021051 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header;
/**
* The SIP Status line.
*
* @since 2.0
*/
public interface SipStatusLine {
/** get the Sip Version
* @return SipVersion
*/
public abstract String getSipVersion();
/** get the Status Code
* @return StatusCode
*/
public abstract int getStatusCode();
/** get the ReasonPhrase field
* @return ReasonPhrase field
*/
public abstract String getReasonPhrase();
/**
* Set the sipVersion member
* @param sipVersion String to set
*/
public abstract void setSipVersion(String sipVersion);
/**
* Set the statusCode member
* @param statusCode int to set
*/
public abstract void setStatusCode(int statusCode);
/**
* Set the reasonPhrase member
* @param reasonPhrase String to set
*/
public abstract void setReasonPhrase(String reasonPhrase);
/**
* Get the major version number.
*@return String major version number
*/
public abstract String getVersionMajor();
/**
* Get the minor version number.
*@return String minor version number
*/
public abstract String getVersionMinor();
}
java/gov/nist/javax/sip/header/StatusLine.java 0100644 0000000 0000000 00000022305 13513104763 020375 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.SIPConstants;
/**
* Status Line (for SIPReply) messages.
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/10/18 13:46:34 $
*
* @author M. Ranganathan
*
*
*/
public final class StatusLine extends SIPObject implements SipStatusLine {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -4738092215519950414L;
protected boolean matchStatusClass;
/** sipVersion field
*/
protected String sipVersion;
/** status code field
*/
protected int statusCode;
/** reasonPhrase field
*/
protected String reasonPhrase;
/** Match with a template.
* Match only the response class if the last two digits of the
* match templates are 0's
*/
public boolean match(Object matchObj) {
if (!(matchObj instanceof StatusLine))
return false;
StatusLine sl = (StatusLine) matchObj;
// A pattern matcher has been registered.
if (sl.matchExpression != null)
return sl.matchExpression.match(this.encode());
// no patter matcher has been registered..
if (sl.sipVersion != null && !sl.sipVersion.equals(sipVersion))
return false;
if (sl.statusCode != 0) {
if (matchStatusClass) {
int hiscode = sl.statusCode;
String codeString = Integer.toString(sl.statusCode);
String mycode = Integer.toString(statusCode);
if (codeString.charAt(0) != mycode.charAt(0))
return false;
} else {
if (statusCode != sl.statusCode)
return false;
}
}
if (sl.reasonPhrase == null || reasonPhrase == sl.reasonPhrase)
return true;
return reasonPhrase.equals(sl.reasonPhrase);
}
/** set the flag on a match template.
*If this set to true, then the whole status code is matched (default
* behavior) else only the class of the response is matched.
*/
public void setMatchStatusClass(boolean flag) {
matchStatusClass = flag;
}
/** Default Constructor
*/
public StatusLine() {
reasonPhrase = null;
sipVersion = SIPConstants.SIP_VERSION_STRING;
}
/**
* Encode into a canonical form.
* @return String
*/
public String encode() {
String encoding = SIPConstants.SIP_VERSION_STRING + SP + statusCode;
if (reasonPhrase != null)
encoding += SP + reasonPhrase;
encoding += NEWLINE;
return encoding;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#getSipVersion()
*/
public String getSipVersion() {
return sipVersion;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#getStatusCode()
*/
public int getStatusCode() {
return statusCode;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#getReasonPhrase()
*/
public String getReasonPhrase() {
return reasonPhrase;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#setSipVersion(java.lang.String)
*/
public void setSipVersion(String s) {
sipVersion = s;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#setStatusCode(int)
*/
public void setStatusCode(int statusCode) {
this.statusCode = statusCode;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#setReasonPhrase(java.lang.String)
*/
public void setReasonPhrase(String reasonPhrase) {
this.reasonPhrase = reasonPhrase;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#getVersionMajor()
*/
public String getVersionMajor() {
if (sipVersion == null)
return null;
String major = null;
boolean slash = false;
for (int i = 0; i < sipVersion.length(); i++) {
if (sipVersion.charAt(i) == '.')
slash = false;
if (slash) {
if (major == null)
major = "" + sipVersion.charAt(i);
else
major += sipVersion.charAt(i);
}
if (sipVersion.charAt(i) == '/')
slash = true;
}
return major;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.SipStatusLine#getVersionMinor()
*/
public String getVersionMinor() {
if (sipVersion == null)
return null;
String minor = null;
boolean dot = false;
for (int i = 0; i < sipVersion.length(); i++) {
if (dot) {
if (minor == null)
minor = "" + sipVersion.charAt(i);
else
minor += sipVersion.charAt(i);
}
if (sipVersion.charAt(i) == '.')
dot = true;
}
return minor;
}
}
/*
* $Log: StatusLine.java,v $
* Revision 1.7 2009/10/18 13:46:34 deruelle_jean
* FindBugs Fixes (Category Performance Warnings)
*
* Issue number:
* Obtained from:
* Submitted by: Jean Deruelle
* Reviewed by:
*
* Revision 1.6 2009/09/15 02:55:26 mranga
* Issue number: 222
* Add HeaderFactoryExt.createStatusLine(String) and HeaderFactoryExt.createRequestLine(String)
* Allows users to easily parse SipFrag bodies (for example NOTIFY bodies
* during call transfer).
*
* Revision 1.5 2009/07/17 18:57:38 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:48 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:27 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/Subject.java 0100644 0000000 0000000 00000012572 13513104763 017706 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
import javax.sip.header.*;
/**
* Supported SIP Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:39 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class Subject extends SIPHeader implements SubjectHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6479220126758862528L;
/** subject field
*/
protected String subject;
/** Default Constructor.
*/
public Subject() {
super(SUBJECT);
}
/**
* Generate the canonical form.
* @return String.
*/
public String encodeBody() {
if (subject != null) {
return subject;
} else {
return "";
}
}
/**
* Sets the subject value of the SubjectHeader to the supplied string
* subject value.
*
* @param subject - the new subject value of this header
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the subject value.
*/
public void setSubject(String subject) throws ParseException {
if (subject == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " Subject, setSubject(), the subject parameter is null");
this.subject = subject;
}
/**
* Gets the subject value of SubjectHeader
*
* @return subject of SubjectHeader
*/
public String getSubject() {
return subject;
}
}
/*
* $Log: Subject.java,v $
* Revision 1.5 2009/07/17 18:57:39 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:21 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:27 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/SubscriptionState.java 0100644 0000000 0000000 00000014403 13513104763 021767 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.InvalidArgumentException;
import javax.sip.header.SubscriptionStateHeader;
import java.text.ParseException;
/**
*SubscriptionState header
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:39 $
*
* @author Olivier Deruelle
*
*
*/
public class SubscriptionState
extends ParametersHeader
implements SubscriptionStateHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6673833053927258745L;
protected int expires;
protected int retryAfter;
protected String reasonCode;
protected String state;
/** Creates a new instance of SubscriptionState */
public SubscriptionState() {
super(SIPHeaderNames.SUBSCRIPTION_STATE);
expires = -1;
retryAfter = -1;
}
/**
* Sets the relative expires value of the SubscriptionStateHeader. The
* expires value MUST be greater than zero and MUST be less than 2**31.
*
* @param expires - the new expires value of this SubscriptionStateHeader.
* @throws InvalidArgumentException if supplied value is less than zero.
*/
public void setExpires(int expires) throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException(
"JAIN-SIP "
+ "Exception, SubscriptionState, setExpires(), the expires parameter is < 0");
this.expires = expires;
}
/**
* Gets the expires value of the SubscriptionStateHeader. This expires value is
* relative time.
*
* @return the expires value of the SubscriptionStateHeader.
*/
public int getExpires() {
return expires;
}
/**
* Sets the retry after value of the SubscriptionStateHeader. The retry after value
* MUST be greater than zero and MUST be less than 2**31.
*
* @param retryAfter - the new retry after value of this SubscriptionStateHeader
* @throws InvalidArgumentException if supplied value is less than zero.
*/
public void setRetryAfter(int retryAfter) throws InvalidArgumentException {
if (retryAfter <= 0)
throw new InvalidArgumentException(
"JAIN-SIP "
+ "Exception, SubscriptionState, setRetryAfter(), the retryAfter parameter is <=0");
this.retryAfter = retryAfter;
}
/**
* Gets the retry after value of the SubscriptionStateHeader. This retry after
* value is relative time.
*
* @return the retry after value of the SubscriptionStateHeader.
*/
public int getRetryAfter() {
return retryAfter;
}
/**
* Gets the reason code of SubscriptionStateHeader.
*
* @return the comment of this SubscriptionStateHeader, return null if no reason code
* is available.
*/
public String getReasonCode() {
return reasonCode;
}
/**
* Sets the reason code value of the SubscriptionStateHeader.
*
* @param reasonCode - the new reason code string value of the SubscriptionStateHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the reason code.
*/
public void setReasonCode(String reasonCode) throws ParseException {
if (reasonCode == null)
throw new NullPointerException(
"JAIN-SIP "
+ "Exception, SubscriptionState, setReasonCode(), the reasonCode parameter is null");
this.reasonCode = reasonCode;
}
/**
* Gets the state of SubscriptionStateHeader.
*
* @return the state of this SubscriptionStateHeader.
*/
public String getState() {
return state;
}
/**
* Sets the state value of the SubscriptionStateHeader.
*
* @param state - the new state string value of the SubscriptionStateHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the state.
*/
public void setState(String state) throws ParseException {
if (state == null)
throw new NullPointerException(
"JAIN-SIP "
+ "Exception, SubscriptionState, setState(), the state parameter is null");
this.state = state;
}
/** Just the encoded body of the header.
* @return the string encoded header body.
*/
public String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (state != null)
buffer.append(state);
if (reasonCode != null)
buffer.append(";reason=").append(reasonCode);
if (expires != -1)
buffer.append(";expires=").append(expires);
if (retryAfter != -1)
buffer.append(";retry-after=").append(retryAfter);
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
return buffer;
}
}
java/gov/nist/javax/sip/header/Supported.java 0100644 0000000 0000000 00000013663 13513104763 020276 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
import javax.sip.header.*;
/**
* Supported SIP Header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:39 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class Supported extends SIPHeader implements SupportedHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -7679667592702854542L;
/* the Option field
*/
protected String optionTag;
/**
* default constructor
*/
public Supported() {
super(SIPHeaderNames.SUPPORTED);
optionTag = null;
}
/**
* Constructor
* @param option_tag String to set
*/
public Supported(String option_tag) {
super(SIPHeaderNames.SUPPORTED);
optionTag = option_tag;
}
/**
* Return canonical form of the header.
* @return encoded header.
*/
public String encode() {
String retval = headerName + COLON;
if (optionTag != null)
retval += SP + optionTag;
retval += NEWLINE;
return retval;
}
/**
* Just the encoded body of the header.
* @return the string encoded header body.
*/
public String encodeBody() {
return optionTag != null ? optionTag : "";
}
/**
* Sets the option tag value to the new supplied optionTag
* parameter.
*
* @param optionTag - the new string value of the option tag.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the optionTag value.
*/
public void setOptionTag(String optionTag) throws ParseException {
if (optionTag == null)
throw new NullPointerException(
"JAIN-SIP Exception, Supported, "
+ "setOptionTag(), the optionTag parameter is null");
this.optionTag = optionTag;
}
/**
* Gets the option tag of this OptionTag class.
*
* @return the string that identifies the option tag value.
*/
public String getOptionTag() {
return optionTag;
}
}
/*
* $Log: Supported.java,v $
* Revision 1.5 2009/07/17 18:57:39 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:27 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:27 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:30 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/SupportedList.java 0100644 0000000 0000000 00000003602 13513104763 021122 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* A list of supported headers.
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:39 $
* @see Supported
*/
public class SupportedList extends SIPHeaderList{
/**
*
*/
private static final long serialVersionUID = -4539299544895602367L;
public Object clone() {
SupportedList retval = new SupportedList();
retval.clonehlist(this.hlist);
return retval;
}
/** Default Constructor
*/
public SupportedList() {
super(Supported.class, SupportedHeader.NAME);
}
}
java/gov/nist/javax/sip/header/TimeStamp.java 0100644 0000000 0000000 00000012556 13513104763 020214 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.InvalidArgumentException;
import javax.sip.header.*;
/**
* TimeStamp SIP Header.
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/10/18 13:46:31 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public class TimeStamp extends SIPHeader implements TimeStampHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3711322366481232720L;
/**
* timeStamp field
*/
protected long timeStamp = -1;
/**
* delay field
*/
protected int delay = -1;
protected float delayFloat = -1;
private float timeStampFloat = -1;
/**
* Default Constructor
*/
public TimeStamp() {
super(TIMESTAMP);
delay = -1;
}
private String getTimeStampAsString() {
if (timeStamp == -1 && timeStampFloat == -1)
return "";
else if (timeStamp != -1)
return Long.toString(timeStamp);
else
return Float.toString(timeStampFloat);
}
private String getDelayAsString() {
if (delay == -1 && delayFloat == -1)
return "";
else if (delay != -1)
return Integer.toString(delay);
else
return Float.toString(delayFloat);
}
/**
* Return canonical form of the header.
*
* @return String
*/
public String encodeBody() {
StringBuffer retval = new StringBuffer();
String s1 = getTimeStampAsString();
String s2 = getDelayAsString();
if (s1.equals("") && s2.equals(""))
return "";
if (!s1.equals(""))
retval.append(s1);
if (!s2.equals(""))
retval.append(" ").append(s2);
return retval.toString();
}
/**
* return true if delay exists
*
* @return boolean
*/
public boolean hasDelay() {
return delay != -1;
}
/*
* remove the Delay field
*/
public void removeDelay() {
delay = -1;
}
public void setTimeStamp(float timeStamp) throws InvalidArgumentException {
if (timeStamp < 0)
throw new InvalidArgumentException(
"JAIN-SIP Exception, TimeStamp, "
+ "setTimeStamp(), the timeStamp parameter is <0");
this.timeStamp = -1;
this.timeStampFloat = timeStamp;
}
public float getTimeStamp() {
return this.timeStampFloat == -1 ? Float.valueOf(timeStamp).floatValue()
: this.timeStampFloat;
}
public float getDelay() {
return delayFloat == -1 ? Float.valueOf(delay).floatValue() : delayFloat;
}
/**
* Sets the new delay value of the TimestampHeader to the delay paramter
* passed to this method
*
* @param delay -
* the Float.valueOf delay value
* @throws InvalidArgumentException
* if the delay value argumenmt is a negative value other than
* -1.
*/
public void setDelay(float delay) throws InvalidArgumentException {
if (delay < 0 && delay != -1)
throw new InvalidArgumentException(
"JAIN-SIP Exception, TimeStamp, "
+ "setDelay(), the delay parameter is <0");
this.delayFloat = delay;
this.delay = -1;
}
public long getTime() {
return this.timeStamp == -1 ? (long) timeStampFloat : timeStamp;
}
public int getTimeDelay() {
return this.delay == -1 ? (int) delayFloat : delay;
}
public void setTime(long timeStamp) throws InvalidArgumentException {
if (timeStamp < -1)
throw new InvalidArgumentException("Illegal timestamp");
this.timeStamp = timeStamp;
this.timeStampFloat = -1;
}
public void setTimeDelay(int delay) throws InvalidArgumentException {
if (delay < -1)
throw new InvalidArgumentException("Value out of range " + delay);
this.delay = delay;
this.delayFloat = -1;
}
}
java/gov/nist/javax/sip/header/To.java 0100644 0000000 0000000 00000011746 13513104763 016673 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.HostPort;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.parser.Parser;
import javax.sip.header.ToHeader;
import java.text.ParseException;
/**
* To SIP Header.
*
* @version 1.2 $Revision: 1.11 $ $Date: 2009/07/17 18:57:39 $
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*
*
*/
public final class To extends AddressParametersHeader implements
javax.sip.header.ToHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -4057413800584586316L;
/**
* default Constructor.
*/
public To() {
super(TO,true);
}
/**
* Generate a TO header from a FROM header
*/
public To(From from) {
super(TO);
setAddress(from.address);
setParameters(from.parameters);
}
/**
* Encode the header into a String.
*
* @since 1.0
* @return String
*/
public String encode() {
return headerName + COLON + SP + encodeBody() + NEWLINE;
}
/**
* Encode the header content into a String.
*
* @return String
*/
protected String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
if (address != null) {
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
buffer.append(LESS_THAN);
}
address.encode(buffer);
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
buffer.append(GREATER_THAN);
}
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
}
return buffer;
}
/**
* Conveniance accessor function to get the hostPort field from the address.
* Warning -- this assumes that the embedded URI is a SipURL.
*
* @return hostport field
*/
public HostPort getHostPort() {
if (address == null)
return null;
return address.getHostPort();
}
/**
* Get the display name from the address.
*
* @return Display name
*/
public String getDisplayName() {
if (address == null)
return null;
return address.getDisplayName();
}
/**
* Get the tag parameter from the address parm list.
*
* @return tag field
*/
public String getTag() {
if (parameters == null)
return null;
return getParameter(ParameterNames.TAG);
}
/**
* Boolean function
*
* @return true if the Tag exist
*/
public boolean hasTag() {
if (parameters == null)
return false;
return hasParameter(ParameterNames.TAG);
}
/**
* remove Tag member
*/
public void removeTag() {
if (parameters != null)
parameters.delete(ParameterNames.TAG);
}
/**
* Set the tag member. This should remain empty for the initial request in
* a dialog.
*
* @param t - tag String to set.
*/
public void setTag(String t) throws ParseException {
// JvB: check that it is a valid token
Parser.checkToken(t);
this.setParameter(ParameterNames.TAG, t);
}
/**
* Get the user@host port string.
*/
public String getUserAtHostPort() {
if (address == null)
return null;
return address.getUserAtHostPort();
}
public boolean equals(Object other) {
return (other instanceof ToHeader) && super.equals(other);
}
}
java/gov/nist/javax/sip/header/Unsupported.java 0100644 0000000 0000000 00000012215 13513104763 020631 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.text.ParseException;
/**
* the Unsupported header.
*
* @version 1.2 $Revision: 1.5 $ $Date: 2009/07/17 18:57:40 $
* @author Olivier Deruelle
*
*
*
*/
public class Unsupported
extends SIPHeader
implements javax.sip.header.UnsupportedHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -2479414149440236199L;
/** option-Tag field.
*/
protected String optionTag;
/** Default Constructor.
*/
public Unsupported() {
super(NAME);
}
/** Constructor
* @param ot String to set
*/
public Unsupported(String ot) {
super(NAME);
optionTag = ot;
}
/**
* Return a canonical value.
* @return String.
*/
public String encodeBody() {
return optionTag;
}
/** get the option tag field
* @return option Tag field
*/
public String getOptionTag() {
return optionTag;
}
/**
* Set the option member
* @param o String to set
*/
public void setOptionTag(String o) throws ParseException {
if (o == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " Unsupported, setOptionTag(), The option tag parameter is null");
optionTag = o;
}
}
/*
* $Log: Unsupported.java,v $
* Revision 1.5 2009/07/17 18:57:40 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.4 2006/07/13 09:01:34 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:27 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.2 2004/01/22 13:26:30 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/UnsupportedList.java 0100644 0000000 0000000 00000003620 13513104763 021465 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.Iterator;
import javax.sip.header.*;
/**
* List of Unsupported headers.
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:40 $
* @author M. Ranganathan
*/
public class UnsupportedList extends SIPHeaderList {
private static final long serialVersionUID = -4052610269407058661L;
/** Default Constructor
*/
public UnsupportedList() {
super(Unsupported.class, UnsupportedHeader.NAME);
}
public Object clone() {
UnsupportedList retval = new UnsupportedList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/UserAgent.java 0100644 0000000 0000000 00000015323 13513104763 020201 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import java.util.*;
import java.text.ParseException;
import javax.sip.header.*;
/**
* the UserAgent SIPObject.
*
* @author Olivier Deruelle
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:40 $
*
*
*
*/
public class UserAgent extends SIPHeader implements UserAgentHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 4561239179796364295L;
/** Product tokens.
*/
protected List productTokens;
/**
* Return canonical form.
* pmusgrave - put a space between products (preserves format of header)
* @return String
*/
private String encodeProduct() {
StringBuffer tokens = new StringBuffer();
ListIterator it = productTokens.listIterator();
while (it.hasNext()) {
tokens.append((String) it.next());
}
return tokens.toString();
}
/** set the productToken field
* @param pt String to set
*/
public void addProductToken(String pt) {
productTokens.add(pt);
}
/**
* Constructor.
*/
public UserAgent() {
super(NAME);
productTokens = new LinkedList();
}
/** Encode only the body of this header.
*@return encoded value of the header.
*/
public String encodeBody() {
return encodeProduct();
}
/**
* Returns the list value of the product parameter.
*
* @return the software of this UserAgentHeader
*/
public ListIterator getProduct() {
if (productTokens == null || productTokens.isEmpty())
return null;
else
return productTokens.listIterator();
}
/**
* Sets the product value of the UserAgentHeader.
*
* @param product - a List specifying the product value
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the product value.
*/
public void setProduct(List product) throws ParseException {
if (product == null)
throw new NullPointerException(
"JAIN-SIP Exception, UserAgent, "
+ "setProduct(), the "
+ " product parameter is null");
productTokens = product;
}
public Object clone() {
UserAgent retval = (UserAgent) super.clone();
if (productTokens != null)
retval.productTokens = new LinkedList (productTokens);
return retval;
}
}
/*
* $Log: UserAgent.java,v $
* Revision 1.8 2009/07/17 18:57:40 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.7 2008/07/30 14:36:06 mranga
* Issue number:
* Obtained from:
* Submitted by: mranga
* Reviewed by: mranga
* Fix minor issue in encoding of user-agent header.
*
* Revision 1.6 2006/10/12 11:57:55 pmusgrave
* Issue number: 79, 80
* Submitted by: pmusgrave@newheights.com
* Reviewed by: mranga
*
* Revision 1.5 2006/07/13 09:01:48 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:27 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.3 2005/04/16 20:38:51 dmuresan
* Canonical clone() implementations for the GenericObject and GenericObjectList hierarchies
*
* Revision 1.2 2004/01/22 13:26:30 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/Via.java 0100644 0000000 0000000 00000040104 13513104763 017016 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.core.Host;
import gov.nist.core.HostPort;
import gov.nist.core.NameValue;
import gov.nist.core.NameValueList;
import gov.nist.javax.sip.stack.HopImpl;
import javax.sip.InvalidArgumentException;
import javax.sip.address.Hop;
import javax.sip.header.ViaHeader;
import java.text.ParseException;
/**
* Via SIPHeader (these are strung together in a ViaList).
*
* @see ViaList
*
* @version 1.2 $Revision: 1.17 $ $Date: 2009/10/18 13:46:33 $
*
* @author M. Ranganathan
*
*
*
*/
public class Via
extends ParametersHeader
implements javax.sip.header.ViaHeader, ViaHeaderExt {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 5281728373401351378L;
/** The branch parameter is included by every forking proxy.
*/
public static final String BRANCH = ParameterNames.BRANCH;
/** The "received" parameter is added only for receiver-added Via Fields.
*/
public static final String RECEIVED = ParameterNames.RECEIVED;
/** The "maddr" paramter is designating the multicast address.
*/
public static final String MADDR = ParameterNames.MADDR;
/** The "TTL" parameter is designating the time-to-live value.
*/
public static final String TTL = ParameterNames.TTL;
/** The RPORT parameter.
*/
public static final String RPORT = ParameterNames.RPORT;
/** sentProtocol field.
*/
protected Protocol sentProtocol;
/** sentBy field.
*/
protected HostPort sentBy;
/**
* comment field
*
* JvB note: RFC3261 does not allow a comment to appear in Via headers, and this
* is not accessible through the API. Suggest removal
*/
protected String comment;
private boolean rPortFlag = false;
/** Default constructor
*/
public Via() {
super(NAME);
sentProtocol = new Protocol();
}
public boolean equals(Object other) {
if (other==this) return true;
if (other instanceof ViaHeader) {
final ViaHeader o = (ViaHeader) other;
return getProtocol().equalsIgnoreCase( o.getProtocol() )
&& getTransport().equalsIgnoreCase( o.getTransport() )
&& getHost().equalsIgnoreCase( o.getHost() )
&& getPort() == o.getPort()
&& equalParameters( o );
}
return false;
}
/** get the Protocol Version
* @return String
*/
public String getProtocolVersion() {
if (sentProtocol == null)
return null;
else
return sentProtocol.getProtocolVersion();
}
/**
* Accessor for the sentProtocol field.
* @return Protocol field
*/
public Protocol getSentProtocol() {
return sentProtocol;
}
/**
* Accessor for the sentBy field
*@return SentBy field
*/
public HostPort getSentBy() {
return sentBy;
}
/**
* Get the host, port and transport as a Hop. This is
* useful for the stack to avoid duplication of code.
*
*/
public Hop getHop() {
HopImpl hop = new HopImpl(sentBy.getHost().getHostname(),
sentBy.getPort(),sentProtocol.getTransport());
return hop;
}
/**
* Accessor for the parameters field
* @return parameters field
*/
public NameValueList getViaParms() {
return parameters;
}
/**
* Accessor for the comment field.
* @return comment field.
* @deprecated RFC 2543 support feature.
*/
public String getComment() {
return comment;
}
/** port of the Via Header.
* @return true if Port exists.
*/
public boolean hasPort() {
return (getSentBy()).hasPort();
}
/** comment of the Via Header.
*
* @return false if comment does not exist and true otherwise.
*/
public boolean hasComment() {
return comment != null;
}
/** remove the port.
*/
public void removePort() {
sentBy.removePort();
}
/** remove the comment field.
*/
public void removeComment() {
comment = null;
}
/** set the Protocol Version
* @param protocolVersion String to set
*/
public void setProtocolVersion(String protocolVersion) {
if (sentProtocol == null)
sentProtocol = new Protocol();
sentProtocol.setProtocolVersion(protocolVersion);
}
/** set the Host of the Via Header
* @param host String to set
*/
public void setHost(Host host) {
if (sentBy == null) {
sentBy = new HostPort();
}
sentBy.setHost(host);
}
/**
* Set the sentProtocol member
* @param s Protocol to set.
*/
public void setSentProtocol(Protocol s) {
sentProtocol = s;
}
/**
* Set the sentBy member
* @param s HostPort to set.
*/
public void setSentBy(HostPort s) {
sentBy = s;
}
/**
* Set the comment member
* @param c String to set.
* @deprecated This is an RFC 2543 feature.
*/
public void setComment(String c) {
comment = c;
}
/** Encode the body of this header (the stuff that follows headerName).
* A.K.A headerValue.
*/
protected String encodeBody() {
return encodeBody(new StringBuffer()).toString();
}
protected StringBuffer encodeBody(StringBuffer buffer) {
sentProtocol.encode(buffer);
buffer.append(SP);
sentBy.encode(buffer);
if (!parameters.isEmpty()) {
buffer.append(SEMICOLON);
parameters.encode(buffer);
}
if (comment != null) {
buffer.append(SP).append(LPAREN).append(comment).append(RPAREN);
}
if (rPortFlag) buffer.append(";rport");
return buffer;
}
/**
* Set the host part of this ViaHeader to the newly supplied host
* parameter.
*
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the host value.
*/
public void setHost(String host) throws ParseException {
if (sentBy == null)
sentBy = new HostPort();
try {
Host h = new Host(host);
sentBy.setHost(h);
} catch (Exception e) {
throw new NullPointerException(" host parameter is null");
}
}
/**
* Returns the host part of this ViaHeader.
*
* @return the string value of the host
*/
public String getHost() {
if (sentBy == null)
return null;
else {
Host host = sentBy.getHost();
if (host == null)
return null;
else
return host.getHostname();
}
}
/**
* Set the port part of this ViaHeader to the newly supplied port
* parameter.
*
* @param port - the Integer.valueOf value of the port of this ViaHeader
*/
public void setPort(int port) throws InvalidArgumentException {
if ( port!=-1 && (port<1 || port>65535)) {
throw new InvalidArgumentException( "Port value out of range -1, [1..65535]" );
}
if (sentBy == null)
sentBy = new HostPort();
sentBy.setPort(port);
}
/**
* Set the RPort flag parameter
*/
public void setRPort(){
rPortFlag = true;
}
/**
* Returns the port part of this ViaHeader.
*
* @return the integer value of the port
*/
public int getPort() {
if (sentBy == null)
return -1;
return sentBy.getPort();
}
/**
* Return the rport parameter.
*
*@return the rport parameter or -1.
*/
public int getRPort() {
String strRport = getParameter(ParameterNames.RPORT);
if (strRport != null && ! strRport.equals(""))
return Integer.valueOf(strRport).intValue();
else
return -1;
}
/**
* Returns the value of the transport parameter.
*
* @return the string value of the transport paramter of the ViaHeader
*/
public String getTransport() {
if (sentProtocol == null)
return null;
return sentProtocol.getTransport();
}
/**
* Sets the value of the transport. This parameter specifies
* which transport protocol to use for sending requests and responses to
* this entity. The following values are defined: "udp", "tcp", "sctp",
* "tls", but other values may be used also.
*
* @param transport - new value for the transport parameter
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the transport value.
*/
public void setTransport(String transport) throws ParseException {
if (transport == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "Via, setTransport(), the transport parameter is null.");
if (sentProtocol == null)
sentProtocol = new Protocol();
sentProtocol.setTransport(transport);
}
/**
* Returns the value of the protocol used.
*
* @return the string value of the protocol paramter of the ViaHeader
*/
public String getProtocol() {
if (sentProtocol == null)
return null;
return sentProtocol.getProtocol();// JvB: Return name ~and~ version
}
/**
* Sets the value of the protocol parameter. This parameter specifies
* which protocol is used, for example "SIP/2.0".
*
* @param protocol - new value for the protocol parameter
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the protocol value.
*/
public void setProtocol(String protocol) throws ParseException {
if (protocol == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "Via, setProtocol(), the protocol parameter is null.");
if (sentProtocol == null)
sentProtocol = new Protocol();
sentProtocol.setProtocol(protocol);
}
/**
* Returns the value of the ttl parameter, or -1 if this is not set.
*
* @return the integer value of the ttl parameter
*/
public int getTTL() {
int ttl = getParameterAsInt(ParameterNames.TTL);
return ttl;
}
/**
* Sets the value of the ttl parameter. The ttl parameter specifies the
* time-to-live value when packets are sent using UDP multicast.
*
* @param ttl - new value of the ttl parameter
* @throws InvalidArgumentException if supplied value is less than zero or
* greater than 255, excluding -1 the default not set value.
*/
public void setTTL(int ttl) throws InvalidArgumentException {
if (ttl < 0 && ttl != -1)
throw new InvalidArgumentException(
"JAIN-SIP Exception"
+ ", Via, setTTL(), the ttl parameter is < 0");
setParameter(new NameValue(ParameterNames.TTL, Integer.valueOf(ttl)));
}
/**
* Returns the value of the maddr parameter, or null if this
* is not set.
*
* @return the string value of the maddr parameter
*/
public String getMAddr() {
return getParameter(ParameterNames.MADDR);
}
/**
* Sets the value of the maddr parameter of this ViaHeader. The
* maddr parameter indicates the server address to be contacted for this
* user, overriding any address derived from the host field.
*
* @param mAddr new value of the maddr parameter
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the mAddr value.
*/
public void setMAddr(String mAddr) throws ParseException {
if (mAddr == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "Via, setMAddr(), the mAddr parameter is null.");
Host host = new Host();
host.setAddress(mAddr);
NameValue nameValue = new NameValue(ParameterNames.MADDR, host);
setParameter(nameValue);
}
/**
* Gets the received paramater of the ViaHeader. Returns null if received
* does not exist.
*
* @return the string received value of ViaHeader
*/
public String getReceived() {
return getParameter(ParameterNames.RECEIVED);
}
/**
* Sets the received parameter of ViaHeader.
*
* @param received - the newly supplied received parameter.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the received value.
*/
public void setReceived(String received) throws ParseException {
if (received == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "Via, setReceived(), the received parameter is null.");
setParameter(ParameterNames.RECEIVED, received);
}
/**
* Gets the branch paramater of the ViaHeader. Returns null if branch
* does not exist.
*
* @return the string branch value of ViaHeader
*/
public String getBranch() {
return getParameter(ParameterNames.BRANCH);
}
/**
* Sets the branch parameter of the ViaHeader to the newly supplied
* branch value.
*
* @param branch - the new string branch parmameter of the ViaHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the branch value.
*/
public void setBranch(String branch) throws ParseException {
if (branch == null || branch.length()==0)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "Via, setBranch(), the branch parameter is null or length 0.");
setParameter(ParameterNames.BRANCH, branch);
}
public Object clone() {
Via retval = (Via) super.clone();
if (this.sentProtocol != null)
retval.sentProtocol = (Protocol) this.sentProtocol.clone();
if (this.sentBy != null)
retval.sentBy = (HostPort) this.sentBy.clone();
if ( this.getRPort() != -1)
retval.setParameter(RPORT,this.getRPort());
return retval;
}
/*
* (non-Javadoc)
* @see gov.nist.javax.sip.header.ViaHeaderExt#getSentByField()
*/
public String getSentByField() {
if(sentBy != null)
return sentBy.encode();
return null;
}
/*
* (non-Javadoc)
* @see gov.nist.javax.sip.header.ViaHeaderExt#getSentProtocolField()
*/
public String getSentProtocolField() {
if(sentProtocol != null)
return sentProtocol.encode();
return null;
}
}
java/gov/nist/javax/sip/header/ViaHeaderExt.java 0100644 0000000 0000000 00000001120 13513104763 020603 0 ustar 00 0000000 0000000 /*
* This code has been contributed by the authors to the public domain.
*/
package gov.nist.javax.sip.header;
import javax.sip.header.ViaHeader;
/**
* @author jean.deruelle@gmail.com
*
*/
public interface ViaHeaderExt extends ViaHeader {
/**
* Returns hostname:port as a string equivalent to the "sent-by" field
* @return "sent-by" field
* @since 2.0
*/
public String getSentByField();
/**
* Returns transport to the "sent-protocol" field
* @return "sent-protocol" field
* @since 2.0
*/
public String getSentProtocolField();
}
java/gov/nist/javax/sip/header/ViaList.java 0100644 0000000 0000000 00000003625 13513104763 017661 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.util.Iterator;
/**
* Keeps a list and a hashtable of via header functions.
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:41 $
*
* @author M. Ranganathan
*
*
*
*/
public final class ViaList extends SIPHeaderList {
private static final long serialVersionUID = 3899679374556152313L;
public Object clone() {
ViaList retval = new ViaList();
return retval.clonehlist(this.hlist);
}
/**
* Default Constructor.
*/
public ViaList() {
super(Via.class, ViaHeader.NAME);
}
}
java/gov/nist/javax/sip/header/WWWAuthenticate.java 0100644 0000000 0000000 00000005131 13513104763 021323 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import gov.nist.javax.sip.header.ims.WWWAuthenticateHeaderIms;
import javax.sip.address.URI;
import javax.sip.header.*;
/**
* The WWWAuthenticate SIP header.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:41 $
*
*
*
* @see WWWAuthenticateList SIPHeader which strings these together.
*/
public class WWWAuthenticate
extends AuthenticationHeader
implements WWWAuthenticateHeader, WWWAuthenticateHeaderIms {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 115378648697363486L;
/**
* Default Constructor.
*/
public WWWAuthenticate() {
super(NAME);
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AuthenticationHeader#getURI()
*
* @since 1.2 this method is deprecated, uri is not a valid paramter for this header
* Fail silently for backwards compatibility
*/
public URI getURI() {
return null;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.AuthenticationHeader#setURI(javax.sip.address.URI)
*
* @since 1.2 this method is deprecated, uri is not a valid paramter for this header
* Fail silently for backwards compatibility
*/
public void setURI(URI uri) {
// empty, fail silently
}
}
java/gov/nist/javax/sip/header/WWWAuthenticateList.java 0100644 0000000 0000000 00000003704 13513104763 022163 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* WWWAuthenticate SIPHeader (of which there can be several?)
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:41 $
*
* @author M. Ranganathan
*
*
*
*/
public class WWWAuthenticateList extends SIPHeaderList {
private static final long serialVersionUID = -6978902284285501346L;
public Object clone() {
WWWAuthenticateList retval = new WWWAuthenticateList();
return retval.clonehlist(this.hlist);
}
/**
* constructor.
*/
public WWWAuthenticateList() {
super(WWWAuthenticate.class, WWWAuthenticateHeader.NAME);
}
}
java/gov/nist/javax/sip/header/Warning.java 0100644 0000000 0000000 00000016267 13513104763 017721 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
/**
* the WarningValue SIPObject.
*
* @author M. Ranganathan
* @author Olivier Deruelle
* @version 1.2 $Revision: 1.8 $ $Date: 2009/10/18 13:46:33 $
*
*
*
* @see WarningList SIPHeader which strings these together.
*/
public class Warning extends SIPHeader implements WarningHeader {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -3433328864230783899L;
/** warn code field, the warn code consists of three digits.
*/
protected int code;
/** the name or pseudonym of the server adding
* the Warning header, for use in debugging
*/
protected String agent;
/** warn-text field
*/
protected String text;
/**
* constructor.
*/
public Warning() {
super(WARNING);
}
/** Encode the body of the header (return the stuff following name:).
*@return the string encoding of the header value.
*/
public String encodeBody() {
return text != null
? Integer.toString(code)
+ SP
+ agent
+ SP
+ DOUBLE_QUOTE
+ text
+ DOUBLE_QUOTE
: Integer.toString(code) + SP + agent;
}
/**
* Gets code of WarningHeader
* @return code of WarningHeader
*/
public int getCode() {
return code;
}
/**
* Gets agent host of WarningHeader
* @return agent host of WarningHeader
*/
public String getAgent() {
return agent;
}
/**
* Gets text of WarningHeader
* @return text of WarningHeader
*/
public String getText() {
return text;
}
/**
* Sets code of WarningHeader
* @param code int to set
* @throws SipParseException if code is not accepted by implementation
*/
public void setCode(int code) throws InvalidArgumentException {
if (code >99 && code < 1000) { // check this is a 3DIGIT code
this.code = code;
} else
throw new InvalidArgumentException(
"Code parameter in the Warning header is invalid: code="
+ code);
}
/**
* Sets host of WarningHeader
* @param host String to set
* @throws ParseException if host is not accepted by implementation
*/
public void setAgent(String host) throws ParseException {
if (host == null)
throw new NullPointerException("the host parameter in the Warning header is null");
else {
this.agent = host;
}
}
/**
* Sets text of WarningHeader
* @param text String to set
* @throws ParseException if text is not accepted by implementation
*/
public void setText(String text) throws ParseException {
if (text == null) {
throw new ParseException(
"The text parameter in the Warning header is null",
0);
} else
this.text = text;
}
}
/*
* $Log: Warning.java,v $
* Revision 1.8 2009/10/18 13:46:33 deruelle_jean
* FindBugs Fixes (Category Performance Warnings)
*
* Issue number:
* Obtained from:
* Submitted by: Jean Deruelle
* Reviewed by:
*
* Revision 1.7 2009/07/17 18:57:41 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.6 2006/07/13 09:01:44 mranga
* Issue number:
* Obtained from:
* Submitted by: jeroen van bemmel
* Reviewed by: mranga
* Moved some changes from jain-sip-1.2 to java.net
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.3 2006/06/19 06:47:27 mranga
* javadoc fixups
*
* Revision 1.2 2006/06/16 15:26:28 mranga
* Added NIST disclaimer to all public domain files. Clean up some javadoc. Fixed a leak
*
* Revision 1.1.1.1 2005/10/04 17:12:35 mranga
*
* Import
*
*
* Revision 1.4 2004/04/22 22:51:16 mranga
* Submitted by: Thomas Froment
* Reviewed by: mranga
*
* Fixed corner cases.
*
* Revision 1.2 2004/01/22 13:26:30 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/WarningList.java 0100644 0000000 0000000 00000003645 13513104763 020551 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header;
import javax.sip.header.*;
/**
* A list of Warning headers.
*
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:41 $
*
* @author M. Ranganathan
*
*
*
*/
public class WarningList extends SIPHeaderList {
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -1423278728898430175L;
public Object clone() {
WarningList retval = new WarningList();
return retval.clonehlist(this.hlist);
}
/**
* Constructor.
*/
public WarningList() {
super(Warning.class, Warning.NAME);
}
}
java/gov/nist/javax/sip/header/extensions/ 0040755 0000000 0000000 00000000000 13513104763 017637 5 ustar 00 0000000 0000000 java/gov/nist/javax/sip/header/extensions/Join.java 0100644 0000000 0000000 00000011462 13513104763 021402 0 ustar 00 0000000 0000000 /*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header.extensions;
import java.text.ParseException;
import gov.nist.javax.sip.header.*;
import javax.sip.header.ExtensionHeader;
/*
* This code is in the public domain.
*/
/**
* Join SIPHeader.
*
* @author jean.deruelle@gmail.com
*
* @version JAIN-SIP-1.2
*
*
*/
public class Join
extends ParametersHeader implements ExtensionHeader, JoinHeader {
/**
*
*/
private static final long serialVersionUID = -840116548918120056L;
public static final String NAME = "Join";
/**
* callIdentifier field
*/
public CallIdentifier callIdentifier;
public String callId;
/**
* Default constructor
*/
public Join() {
super(NAME);
}
/** Constructor given the call Identifier.
*@param callId string call identifier (should be localid@host)
*@throws IllegalArgumentException if call identifier is bad.
*/
public Join(String callId) throws IllegalArgumentException {
super(NAME);
this.callIdentifier = new CallIdentifier(callId);
}
/**
* Encode the body part of this header (i.e. leave out the hdrName).
* @return String encoded body part of the header.
*/
public String encodeBody() {
if (callId == null)
return null;
else {
String retVal = callId;
if (!parameters.isEmpty()) {
retVal += SEMICOLON + parameters.encode();
}
return retVal;
}
}
/**
* get the CallId field. This does the same thing as encodeBody
*
* @return String the encoded body part of the
*/
public String getCallId() {
return callId;
}
/**
* get the call Identifer member.
* @return CallIdentifier
*/
public CallIdentifier getCallIdentifer() {
return callIdentifier;
}
/**
* set the CallId field
* @param cid String to set. This is the body part of the Call-Id
* header. It must have the form localId@host or localId.
* @throws IllegalArgumentException if cid is null, not a token, or is
* not a token@token.
*/
public void setCallId(String cid) {
callId = cid;
}
/**
* Set the callIdentifier member.
* @param cid CallIdentifier to set (localId@host).
*/
public void setCallIdentifier(CallIdentifier cid) {
callIdentifier = cid;
}
/**
* Get the to-tag parameter from the address parm list.
* @return tag field
*/
public String getToTag() {
if (parameters == null)
return null;
return getParameter(ParameterNames.TO_TAG);
}
/**
* Set the to-tag member
* @param t tag to set. From tags are mandatory.
*/
public void setToTag(String t) throws ParseException {
if (t == null)
throw new NullPointerException("null tag ");
else if (t.trim().equals(""))
throw new ParseException("bad tag", 0);
this.setParameter(ParameterNames.TO_TAG, t);
}
/** Boolean function
* @return true if the Tag exist
*/
public boolean hasToTag() {
return hasParameter(ParameterNames.TO_TAG);
}
/** remove Tag member
*/
public void removeToTag() {
parameters.delete(ParameterNames.TO_TAG);
}
/**
* Get the from-tag parameter from the address parm list.
* @return tag field
*/
public String getFromTag() {
if (parameters == null)
return null;
return getParameter(ParameterNames.FROM_TAG);
}
/**
* Set the to-tag member
* @param t tag to set. From tags are mandatory.
*/
public void setFromTag(String t) throws ParseException {
if (t == null)
throw new NullPointerException("null tag ");
else if (t.trim().equals(""))
throw new ParseException("bad tag", 0);
this.setParameter(ParameterNames.FROM_TAG, t);
}
/** Boolean function
* @return true if the Tag exist
*/
public boolean hasFromTag() {
return hasParameter(ParameterNames.FROM_TAG);
}
/** remove Tag member
*/
public void removeFromTag() {
parameters.delete(ParameterNames.FROM_TAG);
}
public void setValue(String value) throws ParseException {
// not implemented.
throw new ParseException(value,0);
}
// public Object clone() {
// CallID retval = (CallID) super.clone();
// if (this.callIdentifier != null)
// retval.setCallIdentifier( (CallIdentifier) this.callIdentifier.clone() );
// return retval;
// }
}
java/gov/nist/javax/sip/header/extensions/JoinHeader.java 0100644 0000000 0000000 00000014770 13513104763 022520 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.header.extensions;
import java.text.ParseException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* The From header field indicates the logical identity of the initiator
* of the request, possibly the user's address-of-record. This may be different
* from the initiator of the dialog. Requests sent by the callee to the caller
* use the callee's address in the From header field.
*
* Like the To header field, it contains a URI and optionally a display name,
* encapsulated in a {@link javax.sip.address.Address}. It is used by SIP
* elements to determine which processing rules to apply to a request (for
* example, automatic call rejection). As such, it is very important that the
* From URI not contain IP addresses or the FQDN of the host on which the UA is
* running, since these are not logical names.
*
* The From header field allows for a display name. A UAC SHOULD use
* the display name "Anonymous", along with a syntactically correct, but
* otherwise meaningless URI (like sip:thisis@anonymous.invalid), if the
* identity of the client is to remain hidden.
*
* Usually, the value that populates the From header field in requests
* generated by a particular UA is pre-provisioned by the user or by the
* administrators of the user's local domain. If a particular UA is used by
* multiple users, it might have switchable profiles that include a URI
* corresponding to the identity of the profiled user. Recipients of requests
* can authenticate the originator of a request in order to ascertain that
* they are who their From header field claims they are.
*
* Two From header fields are equivalent if their URIs match, and their
* parameters match. Extension parameters in one header field, not present in
* the other are ignored for the purposes of comparison. This means that the
* display name and presence or absence of angle brackets do not affect
* matching.
*
* - The "Tag" parameter - is used in the To and From header fields of SIP
* messages. It serves as a general mechanism to identify a dialog, which is
* the combination of the Call-ID along with two tags, one from each
* participant in the dialog. When a User Agent sends a request outside of a dialog,
* it contains a From tag only, providing "half" of the dialog ID. The dialog
* is completed from the response(s), each of which contributes the second half
* in the To header field. When a tag is generated by a User Agent for insertion into
* a request or response, it MUST be globally unique and cryptographically
* random with at least 32 bits of randomness. Besides the requirement for
* global uniqueness, the algorithm for generating a tag is implementation
* specific. Tags are helpful in fault tolerant systems, where a dialog is to
* be recovered on an alternate server after a failure. A UAS can select the
* tag in such a way that a backup can recognize a request as part of a dialog
* on the failed server, and therefore determine that it should attempt to
* recover the dialog and any other state associated with it.
*
* For Example:
* From: "Bob" sips:bob@biloxi.com ;tag=a48s
* From: sip:+12125551212@phone2net.com;tag=887s
* From: Anonymous sip:c8oqz84zk7z@privacy.org;tag=hyh8
*
* @version 1.1
* @author jean.deruelle@gmail.com
*/
public interface JoinHeader extends Parameters, Header {
/**
* Sets the tag parameter of the FromHeader. The tag in the From field of a
* request identifies the peer of the dialog. When a UA sends a request
* outside of a dialog, it contains a From tag only, providing "half" of
* the dialog Identifier.
*
* The From Header MUST contain a new "tag" parameter, chosen by the UAC
* applicaton. Once the initial From "tag" is assigned it should not be
* manipulated by the application. That is on the client side for outbound
* requests the application is responsible for Tag assigmennment, after
* dialog establishment the stack will take care of Tag assignment.
*
* @param tag - the new tag of the FromHeader
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the Tag value.
*/
public void setToTag(String tag) throws ParseException;
public void setFromTag(String tag) throws ParseException;
/**
* Gets the tag of FromHeader. The Tag parameter identified the Peer of the
* dialogue and must always be present.
*
* @return the tag parameter of the FromHeader.
*/
public String getToTag();
public String getFromTag();
/**
* Sets the Call-Id of the CallIdHeader. The CallId parameter uniquely
* identifies a serious of messages within a dialogue.
*
* @param callId - the string value of the Call-Id of this CallIdHeader.
* @throws ParseException which signals that an error has been reached
* unexpectedly while parsing the callId value.
*/
public void setCallId(String callId) throws ParseException;
/**
* Returns the Call-Id of CallIdHeader. The CallId parameter uniquely
* identifies a series of messages within a dialogue.
*
* @return the String value of the Call-Id of this CallIdHeader
*/
public String getCallId();
/**
* Name of JoinHeader
*/
public final static String NAME = "Join";
}
java/gov/nist/javax/sip/header/extensions/MinSE.java 0100644 0000000 0000000 00000004766 13513104763 021467 0 ustar 00 0000000 0000000 /*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
/*
* This code has been contributed by the author to the public domain.
*/
package gov.nist.javax.sip.header.extensions;
import java.text.ParseException;
import gov.nist.javax.sip.header.*;
import javax.sip.*;
import javax.sip.header.ExtensionHeader;
/**
* MinSE SIP Header.
*
* (Created by modifying Expires.java)
*
* @version JAIN-SIP-1.1 $Revision: 1.4 $ $Date: 2009/10/18 13:46:36 $
*
* @author P. Musgrave
*
*/
public class MinSE
extends ParametersHeader implements ExtensionHeader, MinSEHeader {
// TODO: When the MinSEHeader is added to javax - move this there...pmusgrave
public static final String NAME = "Min-SE";
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = 3134344915465784267L;
/** expires field
*/
public int expires;
/** default constructor
*/
public MinSE() {
super(NAME);
}
/**
* Return canonical form.
* @return String
*/
public String encodeBody() {
String retval = Integer.toString(expires); // seems overkill - but Expires did this.
if (!parameters.isEmpty()) {
retval += SEMICOLON + parameters.encode();
}
return retval;
}
public void setValue(String value) throws ParseException {
// not implemented.
throw new ParseException(value,0);
}
/**
* Gets the expires value of the ExpiresHeader. This expires value is
*
* relative time.
*
*
*
* @return the expires value of the ExpiresHeader.
*
* @since JAIN SIP v1.1
*
*/
public int getExpires() {
return expires;
}
/**
* Sets the relative expires value of the ExpiresHeader.
* The expires value MUST be greater than zero and MUST be
* less than 2**31.
*
* @param expires - the new expires value of this ExpiresHeader
*
* @throws InvalidArgumentException if supplied value is less than zero.
*
* @since JAIN SIP v1.2
*
*/
public void setExpires(int expires) throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException("bad argument " + expires);
this.expires = expires;
}
}
java/gov/nist/javax/sip/header/extensions/MinSEHeader.java 0100644 0000000 0000000 00000000344 13513104763 022564 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.extensions;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
public interface MinSEHeader extends Parameters, Header {
public final static String NAME = "Min-SE";
}
java/gov/nist/javax/sip/header/extensions/References.java 0100644 0000000 0000000 00000003273 13513104763 022565 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.extensions;
import gov.nist.javax.sip.header.ParametersHeader;
import java.text.ParseException;
import java.util.Iterator;
import javax.sip.header.ExtensionHeader;
public class References extends ParametersHeader implements ReferencesHeader,ExtensionHeader {
private static final long serialVersionUID = 8536961681006637622L;
private String callId;
public References() {
super(ReferencesHeader.NAME);
}
public String getCallId() {
return callId;
}
public String getRel() {
return this.getParameter(REL);
}
public void setCallId(String callId) {
this.callId = callId;
}
public void setRel(String rel) throws ParseException{
if ( rel != null ) {
this.setParameter(REL,rel);
}
}
public String getParameter(String name) {
return super.getParameter(name);
}
public Iterator getParameterNames() {
return super.getParameterNames();
}
public void removeParameter(String name) {
super.removeParameter(name);
}
public void setParameter(String name, String value) throws ParseException {
super.setParameter(name,value);
}
public String getName() {
return ReferencesHeader.NAME;
}
protected String encodeBody() {
if ( super.parameters.isEmpty()) {
return callId ;
} else {
return callId + ";" + super.parameters.encode();
}
}
public void setValue(String value) throws ParseException {
throw new UnsupportedOperationException("operation not supported");
}
}
java/gov/nist/javax/sip/header/extensions/ReferencesHeader.java 0100644 0000000 0000000 00000001677 13513104763 023704 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.extensions;
import java.text.ParseException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* References header: See http://tools.ietf.org/html/draft-worley-references-05
*/
public interface ReferencesHeader extends Parameters, Header {
public static final String NAME = "References";
public static final String CHAIN = "chain";
public static final String INQUIRY = "inquiry";
public static final String REFER = "refer" ;
public static final String SEQUEL = "sequel";
public static final String XFER = "xfer";
public static final String REL = "rel";
public static final String SERVICE = "service";
public void setCallId(String callId) throws ParseException;
public String getCallId();
public void setRel (String rel) throws ParseException;
public String getRel();
}
java/gov/nist/javax/sip/header/extensions/ReferredBy.java 0100644 0000000 0000000 00000010451 13513104763 022531 0 ustar 00 0000000 0000000
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header.extensions;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.header.*;
import gov.nist.javax.sip.address.*;
/*
* This code has been contributed by the author to the public domain.
*/
/**
* ReferredBy SIP Header. RFC 3892
*
* @version JAIN-SIP-1.2
*
* @author Peter Musgrave.
*
*
*/
public final class ReferredBy
extends AddressParametersHeader implements ExtensionHeader, ReferredByHeader {
// TODO: Need a unique UID
private static final long serialVersionUID = 3134344915465784267L;
// TODO: When the MinSEHeader is added to javax - move this there...pmusgrave
public static final String NAME = "Referred-By";
/** default Constructor.
*/
public ReferredBy() {
super(NAME);
}
public void setValue(String value) throws ParseException {
// not implemented.
throw new ParseException(value,0);
}
/**
* Encode the header content into a String.
* @return String
*/
protected String encodeBody() {
if (address == null)
return null;
String retval = "";
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval += LESS_THAN;
}
retval += address.encode();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval += GREATER_THAN;
}
if (!parameters.isEmpty()) {
retval += SEMICOLON + parameters.encode();
}
return retval;
}
}
/*
* $Log: ReferredBy.java,v $
* Revision 1.3 2009/07/17 18:57:42 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.2 2006/10/27 20:58:31 mranga
* Issue number:
* Obtained from:
* Submitted by:
* Reviewed by: mranga
* doc fixups
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.1 2006/10/12 11:57:52 pmusgrave
* Issue number: 79, 80
* Submitted by: pmusgrave@newheights.com
* Reviewed by: mranga
*
* Revision 1.2 2006/03/20 20:52:03 pmusgrave
* Add RefferedBy to header factory
* Correct implements statement in ReferredBy
*
* Revision 1.1.1.1 2006/03/15 16:00:07 pmusgrave
* Source with additions
*
* Revision 1.3 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/extensions/ReferredByHeader.java 0100644 0000000 0000000 00000001572 13513104763 023646 0 ustar 00 0000000 0000000 /*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package gov.nist.javax.sip.header.extensions;
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
public interface ReferredByHeader extends Header, HeaderAddress, Parameters {
String NAME = "Referred-By";
}
java/gov/nist/javax/sip/header/extensions/Replaces.java 0100644 0000000 0000000 00000017317 13513104763 022246 0 ustar 00 0000000 0000000 /*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header.extensions;
import java.text.ParseException;
import gov.nist.javax.sip.header.*;
import javax.sip.header.ExtensionHeader;
/*
* This code is in the public domain.
*/
/**
* Replaces SIPHeader.
* ToDo: add support for early-only flag.
*
* @author P, Musgrave
*
* @version JAIN-SIP-1.2
*
*
*/
public class Replaces
extends ParametersHeader implements ExtensionHeader, ReplacesHeader {
// TODO: Need a unique UID
private static final long serialVersionUID = 8765762413224043300L;
// TODO: When the MinSEHeader is added to javax - move this there...pmusgrave
public static final String NAME = "Replaces";
/**
* callIdentifier field
*/
public CallIdentifier callIdentifier;
public String callId;
/**
* Default constructor
*/
public Replaces() {
super(NAME);
}
/** Constructor given the call Identifier.
*@param callId string call identifier (should be localid@host)
*@throws IllegalArgumentException if call identifier is bad.
*/
public Replaces(String callId) throws IllegalArgumentException {
super(NAME);
this.callIdentifier = new CallIdentifier(callId);
}
/**
* Encode the body part of this header (i.e. leave out the hdrName).
* @return String encoded body part of the header.
*/
public String encodeBody() {
if (callId == null)
return null;
else {
String retVal = callId;
if (!parameters.isEmpty()) {
retVal += SEMICOLON + parameters.encode();
}
return retVal;
}
}
/**
* get the CallId field. This does the same thing as encodeBody
*
* @return String the encoded body part of the
*/
public String getCallId() {
return callId;
}
/**
* get the call Identifer member.
* @return CallIdentifier
*/
public CallIdentifier getCallIdentifer() {
return callIdentifier;
}
/**
* set the CallId field
* @param cid String to set. This is the body part of the Call-Id
* header. It must have the form localId@host or localId.
* @throws IllegalArgumentException if cid is null, not a token, or is
* not a token@token.
*/
public void setCallId(String cid) {
callId = cid;
}
/**
* Set the callIdentifier member.
* @param cid CallIdentifier to set (localId@host).
*/
public void setCallIdentifier(CallIdentifier cid) {
callIdentifier = cid;
}
/**
* Get the to-tag parameter from the address parm list.
* @return tag field
*/
public String getToTag() {
if (parameters == null)
return null;
return getParameter(ParameterNames.TO_TAG);
}
/**
* Set the to-tag member
* @param t tag to set. From tags are mandatory.
*/
public void setToTag(String t) throws ParseException {
if (t == null)
throw new NullPointerException("null tag ");
else if (t.trim().equals(""))
throw new ParseException("bad tag", 0);
this.setParameter(ParameterNames.TO_TAG, t);
}
/** Boolean function
* @return true if the Tag exist
*/
public boolean hasToTag() {
return hasParameter(ParameterNames.TO_TAG);
}
/** remove Tag member
*/
public void removeToTag() {
parameters.delete(ParameterNames.TO_TAG);
}
/**
* Get the from-tag parameter from the address parm list.
* @return tag field
*/
public String getFromTag() {
if (parameters == null)
return null;
return getParameter(ParameterNames.FROM_TAG);
}
/**
* Set the to-tag member
* @param t tag to set. From tags are mandatory.
*/
public void setFromTag(String t) throws ParseException {
if (t == null)
throw new NullPointerException("null tag ");
else if (t.trim().equals(""))
throw new ParseException("bad tag", 0);
this.setParameter(ParameterNames.FROM_TAG, t);
}
/** Boolean function
* @return true if the Tag exist
*/
public boolean hasFromTag() {
return hasParameter(ParameterNames.FROM_TAG);
}
/** remove Tag member
*/
public void removeFromTag() {
parameters.delete(ParameterNames.FROM_TAG);
}
public void setValue(String value) throws ParseException {
// not implemented.
throw new ParseException(value,0);
}
// public Object clone() {
// CallID retval = (CallID) super.clone();
// if (this.callIdentifier != null)
// retval.setCallIdentifier( (CallIdentifier) this.callIdentifier.clone() );
// return retval;
// }
}
/*
* $Log: Replaces.java,v $
* Revision 1.3 2009/07/17 18:57:42 emcho
* Converts indentation tabs to spaces so that we have a uniform indentation policy in the whole project.
*
* Revision 1.2 2006/10/27 20:58:31 mranga
* Issue number:
* Obtained from:
* Submitted by:
* Reviewed by: mranga
* doc fixups
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
* Revision 1.1 2006/10/12 11:57:51 pmusgrave
* Issue number: 79, 80
* Submitted by: pmusgrave@newheights.com
* Reviewed by: mranga
*
* Revision 1.3 2006/07/19 15:05:20 pmusgrave
* Modify encodeBody so it uses callId and not CallIdentifier
*
* Revision 1.2 2006/04/17 23:41:31 pmusgrave
* Add Session Timer and Replaces headers
*
* Revision 1.1.1.1 2006/03/15 16:00:07 pmusgrave
* Source with additions
*
* Revision 1.3 2005/04/16 20:38:48 dmuresan
* Canonical clone() implementations for the GenericObject and GenericObjectList hierarchies
*
* Revision 1.2 2004/01/22 13:26:29 sverker
* Issue number:
* Obtained from:
* Submitted by: sverker
* Reviewed by: mranga
*
* Major reformat of code to conform with style guide. Resolved compiler and javadoc warnings. Added CVS tags.
*
* CVS: ----------------------------------------------------------------------
* CVS: Issue number:
* CVS: If this change addresses one or more issues,
* CVS: then enter the issue number(s) here.
* CVS: Obtained from:
* CVS: If this change has been taken from another system,
* CVS: then name the system in this line, otherwise delete it.
* CVS: Submitted by:
* CVS: If this code has been contributed to the project by someone else; i.e.,
* CVS: they sent us a patch or a set of diffs, then include their name/email
* CVS: address here. If this is your work then delete this line.
* CVS: Reviewed by:
* CVS: If we are doing pre-commit code reviews and someone else has
* CVS: reviewed your changes, include their name(s) here.
* CVS: If you have not had it reviewed then delete this line.
*
*/
java/gov/nist/javax/sip/header/extensions/ReplacesHeader.java 0100644 0000000 0000000 00000002114 13513104763 023344 0 ustar 00 0000000 0000000 /*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package gov.nist.javax.sip.header.extensions;
import java.text.ParseException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
public interface ReplacesHeader extends Header, Parameters {
String NAME = "Replaces";
String getToTag();
void setToTag(String tag) throws ParseException;
String getFromTag();
void setFromTag(String tag) throws ParseException;
String getCallId();
void setCallId(String callId) throws ParseException;
} java/gov/nist/javax/sip/header/extensions/SessionExpires.java 0100644 0000000 0000000 00000005132 13513104763 023463 0 ustar 00 0000000 0000000
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.header.extensions;
import gov.nist.javax.sip.header.ParametersHeader;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import javax.sip.header.ExtensionHeader;
/**
* ReferredBy SIP Header.
*
* @version JAIN-SIP-1.1 $Revision: 1.5 $ $Date: 2009/10/18 13:46:36 $
*
* @author Peter Musgrave.
*
*/
public final class SessionExpires
extends ParametersHeader implements ExtensionHeader, SessionExpiresHeader {
// TODO: Need a unique UID
private static final long serialVersionUID = 8765762413224043300L;
// TODO: When the MinSEHeader is added to javax - move this there...pmusgrave
public static final String NAME = "Session-Expires";
public int expires;
public static final String REFRESHER = "refresher";
/** default Constructor.
*/
public SessionExpires() {
super(NAME);
}
/**
* Gets the expires value of the SessionExpiresHeader. This expires value is
* relative time.
*
*
*
* @return the expires value of the ExpiresHeader.
*
* @since JAIN SIP v1.1
*
*/
public int getExpires() {
return expires;
}
/**
* Sets the relative expires value of the SessionExpiresHeader.
* The expires value MUST be greater than zero and MUST be
* less than 2**31.
*
* @param expires - the new expires value
*
* @throws InvalidArgumentException if supplied value is less than zero.
*
* @since JAIN SIP v1.1
*
*/
public void setExpires(int expires) throws InvalidArgumentException {
if (expires < 0)
throw new InvalidArgumentException("bad argument " + expires);
this.expires = expires;
}
public void setValue(String value) throws ParseException {
// not implemented.
throw new ParseException(value,0);
}
/**
* Encode the header content into a String.
* @return String
*/
protected String encodeBody() {
String retval = Integer.toString(expires);
if (!parameters.isEmpty()) {
retval += SEMICOLON + parameters.encode();
}
return retval;
}
public String getRefresher() {
return parameters.getParameter(REFRESHER);
}
public void setRefresher(String refresher) {
this.parameters.set(REFRESHER,refresher);
}
}
java/gov/nist/javax/sip/header/extensions/SessionExpiresHeader.java 0100644 0000000 0000000 00000000773 13513104763 024602 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.extensions;
import javax.sip.InvalidArgumentException;
import javax.sip.header.*;
/*
* Extension for SessionTimer RFC 4028
*
*
*/
public interface SessionExpiresHeader extends Parameters, Header, ExtensionHeader{
public final static String NAME = "Session-Expires";
public int getExpires();
public void setExpires(int expires) throws InvalidArgumentException;
public String getRefresher() ;
public void setRefresher(String refresher);
}
java/gov/nist/javax/sip/header/ims/ 0040755 0000000 0000000 00000000000 13513104763 016230 5 ustar 00 0000000 0000000 java/gov/nist/javax/sip/header/ims/AddressHeaderIms.java 0100644 0000000 0000000 00000004533 13513104763 022244 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.address.Address;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.header.SIPHeader;
/**
* AddressHeader base class.
* @author ALEXANDRE MIGUEL SILVA SANTOS (PT Innovacau)
*/
public abstract class AddressHeaderIms extends SIPHeader {
protected AddressImpl address;
/**
* get the Address field
* @return the imbedded Address
*/
public Address getAddress() {
return address;
}
/**
* set the Address field
* @param address Address to set
*/
public void setAddress(Address address) {
this.address = (AddressImpl) address;
}
public abstract String encodeBody();
//protected abstract String encodeBody();
/**
* Constructor given the name of the header.
*/
public AddressHeaderIms(String name) {
//protected AddressHeader(String name) {
super(name);
}
public Object clone() {
AddressHeaderIms retval = (AddressHeaderIms) super.clone();
if (this.address != null)
retval.address = (AddressImpl) this.address.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ims/AuthorizationHeaderIms.java 0100644 0000000 0000000 00000004071 13513104763 023514 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import javax.sip.header.AuthorizationHeader;
/**
*
* Extension to Authorization header (3GPP TS 24299-5d0)
*
* This extension defines a new auth-param for the Authorization header used
* in REGISTER requests.
* For more information, see RFC 2617 [21] subclause 3.2.2.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS
*/
public interface AuthorizationHeaderIms extends AuthorizationHeader
{
// issued by Miguel Freitas (IT) PT-Inovacao
public static final String YES = "yes";
public static final String NO = "no";
/**
* @param integrityProtected
* @throws ParseException
*/
public void setIntegrityProtected(String integrityProtected) throws InvalidArgumentException, ParseException;
public String getIntegrityProtected();
}
java/gov/nist/javax/sip/header/ims/PAccessNetworkInfo.java 0100644 0000000 0000000 00000020171 13513104763 022600 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University - Portugal) *
*****************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ContactHeader;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.header.ParametersHeader;
/**
* P-Access-Network-Info SIP Private Header
*
* @author Miguel Freitas (IT) PT-Inovacao
*
* @since 1.2
*/
public class PAccessNetworkInfo
extends ParametersHeader
implements PAccessNetworkInfoHeader, ExtensionHeader {
// TODO: serialVersionUID
private String accessType;
private Object extendAccessInfo;
/**
* Public constructor.
*/
public PAccessNetworkInfo() {
super(PAccessNetworkInfoHeader.NAME);
parameters.setSeparator(SEMICOLON);
}
/**
* Constructor.
*/
public PAccessNetworkInfo(String accessTypeVal) {
this();
setAccessType(accessTypeVal);
}
/**
* Set the accessTpe
*
* @param accessTypeVal - access type
* @throws NullPointerException
*/
public void setAccessType(String accessTypeVal) {
if (accessTypeVal == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Access-Network-Info, setAccessType(), the accessType parameter is null.");
this.accessType = accessTypeVal;
}
/**
* @return String access type
*/
public String getAccessType() {
return accessType;
}
/**
*
* @param cgi -- String CGI value
* @throws NullPointerException -- if null argument passed in
* @throws ParseException -- if bad argument passed in.
*/
public void setCGI3GPP(String cgi) throws ParseException {
if (cgi == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Access-Network-Info, setCGI3GPP(), the cgi parameter is null.");
setParameter(ParameterNamesIms.CGI_3GPP, cgi);
}
/**
*
* @return String CGI value
*/
public String getCGI3GPP() {
return getParameter(ParameterNamesIms.CGI_3GPP);
}
/**
* Set the UtranCellID field.
*
* @param utranCellID -- String UTRAN Cell ID value
* @throws NullPointerException
* @throws ParseException
*/
public void setUtranCellID3GPP(String utranCellID) throws ParseException {
if (utranCellID == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Access-Network-Info, setUtranCellID3GPP(), the utranCellID parameter is null.");
setParameter(ParameterNamesIms.UTRAN_CELL_ID_3GPP, utranCellID);
}
/**
*
* @return String UTRAN Cell ID value
*/
public String getUtranCellID3GPP() {
return getParameter(ParameterNamesIms.UTRAN_CELL_ID_3GPP);
}
/**
*
* @param dslLocation - String with the DSL location value
* @throws NullPointerException
* @throws ParseException
*/
public void setDSLLocation(String dslLocation) throws ParseException {
if (dslLocation == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Access-Network-Info, setDSLLocation(), the dslLocation parameter is null.");
setParameter(ParameterNamesIms.DSL_LOCATION, dslLocation);
}
/**
*
* @return String DSL location value
*/
public String getDSLLocation() {
return getParameter(ParameterNamesIms.DSL_LOCATION);
}
/**
*
* @param ci3Gpp2 -- String CI 3GPP2 value
* @throws NullPointerException -- if arg is null
* @throws ParseException -- if arg is bad.
*/
public void setCI3GPP2(String ci3Gpp2) throws ParseException {
if (ci3Gpp2 == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Access-Network-Info, setCI3GPP2(), the ci3Gpp2 parameter is null.");
setParameter(ParameterNamesIms.CI_3GPP2, ci3Gpp2);
}
/**
*
* @return String CI 3GPP2 value
*/
public String getCI3GPP2() {
return getParameter(ParameterNamesIms.CI_3GPP2);
}
/**
*
* @param name --
* parameter name
* @param value --
* value of parameter
*/
public void setParameter(String name, Object value) {
/**
* @todo ParametersHeader needs to be fix!? missing "throws
* ParseException" in setParameter(String, Object)
*/
if (name.equalsIgnoreCase(ParameterNamesIms.CGI_3GPP)
|| name.equalsIgnoreCase(ParameterNamesIms.UTRAN_CELL_ID_3GPP)
|| name.equalsIgnoreCase(ParameterNamesIms.DSL_LOCATION)
|| name.equalsIgnoreCase(ParameterNamesIms.CI_3GPP2)) {
try {
super.setQuotedParameter(name, value.toString());
} catch (ParseException e) {
}
} else {
// value can be token either than a quoted-string
super.setParameter(name, value);
}
}
/**
* extension-access-info = gen-value gen-value = token / host /
* quoted-string
*
* @param extendAccessInfo - extended Access Information
*/
public void setExtensionAccessInfo(Object extendAccessInfo)
throws ParseException {
if (extendAccessInfo == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Access-Network-Info, setExtendAccessInfo(), the extendAccessInfo parameter is null.");
// or -> setParameter("", extendAccessInfo);
this.extendAccessInfo = extendAccessInfo;
}
public Object getExtensionAccessInfo() {
return this.extendAccessInfo;
}
protected String encodeBody() {
StringBuffer encoding = new StringBuffer();
if (getAccessType() != null)
encoding.append(getAccessType());
if (!parameters.isEmpty()) {
encoding.append(SEMICOLON + SP + this.parameters.encode());
}
// else if (getExtendAccessInfo() != null) // stack deve limitar, de
// acordo com a especificação ?
if (getExtensionAccessInfo() != null) {
encoding.append(SEMICOLON + SP
+ getExtensionAccessInfo().toString());
}
return encoding.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException(value, 0);
}
public boolean equals(Object other) {
return (other instanceof PAccessNetworkInfoHeader) && super.equals(other);
}
/*
* Makes a deep clone. (ParametersHeader)
*/
public Object clone() {
PAccessNetworkInfo retval = (PAccessNetworkInfo) super.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PAccessNetworkInfoHeader.java 0100644 0000000 0000000 00000010660 13513104763 023713 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* P-Access-Network-Info SIP P-Header
* This header carries information relating to the access network between
* the UAC and its serving proxy in the home network.
*
* IETF RFC3455 + 3GPP TS 24.229-720 (2005-12)
* Sintax:
*
* P-Access-Network-Info = "P-Access-Network-Info": access-type *(; access-info)
*
* access-type = "IEEE-802.11a" / "IEEE-802.11b" / "3GPP-GERAN" / "3GPP-UTRAN-FDD" /
* "3GPP-UTRAN-TDD" / "ADSL" / "ADSL2" / "ADSL2+" / "RADSL" / "SDSL" /
* "HDSL" / "HDSL2" / "G.SHDSL" / "VDSL" / "IDSL" / "3GPP2-1X" /
* "3GPP2-1XHRPD" /token
*
* access-info = cgi-3gpp / utran-cell-id-3gpp / dsl-location /
* ci-3gpp2 / extension-access-info
* cgi-3gpp = "cgi-3gpp" EQUAL (token / quoted-string)
* utran-cell-id-3gpp = "utran-cell-id-3gpp" EQUAL (token / quoted-string)
* dsl-location = "dsl-location" EQUAL (token / quoted-string)
* ci-3gpp2 = "ci-3gpp2" EQUAL (token / quoted-string)
* extension-access-info = gen-value
* gen-value = token / host / quoted-string
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public interface PAccessNetworkInfoHeader extends Parameters, Header
{
public final static String NAME = "P-Access-Network-Info";
// access type
public static final String IEEE_802_11 = "IEEE-802.11";
public static final String IEEE_802_11A = "IEEE-802.11a";
public static final String IEEE_802_11B = "IEEE-802.11b";
public static final String IEEE_802_11G = "IEEE-802.11g";
public static final String GGGPP_GERAN = "3GPP-GERAN";
public static final String GGGPP_UTRAN_FDD = "3GPP-UTRAN-FDD";
public static final String GGGPP_UTRAN_TDD = "3GPP-UTRAN-TDD";
public static final String GGGPP_CDMA2000 = "3GPP-CDMA2000";
public static final String ADSL = "ADSL";
public static final String ADSL2 = "ADSL2";
public static final String ADSL2p = "ADSL2+";
public static final String RADSL = "RADSL";
public static final String SDSL = "SDSL";
public static final String HDSL = "HDSL";
public static final String HDSL2 = "HDSL2";
public static final String GSHDSL = "G.SHDSL";
public static final String VDSL = "VDSL";
public static final String IDSL = "IDSL";
public static final String GGGPP2_1X = "3GPP2-1X";
public static final String GGGPP2_1XHRPD = "3GPP2-1XHRPD";
public void setAccessType(String accessTypeVal) throws ParseException;
public String getAccessType();
public void setCGI3GPP(String cgi) throws ParseException;
public String getCGI3GPP();
public void setUtranCellID3GPP(String utranCellID) throws ParseException;
public String getUtranCellID3GPP();
public void setDSLLocation(String dslLocation) throws ParseException;
public String getDSLLocation();
public void setCI3GPP2(String ci2Gpp2) throws ParseException;
public String getCI3GPP2();
public void setExtensionAccessInfo(Object extendAccessInfo) throws ParseException;
public Object getExtensionAccessInfo();
}
java/gov/nist/javax/sip/header/ims/PAssertedIdentity.java 0100644 0000000 0000000 00000005522 13513104763 022500 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.header.ims.PAssertedIdentityHeader;
import gov.nist.javax.sip.header.AddressParametersHeader;
/**
* P-Asserted-Identity SIP Private Header.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class PAssertedIdentity
extends AddressParametersHeader
implements PAssertedIdentityHeader, SIPHeaderNamesIms, ExtensionHeader {
/**
* constructor
* @param address address to set
*/
public PAssertedIdentity(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* default constructor
*/
public PAssertedIdentity()
{
super(NAME);
}
/** Encode into canonical form.
*@return String containing the canonicaly encoded header.
*/
public String encodeBody() {
StringBuffer retval = new StringBuffer();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(LESS_THAN);
}
retval.append(address.encode());
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(GREATER_THAN);
}
if (!parameters.isEmpty())
retval.append(COMMA + this.parameters.encode());
return retval.toString();
}
public Object clone() {
PAssertedIdentity retval = (PAssertedIdentity) super.clone();
return retval;
}
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/PAssertedIdentityHeader.java 0100644 0000000 0000000 00000004032 13513104763 023604 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO- EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
/*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
/**
* P-Asserted-Identity header
* Private Header: RFC 3455.
* Contains a URI (commonly a SIP URI) and an optional display-name
* enable a network of trusted SIP servers to assert
* the identity of authenticated users, and the application of existing
* privacy mechanisms to the identity problem.
* The use of this extension is only applicable inside an administrative
* domain with previously agreed-upon policies for generation,
* transport and usage of such information.
*
*
*/
public interface PAssertedIdentityHeader extends HeaderAddress, Header {
/**
* Name of AssertIdentityHeader
*/
public final static String NAME = "P-Asserted-Identity";
}
java/gov/nist/javax/sip/header/ims/PAssertedIdentityList.java 0100644 0000000 0000000 00000003736 13513104763 023341 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
/**
* List of P-Asserted-Identity headers
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
/*
* PAssertedID = "P-Asserted-Identity" HCOLON PAssertedID-value
* *(COMMA PAssertedID-value)
* PAssertedID-value = name-addr / addr-spec
*/
public class PAssertedIdentityList extends SIPHeaderList {
private static final long serialVersionUID = -6465152445570308974L;
/**
* constructor.
*/
public PAssertedIdentityList()
{
super(PAssertedIdentity.class, PAssertedIdentityHeader.NAME);
}
public Object clone() {
PAssertedIdentityList retval = new PAssertedIdentityList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/PAssertedService.java 0100644 0000000 0000000 00000006300 13513104763 022302 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import java.text.ParseException;
import gov.nist.javax.sip.header.SIPHeader;
import javax.sip.header.ExtensionHeader;
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
*/
public class PAssertedService extends SIPHeader implements PAssertedServiceHeader, SIPHeaderNamesIms, ExtensionHeader{
private String subServiceIds;
private String subAppIds;
protected PAssertedService(String name) {
super(NAME);
}
public PAssertedService()
{
super(P_ASSERTED_SERVICE);
}
@Override
protected String encodeBody() {
StringBuffer retval = new StringBuffer();
retval.append(ParameterNamesIms.SERVICE_ID);
if(this.subServiceIds!=null)
{
retval.append(ParameterNamesIms.SERVICE_ID_LABEL).append(".");
retval.append(this.getSubserviceIdentifiers());
}
else if(this.subAppIds!=null)
{
retval.append(ParameterNamesIms.APPLICATION_ID_LABEL).append(".");
retval.append(this.getApplicationIdentifiers());
}
return retval.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
public String getApplicationIdentifiers() {
if(this.subAppIds.charAt(0)=='.')
{
return this.subAppIds.substring(1);
}
return this.subAppIds;
}
public String getSubserviceIdentifiers() {
if(this.subServiceIds.charAt(0)=='.')
{
return this.subServiceIds.substring(1);
}
return this.subServiceIds;
}
public void setApplicationIdentifiers(String appids) {
this.subAppIds = appids;
}
public void setSubserviceIdentifiers(String subservices) {
this.subServiceIds = subservices;
}
public boolean equals(Object other)
{
return (other instanceof PAssertedServiceHeader) && super.equals(other);
}
public Object clone() {
PAssertedService retval = (PAssertedService) super.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PAssertedServiceHeader.java 0100644 0000000 0000000 00000004224 13513104763 023416 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import javax.sip.header.Header;
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
* The ABNF for this header is all follows:
*
* PAssertedService = "P-Asserted-Service"
* HCOLON PAssertedService-value
*
* PAssertedService-value = Service-ID *(COMMA Service-ID)
*
* where,
*
* Service-ID = "urn:urn-7:" urn-service-id
* urn-service-id = top-level *("." sub-service-id)
* top-level = let-dig [ *26let-dig ]
* sub-service-id = let-dig [ *let-dig ]
* let-dig = ALPHA / DIGIT / "-"
*
* Egs: P-Asserted-Service: urn:urn-7:3gpp-service.exampletelephony.version1
* P-Asserted-Service: urn:urn-7:3gpp-application.exampletelephony.version1
*
*/
public interface PAssertedServiceHeader extends Header{
public static final String NAME = "P-Asserted-Service";
public void setSubserviceIdentifiers(String subservices);
public String getSubserviceIdentifiers();
public void setApplicationIdentifiers(String appids);
public String getApplicationIdentifiers();
}
java/gov/nist/javax/sip/header/ims/PAssociatedURI.java 0100644 0000000 0000000 00000011104 13513104763 021644 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University (Portugal) *
****************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.address.GenericURI;
import javax.sip.address.URI;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.header.ims.PAssociatedURIHeader;
/**
* P-Associated-URI SIP Private Header.
* An associated URI is a URI that the service provider
* has allocated to a user for his own usage (address-of-record).
*
* sintax (RFC 3455):
*
* P-Associated-URI = "P-Associated-URI" HCOLON
* (p-aso-uri-spec) *(COMMA p-aso-uri-spec)
* p-aso-uri-spec = name-addr *(SEMI ai-param)
* ai-param = generic-param
* name-addr = [display-name] angle-addr
* angle-addr = [CFWS] "<" addr-spec ">" [CFWS] / obs-angle-addr
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class PAssociatedURI
extends gov.nist.javax.sip.header.AddressParametersHeader
implements PAssociatedURIHeader, SIPHeaderNamesIms, ExtensionHeader
{
// TODO: Need a unique UID
/**
* Default Constructor
*/
public PAssociatedURI()
{
super(PAssociatedURIHeader.NAME);
}
/**
* Constructor
* @param address to be set in the header
*/
public PAssociatedURI(AddressImpl address)
{
super(PAssociatedURIHeader.NAME);
this.address = address;
}
/**
* Constructor
* @param associatedURI - GenericURI to be set in the address of this header
*/
public PAssociatedURI(GenericURI associatedURI)
{
super(PAssociatedURIHeader.NAME);
this.address = new AddressImpl();
this.address.setURI(associatedURI);
}
/**
* Encode into canonical form.
* @return String containing the canonicaly encoded header.
*/
public String encodeBody()
{
StringBuffer retval = new StringBuffer();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(LESS_THAN);
}
retval.append(address.encode());
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(GREATER_THAN);
}
if (!parameters.isEmpty())
retval.append(SEMICOLON + this.parameters.encode());
return retval.toString();
}
/**
* Set the URI on this address
* @param associatedURI - GenericURI to be set in the address of this header
* @throws NullPointerException when supplied URI is null
*/
public void setAssociatedURI(URI associatedURI) throws NullPointerException
{
if (associatedURI == null)
throw new NullPointerException("null URI");
this.address.setURI(associatedURI);
}
/**
* Get the address's URI
* @return URI set in the address of this header
*/
public URI getAssociatedURI() {
return this.address.getURI();
}
public Object clone() {
PAssociatedURI retval = (PAssociatedURI) super.clone();
if (this.address != null)
retval.address = (AddressImpl) this.address.clone();
return retval;
}
public void setValue(String value) throws ParseException{
// not implemented
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/PAssociatedURIHeader.java 0100644 0000000 0000000 00000005431 13513104763 022763 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University (Portugal) *
****************************************************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
import javax.sip.address.URI;
/**
* P-Associated-URI SIP Private Header.
* An associated URI is a URI that the service provider
* has allocated to a user for his own usage (address-of-record).
*
* sintax (RFC 3455):
*
* P-Associated-URI = "P-Associated-URI" HCOLON
* (p-aso-uri-spec) *(COMMA p-aso-uri-spec)
* p-aso-uri-spec = name-addr *(SEMI ai-param)
* ai-param = generic-param
* name-addr = [display-name] angle-addr
* angle-addr = [CFWS] "<" addr-spec ">" [CFWS] / obs-angle-addr
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
/*
*/
public interface PAssociatedURIHeader
extends HeaderAddress, Parameters, Header
{
/**
* Name of PAssociatedURIHeader
*/
public final static String NAME = "P-Associated-URI";
/**
* Set the URI on this address
* @param associatedURI - GenericURI to be set in the address of this header
* @throws NullPointerException when supplied URI is null
*/
public void setAssociatedURI(URI associatedURI) throws NullPointerException;
/**
* Get the address's URI
* @return URI set in the address of this header
*/
public URI getAssociatedURI();
//public void setAssociatedURI(AddressImpl associatedURI);
//public AddressImpl getAssociatedURI();
}
java/gov/nist/javax/sip/header/ims/PAssociatedURIList.java 0100644 0000000 0000000 00000003576 13513104763 022516 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
/**
* List of P-Associated-URI headers
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
/*
* P-Associated-URI = "P-Associated-URI" ":" # ( "<" URI ">" *( ";" generic-param ))
*/
public class PAssociatedURIList extends SIPHeaderList {
private static final long serialVersionUID = 4454306052557362851L;
/**
* constructor.
*/
public PAssociatedURIList()
{
super(PAssociatedURI.class, PAssociatedURI.NAME);
}
public Object clone() {
PAssociatedURIList retval = new PAssociatedURIList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/PCalledPartyID.java 0100644 0000000 0000000 00000005302 13513104763 021631 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.header.ims.PCalledPartyIDHeader;
/**
* P-Called-Party-ID SIP Private Header.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class PCalledPartyID
extends gov.nist.javax.sip.header.AddressParametersHeader
implements PCalledPartyIDHeader, SIPHeaderNamesIms , ExtensionHeader{
/**
* constructor
* @param address address to set
*/
public PCalledPartyID(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* default constructor
*/
public PCalledPartyID() {
super(CALLED_PARTY_ID);
}
/** Encode into canonical form.
*@return String containing the canonicaly encoded header.
*/
public String encodeBody() {
StringBuffer retval = new StringBuffer();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(LESS_THAN);
}
retval.append(address.encode());
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(GREATER_THAN);
}
if (!parameters.isEmpty())
retval.append(SEMICOLON + this.parameters.encode());
return retval.toString();
}
public void setValue(String value) throws ParseException {
// not implemented.
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/PCalledPartyIDHeader.java 0100644 0000000 0000000 00000004566 13513104763 022755 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
/**
* P-Called-Party-ID header - Private Header: RFC 3455.
* A proxy server inserts a P-Called-Party-ID header, typically in an INVITE request,
* en-route to its destination. The header is populated with the Request-URI received
* by the proxy in the request.
* Both the business SIP URI and the personal SIP URI are registered in the SIP registrar,
* so both URIs can receive invitations to new sessions. When the user receives an invitation
* to join a session, he/she should be aware of which of the several registered SIP URIs this
* session was sent to.
*
*
* P-Called-Party-ID = "P-Called-Party-ID" HCOLON
* called-pty-id-spec
* called-pty-id-spec = name-addr *(SEMI cpid-param)
* cpid-param = generic-param
*
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*
*/
public interface PCalledPartyIDHeader extends HeaderAddress, Parameters, Header {
/**
* Name of CalledPartyIDHeader
*/
public final static String NAME = "P-Called-Party-ID";
}
java/gov/nist/javax/sip/header/ims/PChargingFunctionAddresses.java 0100644 0000000 0000000 00000022622 13513104763 024302 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.core.NameValue;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.ListIterator;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.header.ims.PChargingFunctionAddressesHeader;
import gov.nist.javax.sip.header.ims.ParameterNamesIms;
/**
* P-Charging-Function-Addresses SIP Private Header.
*
* Sintax (RFC 3455):
*
* P-Charging-Addr = "P-Charging-Function-Addresses" HCOLON
* charge-addr-params
* *(SEMI charge-addr-params)
* charge-addr-params = ccf / ecf / generic-param
* ccf = "ccf" EQUAL gen-value
* ecf = "ecf" EQUAL gen-value
* gen-value = token / host / quoted-string
*
*
* example:
* P-Charging-Function-Addresses: ccf=192.1.1.1; ccf=192.1.1.2;
* ecf=192.1.1.3; ecf=192.1.1.4
*
* TODO: add PARSER support for IPv6 address.
* eg: P-Charging-Function-Addresses: ccf=[5555.b99.c88.d77.e66]; ecf=[5555.6aa.7bb.8cc.9dd]
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class PChargingFunctionAddresses
extends gov.nist.javax.sip.header.ParametersHeader
implements PChargingFunctionAddressesHeader, SIPHeaderNamesIms , ExtensionHeader{
// TODO: serialVersionUID
/**
* Defaul Constructor
*/
public PChargingFunctionAddresses() {
super(P_CHARGING_FUNCTION_ADDRESSES);
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.header.ParametersHeader#encodeBody()
*/
protected String encodeBody() {
StringBuffer encoding = new StringBuffer();
// issued by Miguel Freitas
if (!duplicates.isEmpty())
{
encoding.append(duplicates.encode());
}
return encoding.toString();
}
/**
* Set the Charging Collection Function (CCF) Address
*
* @param ccfAddress - the address to set in the CCF parameter
* @throws ParseException
*/
public void setChargingCollectionFunctionAddress(String ccfAddress) throws ParseException {
if (ccfAddress == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Function-Addresses, setChargingCollectionFunctionAddress(), the ccfAddress parameter is null.");
// setParameter(ParameterNamesIms.CCF, ccfAddress);
setMultiParameter(ParameterNamesIms.CCF, ccfAddress);
}
/**
* Add another Charging Collection Function (CCF) Address to this header
*
* @param ccfAddress - the address to set in the CCF parameter
* @throws ParseException
*/
public void addChargingCollectionFunctionAddress(String ccfAddress) throws ParseException {
if (ccfAddress == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Function-Addresses, setChargingCollectionFunctionAddress(), the ccfAddress parameter is null.");
this.parameters.set(ParameterNamesIms.CCF, ccfAddress);
}
/**
* Remove a Charging Collection Function (CCF) Address set in this header
*
* @param ccfAddress - the address in the CCF parameter to remove
* @throws ParseException if the address was not removed
*/
public void removeChargingCollectionFunctionAddress(String ccfAddress) throws ParseException {
if (ccfAddress == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Function-Addresses, setChargingCollectionFunctionAddress(), the ccfAddress parameter is null.");
if(!this.delete(ccfAddress, ParameterNamesIms.CCF)) {
throw new ParseException("CCF Address Not Removed",0);
}
}
/**
* Get all the Charging Collection Function (CCF) Addresses set in this header
*
* @return ListIterator that constains all CCF addresses of this header
*/
public ListIterator getChargingCollectionFunctionAddresses() {
Iterator li = this.parameters.iterator();
LinkedList ccfLIST = new LinkedList();
NameValue nv;
while (li.hasNext()) {
nv = (NameValue) li.next();
if (nv.getName().equalsIgnoreCase(ParameterNamesIms.CCF)) {
NameValue ccfNV = new NameValue();
ccfNV.setName(nv.getName());
ccfNV.setValueAsObject(nv.getValueAsObject());
ccfLIST.add(ccfNV);
}
}
return ccfLIST.listIterator();
}
/**
* Set the Event Charging Function (ECF) Address
*
* @param ecfAddress - the address to set in the ECF parameter
* @throws ParseException
*/
public void setEventChargingFunctionAddress(String ecfAddress) throws ParseException {
if (ecfAddress == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Function-Addresses, setEventChargingFunctionAddress(), the ecfAddress parameter is null.");
setMultiParameter(ParameterNamesIms.ECF, ecfAddress);
// setParameter(ParameterNamesIms.ECF, ecfAddress);
}
/**
* Add another Event Charging Function (ECF) Address to this header
*
* @param ecfAddress - the address to set in the ECF parameter
* @throws ParseException
*/
public void addEventChargingFunctionAddress(String ecfAddress) throws ParseException {
if (ecfAddress == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Function-Addresses, setEventChargingFunctionAddress(), the ecfAddress parameter is null.");
this.parameters.set(ParameterNamesIms.ECF, ecfAddress);
}
/**
* Remove a Event Charging Function (ECF) Address set in this header
*
* @param ecfAddress - the address in the ECF parameter to remove
* @throws ParseException if the address was not removed
*/
public void removeEventChargingFunctionAddress(String ecfAddress) throws ParseException {
if (ecfAddress == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Function-Addresses, setEventChargingFunctionAddress(), the ecfAddress parameter is null.");
if(!this.delete(ecfAddress, ParameterNamesIms.ECF)) {
throw new java.text.ParseException("ECF Address Not Removed",0);
}
}
/**
* Get all the Event Charging Function (ECF) Addresses set in this header
*
* @return ListIterator that constains all CCF addresses of this header
*/
public ListIterator getEventChargingFunctionAddresses() {
LinkedList listw = new LinkedList();
Iterator li = this.parameters.iterator();
ListIterator ecfLIST = listw.listIterator();
NameValue nv;
boolean removed = false;
while (li.hasNext()) {
nv = (NameValue) li.next();
if (nv.getName().equalsIgnoreCase(ParameterNamesIms.ECF)) {
NameValue ecfNV = new NameValue();
ecfNV.setName(nv.getName());
ecfNV.setValueAsObject(nv.getValueAsObject());
ecfLIST.add(ecfNV);
}
}
return ecfLIST;
}
/**
* Remove parameter
*
* @param value - of the parameter
* @param name - of the parameter
* @return true if parameter was removed, and false if not
*/
public boolean delete(String value, String name) {
Iterator li = this.parameters.iterator();
NameValue nv;
boolean removed = false;
while (li.hasNext()) {
nv = (NameValue) li.next();
if (((String) nv.getValueAsObject()).equalsIgnoreCase(value) && nv.getName().equalsIgnoreCase(name)) {
li.remove();
removed = true;
}
}
return removed;
}
public void setValue(String value) throws ParseException {
throw new ParseException ( value,0);
}
}
java/gov/nist/javax/sip/header/ims/PChargingFunctionAddressesHeader.java 0100644 0000000 0000000 00000012175 13513104763 025415 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.core.NameValue;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.ListIterator;
/**
* P-Charging-Function-Addresses header -
* Private Header: RFC 3455.
*
* There is a need to inform each SIP proxy involved in a transaction about the common
* charging functional entities to receive the generated charging records or charging events.
*
* -
* - CCF is used for off-line charging (e.g., for postpaid account charging).
*
-
* - ECF is used for on-line charging (e.g., for pre-paid account charging).
*
* Only one instance of the header MUST be present in a particular request or response.
*
*
* P-Charging-Addr = "P-Charging-Function-Addresses" HCOLON
* charge-addr-params
* *(SEMI charge-addr-params)
* charge-addr-params = ccf / ecf / generic-param
* ccf = "ccf" EQUAL gen-value
* ecf = "ecf" EQUAL gen-value
*
* gen-value = token / host / quoted-string
*
* host = hostname / IPv4address / IPv6reference
* hostname = *( domainlabel "." ) toplabel [ "." ]
* domainlabel = alphanum / alphanum *( alphanum / "-" ) alphanum
* toplabel = ALPHA / ALPHA *( alphanum / "-" ) alphanum
*
*
* example:
* P-Charging-Function-Addresses: ccf=192.1.1.1; ccf=192.1.1.2;
* ecf=192.1.1.3; ecf=192.1.1.4
*
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public interface PChargingFunctionAddressesHeader extends Parameters, Header {
/**
* Name of PChargingFunctionAddressesHeader
*/
public final static String NAME = "P-Charging-Function-Addresses";
/**
* Set the Charging Collection Function (CCF) Address
* @param ccfAddress - the address to set in the CCF parameter
* @throws ParseException
*/
public void setChargingCollectionFunctionAddress(String ccfAddress) throws ParseException;
/**
* Add another Charging Collection Function (CCF) Address to this header
* @param ccfAddress - the address to set in the CCF parameter
* @throws ParseException
*/
public void addChargingCollectionFunctionAddress(String ccfAddress) throws ParseException;
/**
* Remove a Charging Collection Function (CCF) Address set in this header
* @param ccfAddress - the address in the CCF parameter to remove
* @throws ParseException if the address was not removed
*/
public void removeChargingCollectionFunctionAddress(String ccfAddress) throws ParseException;
/**
* Get all the Charging Collection Function (CCF) Addresses set in this header
* @return ListIterator that constains all CCF addresses of this header
*/
public ListIterator getChargingCollectionFunctionAddresses();
/**
* Set the Event Charging Function (ECF) Address
* @param ecfAddress - the address to set in the ECF parameter
* @throws ParseException
*/
public void setEventChargingFunctionAddress(String ecfAddress)throws ParseException;
/**
* Add another Event Charging Function (ECF) Address to this header
* @param ecfAddress - the address to set in the ECF parameter
* @throws ParseException
*/
public void addEventChargingFunctionAddress(String ecfAddress) throws ParseException;
/**
* Remove a Event Charging Function (ECF) Address set in this header
* @param ecfAddress - the address in the ECF parameter to remove
* @throws ParseException if the address was not removed
*/
public void removeEventChargingFunctionAddress(String ecfAddress) throws ParseException;
/**
* Get all the Event Charging Function (ECF) Addresses set in this header
* @return ListIterator that constains all CCF addresses of this header
*/
public ListIterator getEventChargingFunctionAddresses();
}
java/gov/nist/javax/sip/header/ims/PChargingVector.java 0100644 0000000 0000000 00000014610 13513104763 022117 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.header.ims.PChargingVectorHeader;
import gov.nist.javax.sip.header.ims.ParameterNamesIms;
/**
* P-Charging-Vector header SIP Private Header: RFC 3455.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS
*/
public class PChargingVector extends gov.nist.javax.sip.header.ParametersHeader
implements PChargingVectorHeader, SIPHeaderNamesIms, ExtensionHeader {
/**
* Default Constructor
*/
public PChargingVector() {
super(P_CHARGING_VECTOR);
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.header.ParametersHeader#encodeBody()
*/
protected String encodeBody() {
StringBuffer encoding = new StringBuffer();
/*
* no need to check for the presence of icid-value. According to the
* spec above this is a mandatory field. if it does not exist, then we
* should throw an exception
*
* JvB 26/5: fix for issue #159, check for quotes around icid value
*/
gov.nist.core.NameValue nv = getNameValue( ParameterNamesIms.ICID_VALUE );
nv.encode( encoding );
//the remaining parameters are optional.
// check for their presence, then add the parameter if it exists.
if (parameters.containsKey(ParameterNamesIms.ICID_GENERATED_AT))
encoding.append(SEMICOLON).append(
ParameterNamesIms.ICID_GENERATED_AT).append(EQUALS).append(
getICIDGeneratedAt());
if (parameters.containsKey(ParameterNamesIms.TERM_IOI))
encoding.append(SEMICOLON).append(ParameterNamesIms.TERM_IOI)
.append(EQUALS).append(getTerminatingIOI());
if (parameters.containsKey(ParameterNamesIms.ORIG_IOI))
encoding.append(SEMICOLON).append(ParameterNamesIms.ORIG_IOI)
.append(EQUALS).append(getOriginatingIOI());
return encoding.toString();
}
/**
*
* Get the icid-value parameter value
*
*
* @return the value of the icid-value parameter
*/
public String getICID() {
return getParameter(ParameterNamesIms.ICID_VALUE);
}
/**
*
* Set the icid-value parameter
*
*
* @param icid -
* value to set in the icid-value parameter
* @throws ParseException
*/
public void setICID(String icid) throws ParseException {
if (icid == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Vector, setICID(), the icid parameter is null.");
setParameter(ParameterNamesIms.ICID_VALUE, icid);
}
/**
*
* Get the icid-generated-at parameter value
*
*
* @return the icid-generated-at parameter value
*/
public String getICIDGeneratedAt() {
return getParameter(ParameterNamesIms.ICID_GENERATED_AT);
}
/**
*
* Set the icid-generated-at parameter
*
*
* @param host -
* value to set in the icid-generated-at parameter
* @throws ParseException
*/
public void setICIDGeneratedAt(String host) throws ParseException {
if (host == null)
throw new NullPointerException(
"JAIN-SIP Exception, "
+ "P-Charging-Vector, setICIDGeneratedAt(), the host parameter is null.");
setParameter(ParameterNamesIms.ICID_GENERATED_AT, host);
}
/**
*
* Get the orig-ioi parameter value
*
*
* @return the orig-ioi parameter value
*/
public String getOriginatingIOI() {
return getParameter(ParameterNamesIms.ORIG_IOI);
}
/**
*
* Set the orig-ioi parameter
*
*
* @param origIOI -
* value to set in the orig-ioi parameter. If value is null or
* empty, the parameter is removed
* @throws ParseException
*/
public void setOriginatingIOI(String origIOI) throws ParseException {
if (origIOI == null || origIOI.length() == 0) {
removeParameter(ParameterNamesIms.ORIG_IOI);
} else
setParameter(ParameterNamesIms.ORIG_IOI, origIOI);
}
/**
*
* Get the term-ioi parameter value
*
*
* @return the term-ioi parameter value
*/
public String getTerminatingIOI() {
return getParameter(ParameterNamesIms.TERM_IOI);
}
/**
*
* Set the term-ioi parameter
*
*
* @param termIOI -
* value to set in the term-ioi parameter. If value is null or
* empty, the parameter is removed
* @throws ParseException
*/
public void setTerminatingIOI(String termIOI) throws ParseException {
if (termIOI == null || termIOI.length() == 0) {
removeParameter(ParameterNamesIms.TERM_IOI);
} else
setParameter(ParameterNamesIms.TERM_IOI, termIOI);
}
public void setValue(String value) throws ParseException {
throw new ParseException(value, 0);
}
}
java/gov/nist/javax/sip/header/ims/PChargingVectorHeader.java 0100644 0000000 0000000 00000012125 13513104763 023227 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* P-Charging-Vector header SIP Private Header.
*
* Sintax (RFC 3455):
*
* P-Charging-Vector = "P-Charging-Vector" HCOLON icid-value (SEMI charge-params)
* charge-params = icid-gen-addr / orig-ioi / term-ioi / generic-param
* icid-value = "icid-value" EQUAL gen-value
* icid-gen-addr = "icid-generated-at" EQUAL host
* orig-ioi = "orig-ioi" EQUAL gen-value
* term-ioi = "term-ioi" EQUAL gen-value
*
*
* Sintax from RFC3261:
*
* generic-param = token [ EQUAL gen-value ]
* gen-value = token / host / quoted-string
* host = hostname / IPv4address / Ipv6reference
*
*
*
* syntax as in 3GPP TS 24.229-720 (2005-12) :
*
* The access-network-charging-info parameter is an instance of generic-param
* from the current charge-params:
*
*
* access-network-charging-info = (gprs-charging-info / i-wlan-charging-info / xdsl-charging-info / generic-param)
* gprs-charging-info = ggsn SEMI auth-token [SEMI pdp-info-hierarchy] *(SEMI extension-param)
* ggsn = "ggsn" EQUAL gen-value
* pdp-info-hierarchy = "pdp-info" EQUAL LDQUOT pdp-info *(COMMA pdp-info) RDQUOT
* pdp-info = pdp-item SEMI pdp-sig SEMI gcid [SEMI flow-id]
* pdp-item = "pdp-item" EQUAL DIGIT
* pdp-sig = "pdp-sig" EQUAL ("yes" / "no")
* gcid = "gcid" EQUAL 1*HEXDIG
* auth-token = "auth-token" EQUAL 1*HEXDIG
* flow-id = "flow-id" EQUAL "(" "{" 1*DIGIT COMMA 1*DIGIT "}" *(COMMA "{" 1*DIGIT COMMA 1*DIGIT"}")")"
* extension-param = token [EQUAL token]
* i-wlan-charging-info = "pdg"
* xdsl-charging-info = bras SEMI auth-token [SEMI xDSL-bearer-info] *(SEMI extension-param)
* bras = "bras" EQUAL gen-value
* xDSL-bearer-info = "dsl-bearer-info" EQUAL LDQUOT dsl-bearer-info *(COMMA dsl-bearer-info) RDQUOT
* dsl-bearer-info = dsl-bearer-item SEMI dsl-bearer-sig SEMI dslcid [SEMI flow-id]
* dsl-bearer-item = "dsl-bearer-item" EQUAL DIGIT
* dsl-bearer-sig = "dsl-bearer-sig"
*
*
*
* example:
* P-Charging-Vector: icid-value=1234bc9876e; icid-generated-at=192.0.6.8; orig-ioi=home1.net
*
*
* TODO: gen-value can be token / host / quoted-string
* TODO: add suport for the new header extensions access-network-charging-info
*
* @author ALEXANDRE MIGUEL SILVA SANTOS
*/
public interface PChargingVectorHeader extends Header, Parameters {
/**
* Name of PChargingVectorHeader
*/
public final static String NAME = "P-Charging-Vector";
/**
* @return -- icid value.
*/
public String getICID();
/**
* @param icid
* @throws ParseException
*/
public void setICID(String icid) throws ParseException;
/**
* @return -- the ICID generatedAt field.
*/
public String getICIDGeneratedAt();
/**
* @param host -- set the icid host value.
*
* @throws ParseException -- if bad host value.
*/
public void setICIDGeneratedAt(String host) throws ParseException;
/**
*
* @return the originating IOI
*/
public String getOriginatingIOI();
/**
* @param origIOI
* @throws ParseException
*
*/
public void setOriginatingIOI(String origIOI) throws ParseException;
/**
* @return -- the terminating IOI field
*/
public String getTerminatingIOI();
/**
* @param termIOI -- the terminating IOI field to set.
* @throws ParseException
*/
public void setTerminatingIOI(String termIOI) throws ParseException;
}
java/gov/nist/javax/sip/header/ims/PMediaAuthorization.java 0100644 0000000 0000000 00000007366 13513104763 023024 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University - Portugal) *
*****************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import gov.nist.javax.sip.header.SIPHeader;
import javax.sip.InvalidArgumentException;
import javax.sip.header.ExtensionHeader;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
/**
* P-Media-Authorization SIP Private Header - RFC 3313.
*
* Sintax:
*
* P-Media-Authorization = "P-Media-Authorization" HCOLON
* P-Media-Authorization-Token
* *(COMMA P-Media-Authorization-Token)
* P-Media-Authorization-Token = 1*HEXDIG
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class PMediaAuthorization
extends SIPHeader
implements PMediaAuthorizationHeader, SIPHeaderNamesIms, ExtensionHeader
{
/**
* Comment for serialVersionUID
*/
private static final long serialVersionUID = -6463630258703731133L;
/**
* P-Media-Authorization Token
*/
private String token;
/**
* Constructor
*/
public PMediaAuthorization()
{
super(P_MEDIA_AUTHORIZATION);
}
/**
* Get the media authorization token.
*
* @return token
*/
public String getToken()
{
return token;
}
/**
* Set the media authorization token.
*
* @param token - media authorization token to set
* @throws InvalidArgumentException - if token is null or empty
*/
public void setMediaAuthorizationToken(String token) throws InvalidArgumentException
{
if (token == null || token.length() == 0)
throw new InvalidArgumentException(" the Media-Authorization-Token parameter is null or empty");
this.token = token;
}
/**
* Encode header
* @return the header content
*/
protected String encodeBody()
{
return token;
}
public void setValue(String value) throws ParseException {
throw new ParseException (value,0);
}
public boolean equals(Object other)
{
if (other instanceof PMediaAuthorizationHeader)
{
final PMediaAuthorizationHeader o = (PMediaAuthorizationHeader) other;
return this.getToken().equals(o.getToken());
}
return false;
}
public Object clone() {
PMediaAuthorization retval = (PMediaAuthorization) super.clone();
if (this.token != null)
retval.token = this.token;
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PMediaAuthorizationHeader.java 0100644 0000000 0000000 00000004501 13513104763 024121 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University - Portugal) *
*****************************************************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.InvalidArgumentException;
import javax.sip.header.Header;
/**
* The P-Media-Authorization SIP Private Header - RFC 3313.
*
* Sintax:
*
* P-Media-Authorization = "P-Media-Authorization" HCOLON
* P-Media-Authorization-Token
* *(COMMA P-Media-Authorization-Token)
* P-Media-Authorization-Token = 1*HEXDIG
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public interface PMediaAuthorizationHeader extends Header
{
/**
* Name of PMediaAuthorizationHeader
*/
public final static String NAME = "P-Media-Authorization";
/**
* Set the media authorization token.
* @param token - media authorization token to set
* @throws InvalidArgumentException - if token is null or empty
*/
public void setMediaAuthorizationToken(String token) throws InvalidArgumentException;
/**
* Get the media authorization token.
* @return token
*/
public String getToken();
}
java/gov/nist/javax/sip/header/ims/PMediaAuthorizationList.java 0100644 0000000 0000000 00000003605 13513104763 023650 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University - Portugal) *
*****************************************************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
/**
* List of P-Media-Authorization headers.
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class PMediaAuthorizationList extends SIPHeaderList {
private static final long serialVersionUID = -8226328073989632317L;
public PMediaAuthorizationList()
{
super(PMediaAuthorization.class, PMediaAuthorizationHeader.NAME);
}
public Object clone() {
PMediaAuthorizationList retval = new PMediaAuthorizationList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/PPreferredIdentity.java 0100644 0000000 0000000 00000005107 13513104763 022643 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.header.AddressParametersHeader;
/**
* P-Preferred-Identity SIP Private Header - RFC 3325.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class PPreferredIdentity
extends AddressParametersHeader
implements PPreferredIdentityHeader, SIPHeaderNamesIms , ExtensionHeader {
/**
* constructor
* @param address address to set
*/
public PPreferredIdentity(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* default constructor
*/
public PPreferredIdentity() {
super(P_PREFERRED_IDENTITY);
}
/** Encode into canonical form.
* @return String containing the canonicaly encoded header.
*/
public String encodeBody() {
StringBuffer retval = new StringBuffer();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(LESS_THAN);
}
retval.append(address.encode());
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(GREATER_THAN);
}
return retval.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException (value,0);
}
}
java/gov/nist/javax/sip/header/ims/PPreferredIdentityHeader.java 0100644 0000000 0000000 00000004210 13513104763 023746 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
/**
* P-Preferred-Identity header -
* SIP Private Header: RFC 3325
*
*
* -
* . is used from a user agent to a trusted proxy to carry the identity the
* user sending the SIP message wishes to be used for the P-Asserted-Header
* field value that the trusted element will insert.
*
-
* . If there are two values, one value MUST be a sip or sips URI and the other
* MUST be a tel URI.
*
*
* Sintax:
*
* PPreferredID = "P-Preferred-Identity" HCOLON PPreferredID-value
* *(COMMA PPreferredID-value)
* PPreferredID-value = name-addr / addr-spec
*
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public interface PPreferredIdentityHeader extends HeaderAddress, Header {
/**
* Name of PreferredIdentityHeader
*/
public final static String NAME = "P-Preferred-Identity";
}
java/gov/nist/javax/sip/header/ims/PPreferredService.java 0100644 0000000 0000000 00000006246 13513104763 022457 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.header.SIPHeader;
/**
*
* @author aayush.bhatnagar
*
*/
public class PPreferredService extends SIPHeader implements PPreferredServiceHeader, SIPHeaderNamesIms, ExtensionHeader{
private String subServiceIds;
private String subAppIds;
protected PPreferredService(String name) {
super(NAME);
}
public PPreferredService()
{
super(P_PREFERRED_SERVICE);
}
@Override
protected String encodeBody() {
StringBuffer retval = new StringBuffer();
retval.append(ParameterNamesIms.SERVICE_ID);
if(this.subServiceIds!=null)
{
retval.append(ParameterNamesIms.SERVICE_ID_LABEL).append(".");
retval.append(this.getSubserviceIdentifiers());
}
else if(this.subAppIds!=null)
{
retval.append(ParameterNamesIms.APPLICATION_ID_LABEL).append(".");
retval.append(this.getApplicationIdentifiers());
}
return retval.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
public String getApplicationIdentifiers() {
if(this.subAppIds.charAt(0)=='.')
{
return this.subAppIds.substring(1);
}
return this.subAppIds;
}
public String getSubserviceIdentifiers() {
if(this.subServiceIds.charAt(0)=='.')
{
return this.subServiceIds.substring(1);
}
return this.subServiceIds;
}
public void setApplicationIdentifiers(String appids) {
this.subAppIds = appids;
}
public void setSubserviceIdentifiers(String subservices) {
this.subServiceIds = ".".concat(subservices);
}
public boolean equals(Object other)
{
return (other instanceof PPreferredServiceHeader) && super.equals(other);
}
public Object clone() {
PPreferredService retval = (PPreferredService) super.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PPreferredServiceHeader.java 0100644 0000000 0000000 00000004160 13513104763 023561 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import javax.sip.header.Header;
/**
*
* @author aayush.bhatnagar
*
* The ABNF for this header is all follows:
*
* PPreferredService = "P-Preferred-Service"
* HCOLON PPreferredService-value
*
* PPreferredService-value = Service-ID *(COMMA Service-ID)
*
* where,
*
* Service-ID = "urn:urn-7:" urn-service-id
* urn-service-id = top-level *("." sub-service-id)
* top-level = let-dig [ *26let-dig ]
* sub-service-id = let-dig [ *let-dig ]
* let-dig = ALPHA / DIGIT / "-"
*
* Egs: P-Preferred-Service: urn:urn-7:3gpp-service.exampletelephony.version1
* P-Preferred-Service: urn:urn-7:3gpp-application.exampletelephony.version1
*
*/
public interface PPreferredServiceHeader extends Header{
public static final String NAME = "P-Preferred-Service";
public void setSubserviceIdentifiers(String subservices);
public String getSubserviceIdentifiers();
public void setApplicationIdentifiers(String appids);
public String getApplicationIdentifiers();
}
java/gov/nist/javax/sip/header/ims/PProfileKey.java 0100644 0000000 0000000 00000004765 13513104763 021275 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import java.text.ParseException;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.header.AddressParametersHeader;
import javax.sip.header.ExtensionHeader;
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
*/
public class PProfileKey extends AddressParametersHeader implements PProfileKeyHeader, SIPHeaderNamesIms , ExtensionHeader {
public PProfileKey( ) {
super(P_PROFILE_KEY);
}
public PProfileKey(AddressImpl address)
{
super(NAME);
this.address = address;
}
@Override
protected String encodeBody() {
StringBuffer retval = new StringBuffer();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(LESS_THAN);
}
retval.append(address.encode());
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(GREATER_THAN);
}
if (!parameters.isEmpty())
retval.append(SEMICOLON + this.parameters.encode());
return retval.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
public boolean equals(Object other)
{
return (other instanceof PProfileKey) && super.equals(other);
}
public Object clone() {
PProfileKey retval = (PProfileKey) super.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PProfileKeyHeader.java 0100644 0000000 0000000 00000003130 13513104763 022367 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
* The ABNF syntax of this header is as follows:
* P-Profile-Key = "P-Profile-Key" HCOLON {name-addr / addr-spec}
* *{ SEMI generic-param }
*
* Eg: P-Profile-Key:
*
*/
public interface PProfileKeyHeader extends HeaderAddress, Header{
public final static String NAME = "P-Profile-Key";
}
java/gov/nist/javax/sip/header/ims/PServedUser.java 0100644 0000000 0000000 00000011335 13513104763 021302 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.header.AddressParametersHeader;
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
* This is the class used for encoding of the P-Served-User header
*
*
*/
public class PServedUser extends AddressParametersHeader implements PServedUserHeader, SIPHeaderNamesIms, ExtensionHeader{
public PServedUser(AddressImpl address)
{
super(P_SERVED_USER);
this.address = address;
}
public PServedUser()
{
super(NAME);
}
public String getRegistrationState() {
return getParameter(ParameterNamesIms.REGISTRATION_STATE);
}
public String getSessionCase() {
return getParameter(ParameterNamesIms.SESSION_CASE);
}
public void setRegistrationState(String registrationState) {
if((registrationState!=null))
{
if(registrationState.equals("reg")||registrationState.equals("unreg"))
{
try {
setParameter(ParameterNamesIms.REGISTRATION_STATE, registrationState);
} catch (ParseException e) {
e.printStackTrace();
}
}
else
{
try {
throw new InvalidArgumentException("Value can be either reg or unreg");
} catch (InvalidArgumentException e) {
e.printStackTrace();
}
}
}
else
{
throw new NullPointerException("regstate Parameter value is null");
}
}
public void setSessionCase(String sessionCase) {
if((sessionCase!=null))
{
if((sessionCase.equals("orig"))||(sessionCase.equals("term")))
{
try {
setParameter(ParameterNamesIms.SESSION_CASE, sessionCase);
} catch (ParseException e) {
e.printStackTrace();
}
}
else
{
try {
throw new InvalidArgumentException("Value can be either orig or term");
} catch (InvalidArgumentException e) {
e.printStackTrace();
}
}
}
else
{
throw new NullPointerException("sess-case Parameter value is null");
}
}
@Override
protected String encodeBody() {
StringBuffer retval = new StringBuffer();
retval.append(address.encode());
if(parameters.containsKey(ParameterNamesIms.REGISTRATION_STATE))
retval.append(SEMICOLON).append(ParameterNamesIms.REGISTRATION_STATE).append(EQUALS)
.append(this.getRegistrationState());
if(parameters.containsKey(ParameterNamesIms.SESSION_CASE))
retval.append(SEMICOLON).append(ParameterNamesIms.SESSION_CASE).append(EQUALS)
.append(this.getSessionCase());
return retval.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
public boolean equals(Object other)
{
if(other instanceof PServedUser)
{
final PServedUserHeader psu = (PServedUserHeader)other;
return this.getAddress().equals(((PServedUser) other).getAddress());
}
return false;
}
public Object clone() {
PServedUser retval = (PServedUser) super.clone();
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PServedUserHeader.java 0100644 0000000 0000000 00000004062 13513104763 022412 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
* The ABNF of the P-Served-User Header is as follows:
*
* P-Served-User = "P-Served-User" HCOLON PServedUser-value
* *(SEMI served-user-param)
* served-user-param = sessioncase-param
* / registration-state-param
* / generic-param
* PServedUser-value = name-addr / addr-spec
* sessioncase-param = "sescase" EQUAL "orig" / "term"
* registration-state-param = "regstate" EQUAL "unreg" / "reg"
*
* Eg: P-Served-User: ; sescase=orig; regstate=reg
*
*
*/
public interface PServedUserHeader {
public static final String NAME = "P-Served-User";
public void setSessionCase(String sessionCase);
public String getSessionCase();
public void setRegistrationState(String registrationState);
public String getRegistrationState();
}
java/gov/nist/javax/sip/header/ims/PUserDatabase.java 0100644 0000000 0000000 00000005624 13513104763 021562 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
*/
public class PUserDatabase extends gov.nist.javax.sip.header.ParametersHeader implements PUserDatabaseHeader,SIPHeaderNamesIms, ExtensionHeader{
private String databaseName;
/**
*
* @param databaseName
*/
public PUserDatabase(String databaseName)
{
super(NAME);
this.databaseName = databaseName;
}
/**
* Default constructor.
*/
public PUserDatabase() {
super(P_USER_DATABASE);
}
public String getDatabaseName() {
return this.databaseName;
}
public void setDatabaseName(String databaseName) {
if((databaseName==null)||(databaseName.equals(" ")))
throw new NullPointerException("Database name is null");
else
if(!databaseName.contains("aaa://"))
this.databaseName = new StringBuffer().append("aaa://").append(databaseName).toString();
else
this.databaseName = databaseName;
}
protected String encodeBody() {
StringBuffer retval = new StringBuffer();
retval.append("<");
if(getDatabaseName()!=null)
retval.append(getDatabaseName());
if (!parameters.isEmpty())
retval.append(SEMICOLON + this.parameters.encode());
retval.append(">");
return retval.toString();
}
public boolean equals(Object other)
{
return (other instanceof PUserDatabaseHeader) && super.equals(other);
}
public Object clone() {
PUserDatabase retval = (PUserDatabase) super.clone();
return retval;
}
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/PUserDatabaseHeader.java 0100644 0000000 0000000 00000004144 13513104763 022667 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.header.ims;
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
*
* @author aayush.bhatnagar
* Rancore Technologies Pvt Ltd, Mumbai India.
*
* This is the interface that exposes the behavior
* of the P-User-Database header. We only have one
* major value for this header, as per RFC 4457.
* This value is the Database name. The DB here refers
* to the IMS HSS. The DB name is encoded as a URI, delimited
* by the < and > signs. There may be generic parameters for
* this header encoded as URI parameters. They also lie between
* the < and > delimiters. However, this URI is neither a SIP URI
* nor a TEL URI. It is a DIAMETER AAA URI.The value of this AAA URI
* is consumed by the S-CSCF. The S-CSCF can cache the value of the
* HSS received in this header,thus optimizing the IMS registration
* process.
*
*/
public interface PUserDatabaseHeader extends Parameters,Header
{
public final static String NAME = "P-User-Database";
public String getDatabaseName();
public void setDatabaseName(String name);
}
java/gov/nist/javax/sip/header/ims/PVisitedNetworkID.java 0100644 0000000 0000000 00000010422 13513104763 022405 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import javax.sip.header.Parameters;
import gov.nist.core.Token;
/**
* P-Visited-Network-ID SIP Private Header: RFC 3455.
*
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class PVisitedNetworkID
extends gov.nist.javax.sip.header.ParametersHeader
implements PVisitedNetworkIDHeader, SIPHeaderNamesIms, ExtensionHeader {
/**
* visited Network ID
*/
private String networkID;
// issued by Miguel Freitas
private boolean isQuoted;
public PVisitedNetworkID() {
super(P_VISITED_NETWORK_ID);
}
public PVisitedNetworkID(String networkID) {
super(P_VISITED_NETWORK_ID);
setVisitedNetworkID(networkID);
}
public PVisitedNetworkID(Token tok) {
super(P_VISITED_NETWORK_ID);
setVisitedNetworkID(tok.getTokenValue());
}
protected String encodeBody() {
StringBuffer retval = new StringBuffer();
if (getVisitedNetworkID() != null)
{
// issued by Miguel Freitas
if (isQuoted)
retval.append(DOUBLE_QUOTE + getVisitedNetworkID() + DOUBLE_QUOTE);
else
retval.append(getVisitedNetworkID());
}
if (!parameters.isEmpty())
retval.append(SEMICOLON + this.parameters.encode());
return retval.toString();
}
/**
* Set the visited network ID as a string. The value will be quoted in the header.
* @param networkID - string value
*/
public void setVisitedNetworkID(String networkID) {
if (networkID == null)
throw new NullPointerException(" the networkID parameter is null");
this.networkID = networkID;
// issued by Miguel Freitas
this.isQuoted = true;
}
/**
* Set the visited network ID as a token
* @param networkID - token value
*/
public void setVisitedNetworkID(Token networkID) {
if (networkID == null)
throw new NullPointerException(" the networkID parameter is null");
this.networkID = networkID.getTokenValue();
// issued by Miguel Freitas
this.isQuoted = false;
}
/**
* Get the visited network ID value of this header
*/
public String getVisitedNetworkID() {
return networkID;
}
public void setValue(String value) throws ParseException {
throw new ParseException (value,0);
}
public boolean equals(Object other)
{
if (other instanceof PVisitedNetworkIDHeader)
{
PVisitedNetworkIDHeader o = (PVisitedNetworkIDHeader) other;
return (this.getVisitedNetworkID().equals( o.getVisitedNetworkID() )
&& this.equalParameters( (Parameters) o ));
}
return false;
}
public Object clone() {
PVisitedNetworkID retval = (PVisitedNetworkID) super.clone();
if (this.networkID != null)
retval.networkID = this.networkID;
retval.isQuoted = this.isQuoted;
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PVisitedNetworkIDHeader.java 0100644 0000000 0000000 00000007016 13513104763 023523 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.core.Token;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* P-Visited-Network-ID SIP Private Header: RFC 3455.
*
*
* -
* . One of the conditions for a home network to accept the registration of a UA roaming to a
* particular visited network, is the existence of a roaming agreement between the home and
* the visited network. There is a need to indicate to the home network which one is the visited
* network that is providing services to the roaming UA.
*
-
* . user agents always register to the home network. The REGISTER request is proxied by
* one or more proxies located in the visited network towards the home network
*
-
* . the visited network includes an identification that is known at the home network
*
-
* . This identification should be globally unique, and takes the form of a quoted text string or a token
*
-
* . In case a REGISTER or other request is traversing different administrative domains
* (e.g., different visited networks), a SIP proxy MAY insert a NEW P-Visited-Network-ID header
* if the request does not contain a P-Visited-Network-ID header with the same network
* identifier as its own network identifier
*
*
* Sintax:
*
*
* P-Visited-Network-ID = "P-Visited-Network-ID" HCOLON
* vnetwork-spec
* *(COMMA vnetwork-spec)
* vnetwork-spec = (token / quoted-string)
* *(SEMI vnetwork-param)
* vnetwork-param = generic-param
*
*
* eg: P-Visited-Network-ID: other.net, "Visited network number 1"
*
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public interface PVisitedNetworkIDHeader extends Parameters, Header {
/**
* Name of VisitedNetworkIDHeader
*/
public final static String NAME = "P-Visited-Network-ID";
/**
* Set the visited network ID as a string. The value will be quoted in the header.
* @param networkID - string value
*/
public void setVisitedNetworkID(String networkID);
/**
* Set the visited network ID as a token
* @param networkID - token value
*/
public void setVisitedNetworkID(Token networkID);
/**
* Get the visited network ID value of this header
*/
public String getVisitedNetworkID();
}
java/gov/nist/javax/sip/header/ims/PVisitedNetworkIDList.java 0100644 0000000 0000000 00000003567 13513104763 023255 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
import gov.nist.javax.sip.header.ims.PVisitedNetworkIDHeader;
/**
* List of P-Visited-Network-ID headers.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class PVisitedNetworkIDList extends SIPHeaderList {
private static final long serialVersionUID = -4346667490341752478L;
/** Default constructor
*/
public PVisitedNetworkIDList() {
super(PVisitedNetworkID.class, PVisitedNetworkIDHeader.NAME);
}
public Object clone() {
PVisitedNetworkIDList retval = new PVisitedNetworkIDList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/ParameterNamesIms.java 0100644 0000000 0000000 00000007501 13513104763 022450 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.address.ParameterNames;
/**
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public interface ParameterNamesIms extends ParameterNames {
public static final String IK = "ik";
public static final String CK = "ck";
public static final String INTEGRITY_PROTECTED = "integrity-protected";
public static final String CCF = "ccf";
public static final String ECF = "ecf";
public static final String ICID_VALUE = "icid-value";
public static final String ICID_GENERATED_AT = "icid-generated-at";
public static final String ORIG_IOI = "orig-ioi";
public static final String TERM_IOI = "term-ioi";
// issued by Miguel Freitas //
// P-Access-Network-ID
public static final String CGI_3GPP = "cgi-3gpp";
public static final String UTRAN_CELL_ID_3GPP = "utran-cell-id-3gpp";
public static final String DSL_LOCATION = "dsl-location";
public static final String CI_3GPP2 = "ci-3gpp2";
// P-Charging-Vector
public static final String GGSN = "ggsn";
public static final String PDP_INFO = "pdp-info";
public static final String PDP_ITEM = "pdp-item";
public static final String PDP_SIG = "pdp-sig";
public static final String GCID = "gcid";
public static final String AUTH_TOKEN = "auth-token";
public static final String FLOW_ID = "flow-id";
public static final String PDG = "pdg";
public static final String BRAS = "bras";
public static final String DSL_BEARER_INFO = "dsl-bearer-info";
public static final String DSL_BEARER_ITEM = "dsl-bearer-item";
public static final String DSL_BEARER_SIG = "dsl-bearer-sig";
// sec-agree (Security-Server, Security-Client, Security-Verify)
public static final String ALG = "alg";
public static final String EALG = "ealg";
public static final String Q = "q";
public static final String PROT = "prot";
public static final String MOD = "mod";
public static final String SPI_C = "spi-c";
public static final String SPI_S = "spi-s";
public static final String PORT_C = "port-c";
public static final String PORT_S = "port-s";
public static final String D_VER = "d-ver";
// end //
//added by aayush.bhatnagar(Ref: RFC 5502)
public static final String SESSION_CASE = "sescase";
public static final String REGISTRATION_STATE = "regstate";
//added by aayush.bhatnagar(Ref: draft-drage-sipping-service-identification-03)
public static final String SERVICE_ID = "urn:urn-7:";
public static final String SERVICE_ID_LABEL = "3gpp-service";
public static final String APPLICATION_ID_LABEL = "3gpp-application";
}
java/gov/nist/javax/sip/header/ims/Path.java 0100644 0000000 0000000 00000005130 13513104763 017763 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.address.AddressImpl;
import gov.nist.javax.sip.header.ims.PathHeader;
/**
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class Path
extends gov.nist.javax.sip.header.AddressParametersHeader
implements PathHeader, SIPHeaderNamesIms , ExtensionHeader{
/**
* constructor
* @param address address to set
*/
public Path(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* default constructor
*/
public Path()
{
// issued by Miguel Freitas
super(NAME);
}
/** Encode into canonical form.
*@return String containing the canonicaly encoded header.
*/
public String encodeBody() {
StringBuffer retval = new StringBuffer();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(LESS_THAN);
}
retval.append(address.encode());
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(GREATER_THAN);
}
if (!parameters.isEmpty())
retval.append(SEMICOLON + this.parameters.encode());
return retval.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/PathHeader.java 0100644 0000000 0000000 00000003224 13513104763 021076 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
/*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
/**
* PATH header SIP param: RFC 3327.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*
*/
public interface PathHeader extends HeaderAddress, Parameters, Header {
/**
* Name of PathHeader
*/
public final static String NAME = "Path";
}
java/gov/nist/javax/sip/header/ims/PathList.java 0100644 0000000 0000000 00000003147 13513104763 020625 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
/**
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class PathList extends SIPHeaderList {
/** Default constructor
*/
public PathList() {
super(Path.class, PathHeader.NAME);
}
public Object clone() {
PathList retval = new PathList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/Privacy.java 0100644 0000000 0000000 00000006524 13513104763 020514 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University - Portugal) *
*****************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import javax.sip.header.Parameters;
import gov.nist.core.NameValueList;
import gov.nist.javax.sip.header.SIPHeader;
/**
* Privacy SIP header - RFC 3323.
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class Privacy
extends SIPHeader
implements PrivacyHeader, SIPHeaderNamesIms, ExtensionHeader
{
/**
* Privacy type
*/
private String privacy;
/**
* Default constructor.
*/
public Privacy() {
super(PRIVACY);
}
/**
* Constructor given a privacy type
*@param privacy
*/
public Privacy(String privacy)
{
this();
this.privacy = privacy;
}
/**
* Encode into a canonical string.
* @return String.
*/
public String encodeBody()
{
return this.privacy;
}
/**
* Get privacy type
* @return privacy type
*/
public String getPrivacy()
{
return privacy;
}
/**
* set the privacy type.
* @param privacy -- privacy type to set.
*/
public void setPrivacy(String privacy) throws ParseException
{
if (privacy == null || privacy == "")
throw new NullPointerException(
"JAIN-SIP Exception, "
+ " Privacy, setPrivacy(), privacy value is null or empty");
this.privacy = privacy;
}
/**
* Suppress direct setting of values.
*
*/
public void setValue(String value) throws ParseException {
throw new ParseException(value,0);
}
public boolean equals(Object other)
{
if (other instanceof PrivacyHeader)
{
PrivacyHeader o = (PrivacyHeader) other;
return (this.getPrivacy().equals( o.getPrivacy() ));
}
return false;
}
public Object clone() {
Privacy retval = (Privacy) super.clone();
if (this.privacy != null)
retval.privacy = this.privacy;
return retval;
}
}
java/gov/nist/javax/sip/header/ims/PrivacyHeader.java 0100644 0000000 0000000 00000004232 13513104763 021617 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University - Portugal) *
*****************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* Privacy Header RFC 3323.
*
* Sintax:
*
* Privacy-hdr = "Privacy" HCOLON priv-value *(";" priv-value)
* priv-value = "header" / "session" / "user" /
* "id" / "none" / "critical" / token
* example:
* Privacy: id
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public interface PrivacyHeader extends Header
{
/**
* Name of PrivacyHeader
*/
public final static String NAME = "Privacy";
/**
* Set Privacy header value
* @param privacy -- privacy type to set.
*/
public void setPrivacy(String privacy) throws ParseException;
/**
* Get Privacy header value
* @return privacy token name
*/
public String getPrivacy();
}
java/gov/nist/javax/sip/header/ims/PrivacyList.java 0100644 0000000 0000000 00000003517 13513104763 021347 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*****************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Aveiro University - Portugal) *
*****************************************************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
/**
* List of Privacy headers.
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class PrivacyList extends SIPHeaderList {
private static final long serialVersionUID = 1798720509806307461L;
/**
* Default constructor
*/
public PrivacyList() {
super(Privacy.class, PrivacyHeader.NAME);
}
public Object clone() {
PrivacyList retval = new PrivacyList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/SIPHeaderNamesIms.java 0100644 0000000 0000000 00000006035 13513104763 022275 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
/**
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public interface SIPHeaderNamesIms
extends gov.nist.javax.sip.header.SIPHeaderNames {
public static final String PATH = PathHeader.NAME;
public static final String SERVICE_ROUTE = ServiceRouteHeader.NAME;
public static final String P_ASSERTED_IDENTITY = PAssertedIdentityHeader.NAME;
public static final String P_PREFERRED_IDENTITY = PPreferredIdentityHeader.NAME;
public static final String CALLED_PARTY_ID = PCalledPartyIDHeader.NAME;
public static final String P_VISITED_NETWORK_ID = PVisitedNetworkIDHeader.NAME;
public static final String P_CHARGING_FUNCTION_ADDRESSES = PChargingFunctionAddressesHeader.NAME;
public static final String P_CHARGING_VECTOR = PChargingVectorHeader.NAME;
// issued by Miguel Freitas
public static final String PRIVACY = PrivacyHeader.NAME;
public static final String P_ASSOCIATED_URI = PAssociatedURIHeader.NAME;
public static final String P_MEDIA_AUTHORIZATION = PMediaAuthorizationHeader.NAME;
public static final String P_ACCESS_NETWORK_INFO = PAccessNetworkInfoHeader.NAME;
public static final String SECURITY_SERVER = SecurityServerHeader.NAME;
public static final String SECURITY_CLIENT = SecurityClientHeader.NAME;
public static final String SECURITY_VERIFY = SecurityVerifyHeader.NAME;
//added by aayush
public static final String P_USER_DATABASE = PUserDatabaseHeader.NAME;
//added by aayush
public static final String P_PROFILE_KEY = PProfileKeyHeader.NAME;
//added by aayush
public static final String P_SERVED_USER = PServedUserHeader.NAME;
//added by aayush
public static final String P_PREFERRED_SERVICE = PPreferredServiceHeader.NAME;
//added by aayush
public static final String P_ASSERTED_SERVICE = PAssertedServiceHeader.NAME;
}
java/gov/nist/javax/sip/header/ims/SecurityAgree.java 0100644 0000000 0000000 00000025042 13513104763 021646 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import javax.sip.header.Parameters;
import gov.nist.core.NameValue;
import gov.nist.core.Separators;
import gov.nist.javax.sip.header.ims.ParameterNamesIms;
import gov.nist.javax.sip.header.ParametersHeader;
/**
* "Security Mechanism Agreemet for SIP Sessions"
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
* Headers: Security-Server + Security-Client + Security-Verify
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public abstract class SecurityAgree
extends ParametersHeader
{
//TODO serialVersionUID
//private static final long serialVersionUID = -6671234553927258745L;
//public static final String EALG = ParameterNamesIms.EALG;
// ...
/**
* Security Mechanism value
*/
private String secMechanism;
/**
* Constructor
* @param name - name of the Security Agree header to create
*/
public SecurityAgree(String name)
{
super(name);
parameters.setSeparator(Separators.SEMICOLON);
}
/**
* Default constructor
*/
public SecurityAgree()
{
super();
parameters.setSeparator(Separators.SEMICOLON);
}
public void setParameter(String name, String value) throws ParseException
{
if (value == null)
throw new NullPointerException("null value");
NameValue nv = super.parameters.getNameValue(name.toLowerCase());
if (nv == null)
{
nv = new NameValue(name, value);
// quoted values
if (name.equalsIgnoreCase(ParameterNamesIms.D_VER))
{
nv.setQuotedValue();
if (value.startsWith(Separators.DOUBLE_QUOTE))
throw new ParseException(value
+ " : Unexpected DOUBLE_QUOTE", 0);
}
super.setParameter(nv);
}
else
{
nv.setValueAsObject(value);
}
}
public String encodeBody()
{
return this.secMechanism + SEMICOLON + SP + parameters.encode();
}
/**
* Set security mechanism.
* eg: Security-Client: ipsec-3gpp
* @param secMech - security mechanism name
*/
public void setSecurityMechanism(String secMech) throws ParseException {
if (secMech == null)
throw new NullPointerException(
"JAIN-SIP "
+ "Exception, SecurityAgree, setSecurityMechanism(), the sec-mechanism parameter is null");
this.secMechanism = secMech;
}
/**
* Set Encryption Algorithm (ealg parameter)
* @param ealg - encryption algorithm value
* @throws ParseException
*/
public void setEncryptionAlgorithm(String ealg) throws ParseException {
if (ealg == null)
throw new NullPointerException(
"JAIN-SIP "
+ "Exception, SecurityClient, setEncryptionAlgorithm(), the encryption-algorithm parameter is null");
setParameter(ParameterNamesIms.EALG, ealg);
}
/**
* Set Algorithm (alg parameter)
* @param alg - algorithm value
* @throws ParseException
*/
public void setAlgorithm(String alg) throws ParseException {
if (alg == null)
throw new NullPointerException(
"JAIN-SIP "
+ "Exception, SecurityClient, setAlgorithm(), the algorithm parameter is null");
setParameter(ParameterNamesIms.ALG, alg);
}
/**
* Set Protocol (prot paramater)
* @param prot - protocol value
* @throws ParseException
*/
public void setProtocol(String prot) throws ParseException {
if (prot == null)
throw new NullPointerException(
"JAIN-SIP "
+ "Exception, SecurityClient, setProtocol(), the protocol parameter is null");
setParameter(ParameterNamesIms.PROT, prot);
}
/**
* Set Mode (mod parameter)
* @param mod - mode value
* @throws ParseException
*/
public void setMode(String mod) throws ParseException {
if (mod == null)
throw new NullPointerException(
"JAIN-SIP "
+ "Exception, SecurityClient, setMode(), the mode parameter is null");
setParameter(ParameterNamesIms.MOD, mod);
}
/**
* Set Client SPI (spi-c parameter)
* @param spic - spi-c value
* @throws InvalidArgumentException
*/
public void setSPIClient(int spic) throws InvalidArgumentException {
if (spic < 0)
throw new InvalidArgumentException(
"JAIN-SIP "
+ "Exception, SecurityClient, setSPIClient(), the spi-c parameter is <0");
setParameter(ParameterNamesIms.SPI_C, spic);
}
/**
* Set Server SPI (spi-s parameter)
* @param spis - spi-s value
* @throws InvalidArgumentException - when value is not valid
*/
public void setSPIServer(int spis) throws InvalidArgumentException {
if (spis < 0)
throw new InvalidArgumentException(
"JAIN-SIP "
+ "Exception, SecurityClient, setSPIServer(), the spi-s parameter is <0");
setParameter(ParameterNamesIms.SPI_S, spis);
}
/**
* Set Client Port (port-c parameter)
* @param portC - port-c value
* @throws InvalidArgumentException - when value is not valid
*/
public void setPortClient(int portC) throws InvalidArgumentException {
if (portC < 0)
throw new InvalidArgumentException(
"JAIN-SIP "
+ "Exception, SecurityClient, setPortClient(), the port-c parameter is <0");
setParameter(ParameterNamesIms.PORT_C, portC);
}
/**
* Set Server Port (port-s parameter)
* @param portS - port-s value
* @throws InvalidArgumentException - when value is not valid
*/
public void setPortServer(int portS) throws InvalidArgumentException {
if (portS < 0)
throw new InvalidArgumentException(
"JAIN-SIP "
+ "Exception, SecurityClient, setPortServer(), the port-s parameter is <0");
setParameter(ParameterNamesIms.PORT_S, portS);
}
/**
* Set Preference.
* The "q" parameter indicates a relative preference for the particular mechanism.
* The higher the value the more preferred the mechanism is.
* Range from 0.001 to 0.999.
* @param q - q parameter value
* @throws InvalidArgumentException - when value is not valid
*/
public void setPreference(float q) throws InvalidArgumentException {
if (q < 0.0f)
throw new InvalidArgumentException(
"JAIN-SIP "
+ "Exception, SecurityClient, setPreference(), the preference (q) parameter is <0");
setParameter(ParameterNamesIms.Q, q);
}
// get param
/**
* Get Security Mechanism
* @return security mechanims value
*/
public String getSecurityMechanism() {
return this.secMechanism;
}
/**
* Get Encryption Algorithm
* @return ealg parameter value
*/
public String getEncryptionAlgorithm() {
return getParameter(ParameterNamesIms.EALG);
}
/**
* Get Algorithm
* @return alg parameter value
*/
public String getAlgorithm() {
return getParameter(ParameterNamesIms.ALG);
}
/**
* Get Protocol
* @return prot parameter value
*/
public String getProtocol() {
return getParameter(ParameterNamesIms.PROT);
}
/**
* Get Mode
* @return mod parameter value
*/
public String getMode() {
return getParameter(ParameterNamesIms.MOD);
}
/**
* Get Client SPI
* @return spi-c parameter value
*/
public int getSPIClient() {
return (Integer.parseInt(getParameter(ParameterNamesIms.SPI_C)));
}
/**
* Get Server SPI
* @return spi-s parameter value
*/
public int getSPIServer() {
return (Integer.parseInt(getParameter(ParameterNamesIms.SPI_S)));
}
/**
* Get Client Port
* @return port-c parameter value
*/
public int getPortClient() {
return (Integer.parseInt(getParameter(ParameterNamesIms.PORT_C)));
}
/**
* Get Server Port
* @return port-s parameter value
*/
public int getPortServer() {
return (Integer.parseInt(getParameter(ParameterNamesIms.PORT_S)));
}
/**
* Get Preference
* @return q parameter value
*/
public float getPreference() {
return (Float.parseFloat(getParameter(ParameterNamesIms.Q)));
}
public boolean equals(Object other)
{
if(other instanceof SecurityAgreeHeader)
{
SecurityAgreeHeader o = (SecurityAgreeHeader) other;
return (this.getSecurityMechanism().equals( o.getSecurityMechanism() )
&& this.equalParameters( (Parameters) o ));
}
return false;
}
public Object clone() {
SecurityAgree retval = (SecurityAgree) super.clone();
if (this.secMechanism != null)
retval.secMechanism = this.secMechanism;
return retval;
}
}
java/gov/nist/javax/sip/header/ims/SecurityAgreeHeader.java 0100644 0000000 0000000 00000011673 13513104763 022764 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* "Security Mechanism Agreemet for SIP Sessions"
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
* Headers: Security-Server + Security-Client + Security-Verify
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public interface SecurityAgreeHeader extends Parameters, Header
{
/**
* Set security mechanism.
* eg: Security-Client: ipsec-3gpp
* @param secMech - security mechanism name
*/
public void setSecurityMechanism(String secMech) throws ParseException;
/**
* Set Encryption Algorithm (ealg parameter)
* @param ealg - encryption algorithm value
* @throws ParseException
*/
public void setEncryptionAlgorithm(String ealg) throws ParseException;
/**
* Set Algorithm (alg parameter)
* @param alg - algorithm value
* @throws ParseException
*/
public void setAlgorithm(String alg) throws ParseException;
/**
* Set Protocol (prot paramater)
* @param prot - protocol value
* @throws ParseException
*/
public void setProtocol(String prot) throws ParseException;
/**
* Set Mode (mod parameter)
* @param mod - mode value
* @throws ParseException
*/
public void setMode(String mod) throws ParseException;
/**
* Set Client SPI (spi-c parameter)
* @param spic - spi-c value
* @throws InvalidArgumentException
*/
public void setSPIClient(int spic) throws InvalidArgumentException;
/**
* Set Server SPI (spi-s parameter)
* @param spis - spi-s value
* @throws InvalidArgumentException - when value is not valid
*/
public void setSPIServer(int spis) throws InvalidArgumentException;
/**
* Set Client Port (port-c parameter)
* @param portC - port-c value
* @throws InvalidArgumentException - when value is not valid
*/
public void setPortClient(int portC) throws InvalidArgumentException;
/**
* Set Server Port (port-s parameter)
* @param portS - port-s value
* @throws InvalidArgumentException - when value is not valid
*/
public void setPortServer(int portS) throws InvalidArgumentException;
/**
* Set Preference
* @param q - q parameter value
* @throws InvalidArgumentException - when value is not valid
*/
public void setPreference(float q) throws InvalidArgumentException;
/**
* Get Security Mechanism
* @return security mechanims value
*/
public String getSecurityMechanism();
/**
* Get Encryption Algorithm
* @return ealg parameter value
*/
public String getEncryptionAlgorithm();
/**
* Get Algorithm
* @return alg parameter value
*/
public String getAlgorithm();
/**
* Get Protocol
* @return prot parameter value
*/
public String getProtocol();
/**
* Get Mode
* @return mod parameter value
*/
public String getMode();
/**
* Get Client SPI
* @return spi-c parameter value
*/
public int getSPIClient();
/**
* Get Server SPI
* @return spi-s parameter value
*/
public int getSPIServer();
/**
* Get Client Port
* @return port-c parameter value
*/
public int getPortClient();
/**
* Get Server Port
* @return port-s parameter value
*/
public int getPortServer();
/**
* Get Preference
* @return q parameter value
*/
public float getPreference();
}
java/gov/nist/javax/sip/header/ims/SecurityClient.java 0100644 0000000 0000000 00000003756 13513104763 022051 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import javax.sip.header.ExtensionHeader;
/**
* Security-Client header
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class SecurityClient
extends SecurityAgree
implements SecurityClientHeader, ExtensionHeader
{
// TODO serialVersionUID
public SecurityClient()
{
super(SecurityClientHeader.NAME);
}
public void setValue(String value) throws ParseException
{
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/SecurityClientHeader.java 0100644 0000000 0000000 00000003311 13513104763 023145 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
/**
* Security-Client header
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public interface SecurityClientHeader extends SecurityServerHeader
{
/**
* Name of SecurityClientHeader
*/
public final static String NAME = "Security-Client";
}
java/gov/nist/javax/sip/header/ims/SecurityClientList.java 0100644 0000000 0000000 00000003736 13513104763 022703 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
import gov.nist.javax.sip.header.ims.SecurityClient;
/**
* List of Security-Client headers.
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class SecurityClientList extends SIPHeaderList
{
private static final long serialVersionUID = 3094231003329176217L;
public SecurityClientList()
{
super(SecurityClient.class, SecurityClientHeader.NAME);
}
public Object clone() {
SecurityClientList retval = new SecurityClientList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/SecurityServer.java 0100644 0000000 0000000 00000003702 13513104763 022070 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
/**
* Security-Server header
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class SecurityServer
extends SecurityAgree
implements SecurityServerHeader, ExtensionHeader
{
// TODO serialVersionUID
public SecurityServer()
{
super(SecurityServerHeader.NAME);
}
public void setValue(String value) throws ParseException
{
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/SecurityServerHeader.java 0100644 0000000 0000000 00000003534 13513104763 023204 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.InvalidArgumentException;
import javax.sip.header.Header;
import javax.sip.header.Parameters;
/**
* Security-Server header
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public interface SecurityServerHeader extends SecurityAgreeHeader
{
/**
* Name of SecurityServerHeader
*/
public final static String NAME = "Security-Server";
}
java/gov/nist/javax/sip/header/ims/SecurityServerList.java 0100644 0000000 0000000 00000003752 13513104763 022731 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
import gov.nist.javax.sip.header.ims.SecurityServer;
/**
* List of Security-Server headers.
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class SecurityServerList extends SIPHeaderList
{
private static final long serialVersionUID = -1392066520803180238L;
public SecurityServerList()
{
super(SecurityServer.class, SecurityServerHeader.NAME);
}
public Object clone() {
SecurityServerList retval = new SecurityServerList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/SecurityVerify.java 0100644 0000000 0000000 00000003702 13513104763 022066 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
/**
* Security-Verify header
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class SecurityVerify
extends SecurityAgree
implements SecurityVerifyHeader, ExtensionHeader
{
// TODO serialVersionUID
public SecurityVerify()
{
super(SecurityVerifyHeader.NAME);
}
public void setValue(String value) throws ParseException
{
throw new ParseException(value,0);
}
}
java/gov/nist/javax/sip/header/ims/SecurityVerifyHeader.java 0100644 0000000 0000000 00000003311 13513104763 023173 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement.
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
/**
* Security-Verify header
* - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public interface SecurityVerifyHeader extends SecurityAgreeHeader
{
/**
* Name of SecurityVerifyHeader
*/
public final static String NAME = "Security-Verify";
}
java/gov/nist/javax/sip/header/ims/SecurityVerifyList.java 0100644 0000000 0000000 00000003753 13513104763 022730 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government,
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/************************************************************************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT and Telecommunications Institute (Aveiro, Portugal) *
************************************************************************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
import gov.nist.javax.sip.header.ims.SecurityVerify;
/**
* List of Security-Verify headers.
*
*
*
* @author Miguel Freitas (IT) PT-Inovacao
*/
public class SecurityVerifyList extends SIPHeaderList
{
private static final long serialVersionUID = 563201040577795125L;
public SecurityVerifyList()
{
super(SecurityVerify.class, SecurityVerifyHeader.NAME);
}
public Object clone() {
SecurityVerifyList retval = new SecurityVerifyList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/ServiceRoute.java 0100644 0000000 0000000 00000005134 13513104763 021512 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.ExtensionHeader;
import gov.nist.javax.sip.address.AddressImpl;
/**
* SERVICE-ROUTE header SIP param: RFC 3608.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class ServiceRoute
extends gov.nist.javax.sip.header.AddressParametersHeader
implements ServiceRouteHeader, SIPHeaderNamesIms, ExtensionHeader {
/**
* constructor
* @param address address to set
*/
public ServiceRoute(AddressImpl address) {
super(NAME);
this.address = address;
}
/**
* default constructor
*/
public ServiceRoute() {
super(SERVICE_ROUTE);
}
/** Encode into canonical form.
*@return String containing the canonicaly encoded header.
*/
public String encodeBody() {
StringBuffer retval = new StringBuffer();
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(LESS_THAN);
}
retval.append(address.encode());
if (address.getAddressType() == AddressImpl.ADDRESS_SPEC) {
retval.append(GREATER_THAN);
}
if (!parameters.isEmpty())
retval.append(SEMICOLON + this.parameters.encode());
return retval.toString();
}
public void setValue(String value) throws ParseException {
throw new ParseException (value,0);
}
}
java/gov/nist/javax/sip/header/ims/ServiceRouteHeader.java 0100644 0000000 0000000 00000003161 13513104763 022621 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import javax.sip.header.Header;
import javax.sip.header.HeaderAddress;
import javax.sip.header.Parameters;
/**
* SERVICE-ROUTE header SIP param: RFC 3608.
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public interface ServiceRouteHeader extends HeaderAddress, Parameters, Header {
/**
* Name of ServiceRouteHeader
*/
public final static String NAME = "Service-Route";
}
java/gov/nist/javax/sip/header/ims/ServiceRouteList.java 0100644 0000000 0000000 00000003350 13513104763 022344 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import gov.nist.javax.sip.header.SIPHeaderList;
/**
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public class ServiceRouteList extends SIPHeaderList {
private static final long serialVersionUID = -4264811439080938519L;
/** Default constructor
*/
public ServiceRouteList() {
super(ServiceRoute.class, ServiceRouteHeader.NAME);
}
public Object clone() {
ServiceRouteList retval = new ServiceRouteList();
return retval.clonehlist(this.hlist);
}
}
java/gov/nist/javax/sip/header/ims/WWWAuthenticateHeaderIms.java 0100644 0000000 0000000 00000004371 13513104763 023702 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import javax.sip.header.WWWAuthenticateHeader;
/**
* Extension to WWW-authenticate header (3GPP TS 24229-5d0).
*
* Defines a new authentication parameter (auth-param) for the WWW-Authenticate header
* used in a 401 (Unauthorized) response to the REGISTER request.
* For more information, see RFC 2617 [21] subclause 3.2.1.
*
*
* auth-param = 1#( integrity-key / cipher-key )
* integrity-key = "ik" EQUAL ik-value
* cipher-key = "ck" EQUAL ck-value
* ik-value = LDQUOT *(HEXDIG) RDQUOT
* ck-value = LDQUOT *(HEXDIG) RDQUOT
*
*
* @author ALEXANDRE MIGUEL SILVA SANTOS - Nú 10045401
*/
public interface WWWAuthenticateHeaderIms extends WWWAuthenticateHeader
{
// issued by Miguel Freitas
public static final String IK = ParameterNamesIms.IK;
public static final String CK = ParameterNamesIms.CK;
public void setIK(String ik) throws ParseException;
public String getIK();
public void setCK(String ck) throws ParseException;
public String getCK();
}
java/gov/nist/javax/sip/header/ims/package.html 0100644 0000000 0000000 00000000771 13513104763 020513 0 ustar 00 0000000 0000000
NIST-SIP Specific support for IMS headers contributed by Jose Miguel
Freitas (Aveiro University, Portugal) and Alexandre Miguel Silva
Santos (PT Inovacau, Portugal). It is not part of the JAIN-SIP 1.2
specification. Questions about the IMS Support in NIST-SIP 1.2 can be
directed to Miguel Feitas or the NIST-SIP mailing
list. To acccess these headers you have to cast the HeaderFactory to
HeaderFactoryImpl. This package has been contributed to the public
domain.
java/gov/nist/javax/sip/header/package.html 0100644 0000000 0000000 00000000217 13513104763 017716 0 ustar 00 0000000 0000000
Contains implementations of the SIP headers as defined in JAIN-SIP 1.2 and
an implementation of the JAIN-SIP header factory.
java/gov/nist/javax/sip/message/ 0040755 0000000 0000000 00000000000 13513104763 015634 5 ustar 00 0000000 0000000 java/gov/nist/javax/sip/message/Content.java 0100644 0000000 0000000 00000001074 13513104763 020110 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import javax.sip.header.ContentDispositionHeader;
import javax.sip.header.ContentTypeHeader;
public interface Content {
public abstract void setContent(Object content);
public abstract Object getContent();
public abstract ContentTypeHeader getContentTypeHeader();
public abstract ContentDispositionHeader getContentDispositionHeader();
/**
* The default packing method. This packs the content to be appended to the
* sip message.
*
*/
public abstract String toString();
}
java/gov/nist/javax/sip/message/ContentImpl.java 0100644 0000000 0000000 00000004712 13513104763 020734 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import java.text.ParseException;
import javax.sip.header.ContentDispositionHeader;
import javax.sip.header.ContentTypeHeader;
public class ContentImpl implements Content {
/*
* The content type header for this chunk of content.
*/
private Object content;
private String boundary;
private ContentTypeHeader contentTypeHeader;
private ContentDispositionHeader contentDispositionHeader;
public ContentImpl( String content, String boundary ) {
this.content = content;
this.boundary = boundary;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.message.ContentExt#setContent(java.lang.String)
*/
public void setContent(Object content) {
this.content = content;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.message.ContentExt#getContentTypeHeader()
*/
public ContentTypeHeader getContentTypeHeader() {
return contentTypeHeader;
}
/*
* (non-Javadoc)
* @see gov.nist.javax.sip.message.Content#getContent()
*/
public Object getContent() {
return this.content;
}
/* (non-Javadoc)
* @see gov.nist.javax.sip.message.ContentExt#toString()
*/
public String toString() {
// This is not part of a multipart message.
if (boundary == null) {
return content.toString();
} else {
if ( this.contentDispositionHeader != null ) {
return "--" + boundary + "\r\n" + getContentTypeHeader() +
this.getContentDispositionHeader().toString() + "\r\n"
+ content.toString();
} else {
return "--" + boundary + "\r\n" + getContentTypeHeader() + "\r\n" + content.toString();
}
}
}
/**
* @param contentDispositionHeader the contentDispositionHeader to set
*/
public void setContentDispositionHeader(ContentDispositionHeader contentDispositionHeader) {
this.contentDispositionHeader = contentDispositionHeader;
}
/**
* @return the contentDispositionHeader
*/
public ContentDispositionHeader getContentDispositionHeader() {
return contentDispositionHeader;
}
/**
* @param contentTypeHeader the contentTypeHeader to set
*/
public void setContentTypeHeader(ContentTypeHeader contentTypeHeader) {
this.contentTypeHeader = contentTypeHeader;
}
}
java/gov/nist/javax/sip/message/HeaderIterator.java 0100644 0000000 0000000 00000005710 13513104763 021401 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
package gov.nist.javax.sip.message;
import gov.nist.javax.sip.header.*;
import java.util.ListIterator;
import java.util.NoSuchElementException;
/**
* Iterator over lists of headers. Allows for uniform removal handling for singleton headers.
* @author M. Ranganathan
* @version 1.2 $Revision: 1.8 $ $Date: 2009/07/17 18:57:53 $
* @since 1.1
*/
public class HeaderIterator implements ListIterator {
private boolean toRemove;
private int index;
private SIPMessage sipMessage;
private SIPHeader sipHeader;
protected HeaderIterator(SIPMessage sipMessage, SIPHeader sipHeader) {
this.sipMessage = sipMessage;
this.sipHeader = sipHeader;
}
public Object next() throws NoSuchElementException {
if (sipHeader == null || index == 1)
throw new NoSuchElementException();
toRemove = true;
index = 1;
return (Object) sipHeader;
}
public Object previous() throws NoSuchElementException {
if (sipHeader == null || index == 0)
throw new NoSuchElementException();
toRemove = true;
index = 0;
return (Object) sipHeader;
}
public int nextIndex() {
return 1;
}
public int previousIndex() {
return index == 0 ? -1 : 0;
}
public void set(Object header) {
throw new UnsupportedOperationException();
}
public void add(Object header) {
throw new UnsupportedOperationException();
}
public void remove() throws IllegalStateException {
if (this.sipHeader == null)
throw new IllegalStateException();
if (toRemove) {
this.sipHeader = null;
this.sipMessage.removeHeader(sipHeader.getName());
} else {
throw new IllegalStateException();
}
}
public boolean hasNext() {
return index == 0;
}
public boolean hasPrevious() {
return index == 1;
}
}
java/gov/nist/javax/sip/message/ListMap.java 0100644 0000000 0000000 00000014675 13513104763 020062 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD) *
*******************************************************************************/
package gov.nist.javax.sip.message;
import gov.nist.javax.sip.header.*;
import gov.nist.javax.sip.header.ims.*;
import java.util.Hashtable;
/**
* A map of which of the standard headers may appear as a list
*
* @version 1.2 $Revision: 1.14 $ $Date: 2009/07/17 18:57:53 $
* @since 1.1
*/
class ListMap {
// A table that indicates whether a header has a list representation or
// not (to catch adding of the non-list form when a list exists.)
// Entries in this table allow you to look up the list form of a header
// (provided it has a list form). Note that under JAVA-5 we have
// typed collections which would render such a list obsolete. However,
// we are not using java 5.
private static Hashtable,Class> headerListTable;
private static boolean initialized;
static {
initializeListMap();
}
static private void initializeListMap() {
/*
* Build a table mapping between objects that have a list form and the
* class of such objects.
*/
headerListTable = new Hashtable, Class>();
headerListTable.put(ExtensionHeaderImpl.class, ExtensionHeaderList.class);
headerListTable.put(Contact.class, ContactList.class);
headerListTable.put(ContentEncoding.class, ContentEncodingList.class);
headerListTable.put(Via.class, ViaList.class);
headerListTable.put(WWWAuthenticate.class, WWWAuthenticateList.class);
headerListTable.put(Accept.class, AcceptList.class);
headerListTable.put(AcceptEncoding.class, AcceptEncodingList.class);
headerListTable.put(AcceptLanguage.class, AcceptLanguageList.class);
headerListTable.put(ProxyRequire.class, ProxyRequireList.class);
headerListTable.put(Route.class, RouteList.class);
headerListTable.put(Require.class, RequireList.class);
headerListTable.put(Warning.class, WarningList.class);
headerListTable.put(Unsupported.class, UnsupportedList.class);
headerListTable.put(AlertInfo.class, AlertInfoList.class);
headerListTable.put(CallInfo.class, CallInfoList.class);
headerListTable.put(ProxyAuthenticate.class,ProxyAuthenticateList.class);
headerListTable.put(ProxyAuthorization.class, ProxyAuthorizationList.class);
headerListTable.put(Authorization.class, AuthorizationList.class);
headerListTable.put(Allow.class, AllowList.class);
headerListTable.put(RecordRoute.class, RecordRouteList.class);
headerListTable.put(ContentLanguage.class, ContentLanguageList.class);
headerListTable.put(ErrorInfo.class, ErrorInfoList.class);
headerListTable.put(Supported.class, SupportedList.class);
headerListTable.put(InReplyTo.class,InReplyToList.class);
// IMS headers.
headerListTable.put(PAssociatedURI.class, PAssociatedURIList.class);
headerListTable.put(PMediaAuthorization.class, PMediaAuthorizationList.class);
headerListTable.put(Path.class, PathList.class);
headerListTable.put(Privacy.class,PrivacyList.class);
headerListTable.put(ServiceRoute.class, ServiceRouteList.class);
headerListTable.put(PVisitedNetworkID.class, PVisitedNetworkIDList.class);
headerListTable.put(SecurityClient.class, SecurityClientList.class);
headerListTable.put(SecurityServer.class, SecurityServerList.class);
headerListTable.put(SecurityVerify.class, SecurityVerifyList.class);
headerListTable.put(PAssertedIdentity.class, PAssertedIdentityList.class);
initialized = true;
}
/**
* return true if this has an associated list object.
*/
static protected boolean hasList(SIPHeader sipHeader) {
if (sipHeader instanceof SIPHeaderList)
return false;
else {
Class headerClass = sipHeader.getClass();
return headerListTable.get(headerClass) != null;
}
}
/**
* Return true if this has an associated list object.
*/
static protected boolean hasList(Class sipHdrClass) {
if (!initialized)
initializeListMap();
return headerListTable.get(sipHdrClass) != null;
}
/**
* Get the associated list class.
*/
static protected Class getListClass(Class sipHdrClass) {
if (!initialized)
initializeListMap();
return (Class) headerListTable.get(sipHdrClass);
}
/**
* Return a list object for this header if it has an associated list object.
*/
@SuppressWarnings("unchecked")
static protected SIPHeaderList getList(SIPHeader sipHeader) {
if (!initialized)
initializeListMap();
try {
Class headerClass = sipHeader.getClass();
Class listClass = headerListTable.get(headerClass);
SIPHeaderList shl = (SIPHeaderList) listClass.newInstance();
shl.setHeaderName(sipHeader.getName());
return shl;
} catch (InstantiationException ex) {
ex.printStackTrace();
} catch (IllegalAccessException ex) {
ex.printStackTrace();
}
return null;
}
}
java/gov/nist/javax/sip/message/MessageExt.java 0100644 0000000 0000000 00000006237 13513104763 020551 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import java.text.ParseException;
import javax.sip.header.CSeqHeader;
import javax.sip.header.CallIdHeader;
import javax.sip.header.ContentLengthHeader;
import javax.sip.header.ContentTypeHeader;
import javax.sip.header.FromHeader;
import javax.sip.header.ToHeader;
import javax.sip.header.ViaHeader;
import javax.sip.message.Message;
/**
*
* @author jean.deruelle@gmail.com
*
*/
public interface MessageExt extends Message {
/**
* This method allows applications to associate application context with
* the message. This specification does not define the format of this
* data, this the responsibility of the application and is dependent
* on the application.
* this application data is un-interpreted by the stack.
* Beware : when you clone a message, the deepcopy does not apply to the application data
* (instead, we would just make a copy of the pointer).
*
* @param applicationData - un-interpreted application data.
* @since v2.0
*
*/
public void setApplicationData (Object applicationData);
/**
* Returns the application data associated with the transaction.This
* specification does not define the format of this application specific
* data. This is the responsibility of the application.
*
* @return application data associated with the message by the application.
* @since v2.0
*
*/
public Object getApplicationData();
/**
* Get the multipart mime content from a message. Builds a wrapper around the
* content and breaks it into multiple sections. Returns these sections as
* a multipart mime content list. If the content type is not multipart mime
* then the list will have a single element in it.
*
* @since v2.0
* @param Message message
* @throws ParseException if the content type is multipart mime but the content
* is not properly encoded.
*
*/
public MultipartMimeContent getMultipartMimeContent() throws ParseException;
/**
* Get the topmost Via header.
*
* @since v2.0
*/
public ViaHeader getTopmostViaHeader();
/**
* Get the From header or null if none present.
*
* @since v2.0
*/
public FromHeader getFromHeader();
/**
* Get the To header or null if none present.
*
* @since v2.0
*/
public ToHeader getToHeader();
/**
* Get the callId header or null if none present.
*
* @since v2.0
*/
public CallIdHeader getCallIdHeader();
/**
* Get the CSeq header or null if none present.
*
* @since v2.0
*/
public CSeqHeader getCSeqHeader();
/**
* Get the content type header or null if none present.
*
* @since v2.0
*/
public ContentTypeHeader getContentTypeHeader();
/**
* Get the content length header or null if none present.
*
* @since v2.0
*/
public ContentLengthHeader getContentLengthHeader();
/**
* Get the first line of the request or response.
*
* @since v2.0
*/
public String getFirstLine();
}
java/gov/nist/javax/sip/message/MessageFactoryExt.java 0100644 0000000 0000000 00000004213 13513104763 022071 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import javax.sip.header.ContentTypeHeader;
import javax.sip.header.ServerHeader;
import javax.sip.header.UserAgentHeader;
import javax.sip.message.MessageFactory;
/**
* Intefaces that will be supported by the next release of JAIN-SIP.
*
* @author mranga
*
*/
public interface MessageFactoryExt extends MessageFactory {
/**
* Set the common UserAgent header for all Requests created from this message factory.
* This header is applied to all Messages created from this Factory object except those
* that take String for an argument and create Message from the given String.
*
* @param userAgent -- the user agent header to set.
*
*/
public void setDefaultUserAgentHeader(UserAgentHeader userAgent);
/**
* Set the common Server header for all Responses created from this message factory.
* This header is applied to all Messages created from this Factory object except those
* that take String for an argument and create Message from the given String.
*
* @param userAgent -- the user agent header to set.
*
* @since 2.0
*
*/
public void setDefaultServerHeader(ServerHeader userAgent);
/**
* Set default charset used for encoding String content. Note that this
* will be applied to all content that is encoded. The default is UTF-8.
*
* @since 2.0
*
* @param charset -- charset to set.
* @throws NullPointerException if null arg
* @throws IllegalArgumentException if Charset is not a known charset.
*
*/
public void setDefaultContentEncodingCharset(String charset)
throws NullPointerException,IllegalArgumentException ;
/**
* Create a MultipartMime attachment from a list of content type, subtype and content.
*
* @since 2.0
*
* @throws NullPointerException, IllegalArgumentException
*/
public MultipartMimeContent createMultipartMimeContent(ContentTypeHeader multipartMimeContentTypeHeader,
String[] contentType,
String[] contentSubtype,
String[] contentBody);
}
java/gov/nist/javax/sip/message/MessageFactoryImpl.java 0100644 0000000 0000000 00000103064 13513104763 022236 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). *
*******************************************************************************/
package gov.nist.javax.sip.message;
import java.text.ParseException;
import javax.sip.header.*;
import java.util.LinkedList;
import java.util.List;
import gov.nist.javax.sip.header.*;
import javax.sip.message.*;
import javax.sip.address.*;
import gov.nist.javax.sip.parser.*;
/**
* Message Factory implementation
*
* @version 1.2 $Revision: 1.23 $ $Date: 2009/09/08 01:58:40 $
* @since 1.1
*
* @author M. Ranganathan
* @author Olivier Deruelle
*
*/
@SuppressWarnings("unchecked")
public class MessageFactoryImpl implements MessageFactory, MessageFactoryExt {
private boolean testing = false;
private boolean strict = true;
private static String defaultContentEncodingCharset = "UTF-8";
/*
* The UserAgent header to include for all requests created from this message factory.
*/
private static UserAgentHeader userAgent;
/*
* The Server header to include
*/
private static ServerHeader server;
public void setStrict(boolean strict) {
this.strict = strict;
}
/**
* This is for testing -- allows you to generate invalid requests
*/
public void setTest(boolean flag) {
this.testing = flag;
}
/**
* Creates a new instance of MessageFactoryImpl
*/
public MessageFactoryImpl() {
}
/**
* Creates a new Request message of type specified by the method paramater,
* containing the URI of the Request, the mandatory headers of the message
* with a body in the form of a Java object and the body content type.
*
* @param requestURI -
* the new URI object of the requestURI value of this Message.
* @param method -
* the new string of the method value of this Message.
* @param callId -
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq -
* the new CSeqHeader object of the cSeq value of this Message.
* @param from -
* the new FromHeader object of the from value of this Message.
* @param to -
* the new ToHeader object of the to value of this Message.
* @param via -
* the new List object of the ViaHeaders of this Message.
* @param content -
* the new Object of the body content value of this Message.
* @param contentType -
* the new ContentTypeHeader object of the content type value of
* this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the method or the body.
*/
public Request createRequest(javax.sip.address.URI requestURI,
String method, CallIdHeader callId, CSeqHeader cSeq,
FromHeader from, ToHeader to, List via,
MaxForwardsHeader maxForwards, ContentTypeHeader contentType,
Object content) throws ParseException {
if (requestURI == null || method == null || callId == null
|| cSeq == null || from == null || to == null || via == null
|| maxForwards == null || content == null
|| contentType == null)
throw new NullPointerException("Null parameters");
SIPRequest sipRequest = new SIPRequest();
sipRequest.setRequestURI(requestURI);
sipRequest.setMethod(method);
sipRequest.setCallId(callId);
sipRequest.setCSeq(cSeq);
sipRequest.setFrom(from);
sipRequest.setTo(to);
sipRequest.setVia(via);
sipRequest.setMaxForwards(maxForwards);
sipRequest.setContent(content, contentType);
if ( userAgent != null ) {
sipRequest.setHeader(userAgent);
}
return sipRequest;
}
/**
* Creates a new Request message of type specified by the method paramater,
* containing the URI of the Request, the mandatory headers of the message
* with a body in the form of a byte array and body content type.
*
* @param requestURI -
* the new URI object of the requestURI value of this Message.
* @param method -
* the new string of the method value of this Message.
* @param callId -
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq -
* the new CSeqHeader object of the cSeq value of this Message.
* @param from -
* the new FromHeader object of the from value of this Message.
* @param to -
* the new ToHeader object of the to value of this Message.
* @param via -
* the new List object of the ViaHeaders of this Message.
* @param content -
* the new byte array of the body content value of this Message.
* @param contentType -
* the new ContentTypeHeader object of the content type value of
* this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the method or the body.
*/
public Request createRequest(URI requestURI, String method,
CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to,
List via, MaxForwardsHeader maxForwards, byte[] content,
ContentTypeHeader contentType) throws ParseException {
if (requestURI == null || method == null || callId == null
|| cSeq == null || from == null || to == null || via == null
|| maxForwards == null || content == null
|| contentType == null)
throw new ParseException(
"JAIN-SIP Exception, some parameters are missing"
+ ", unable to create the request", 0);
SIPRequest sipRequest = new SIPRequest();
sipRequest.setRequestURI(requestURI);
sipRequest.setMethod(method);
sipRequest.setCallId(callId);
sipRequest.setCSeq(cSeq);
sipRequest.setFrom(from);
sipRequest.setTo(to);
sipRequest.setVia(via);
sipRequest.setMaxForwards(maxForwards);
sipRequest.setHeader((ContentType) contentType);
sipRequest.setMessageContent(content);
if ( userAgent != null ) {
sipRequest.setHeader(userAgent);
}
return sipRequest;
}
/**
* Creates a new Request message of type specified by the method paramater,
* containing the URI of the Request, the mandatory headers of the message.
* This new Request does not contain a body.
*
* @param requestURI -
* the new URI object of the requestURI value of this Message.
* @param method -
* the new string of the method value of this Message.
* @param callId -
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq -
* the new CSeqHeader object of the cSeq value of this Message.
* @param from -
* the new FromHeader object of the from value of this Message.
* @param to -
* the new ToHeader object of the to value of this Message.
* @param via -
* the new List object of the ViaHeaders of this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the method.
*/
public Request createRequest(URI requestURI, String method,
CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to,
List via, MaxForwardsHeader maxForwards) throws ParseException {
if (requestURI == null || method == null || callId == null
|| cSeq == null || from == null || to == null || via == null
|| maxForwards == null)
throw new ParseException(
"JAIN-SIP Exception, some parameters are missing"
+ ", unable to create the request", 0);
SIPRequest sipRequest = new SIPRequest();
sipRequest.setRequestURI(requestURI);
sipRequest.setMethod(method);
sipRequest.setCallId(callId);
sipRequest.setCSeq(cSeq);
sipRequest.setFrom(from);
sipRequest.setTo(to);
sipRequest.setVia(via);
sipRequest.setMaxForwards(maxForwards);
if (userAgent != null) {
sipRequest.setHeader(userAgent);
}
return sipRequest;
}
// Standard Response Creation methods
/**
* Creates a new Response message of type specified by the statusCode
* paramater, containing the mandatory headers of the message with a body in
* the form of a Java object and the body content type.
*
* @param statusCode -
* the new integer of the statusCode value of this Message.
* @param callId -
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq -
* the new CSeqHeader object of the cSeq value of this Message.
* @param from -
* the new FromHeader object of the from value of this Message.
* @param to -
* the new ToHeader object of the to value of this Message.
* @param via -
* the new List object of the ViaHeaders of this Message.
* @param content -
* the new Object of the body content value of this Message.
* @param contentType -
* the new ContentTypeHeader object of the content type value of
* this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode or the body.
*/
public Response createResponse(int statusCode, CallIdHeader callId,
CSeqHeader cSeq, FromHeader from, ToHeader to, List via,
MaxForwardsHeader maxForwards, Object content,
ContentTypeHeader contentType) throws ParseException {
if (callId == null || cSeq == null || from == null || to == null
|| via == null || maxForwards == null || content == null
|| contentType == null)
throw new NullPointerException(" unable to create the response");
SIPResponse sipResponse = new SIPResponse();
StatusLine statusLine = new StatusLine();
statusLine.setStatusCode(statusCode);
String reasonPhrase = SIPResponse.getReasonPhrase(statusCode);
//if (reasonPhrase == null)
// throw new ParseException(statusCode + " Unkown ", 0);
statusLine.setReasonPhrase(reasonPhrase);
sipResponse.setStatusLine(statusLine);
sipResponse.setCallId(callId);
sipResponse.setCSeq(cSeq);
sipResponse.setFrom(from);
sipResponse.setTo(to);
sipResponse.setVia(via);
sipResponse.setMaxForwards(maxForwards);
sipResponse.setContent(content, contentType);
if (userAgent != null) {
sipResponse.setHeader(userAgent);
}
return sipResponse;
}
/**
* Creates a new Response message of type specified by the statusCode
* paramater, containing the mandatory headers of the message with a body in
* the form of a byte array and the body content type.
*
* @param statusCode -
* the new integer of the statusCode value of this Message.
* @param callId -
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq -
* the new CSeqHeader object of the cSeq value of this Message.
* @param from -
* the new FromHeader object of the from value of this Message.
* @param to -
* the new ToHeader object of the to value of this Message.
* @param via -
* the new List object of the ViaHeaders of this Message.
* @param content -
* the new byte array of the body content value of this Message.
* @param contentType -
* the new ContentTypeHeader object of the content type value of
* this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode or the body.
*/
public Response createResponse(int statusCode, CallIdHeader callId,
CSeqHeader cSeq, FromHeader from, ToHeader to, List via,
MaxForwardsHeader maxForwards, byte[] content,
ContentTypeHeader contentType) throws ParseException {
if (callId == null || cSeq == null || from == null || to == null
|| via == null || maxForwards == null || content == null
|| contentType == null)
throw new NullPointerException("Null params ");
SIPResponse sipResponse = new SIPResponse();
sipResponse.setStatusCode(statusCode);
sipResponse.setCallId(callId);
sipResponse.setCSeq(cSeq);
sipResponse.setFrom(from);
sipResponse.setTo(to);
sipResponse.setVia(via);
sipResponse.setMaxForwards(maxForwards);
sipResponse.setHeader((ContentType) contentType);
sipResponse.setMessageContent(content);
if (userAgent != null) {
sipResponse.setHeader(userAgent);
}
return sipResponse;
}
/**
* Creates a new Response message of type specified by the statusCode
* paramater, containing the mandatory headers of the message. This new
* Response does not contain a body.
*
* @param statusCode -
* the new integer of the statusCode value of this Message.
* @param callId -
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq -
* the new CSeqHeader object of the cSeq value of this Message.
* @param from -
* the new FromHeader object of the from value of this Message.
* @param to -
* the new ToHeader object of the to value of this Message.
* @param via -
* the new List object of the ViaHeaders of this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode.
*/
public Response createResponse(int statusCode, CallIdHeader callId,
CSeqHeader cSeq, FromHeader from, ToHeader to, List via,
MaxForwardsHeader maxForwards) throws ParseException {
if (callId == null || cSeq == null || from == null || to == null
|| via == null || maxForwards == null)
throw new ParseException(
"JAIN-SIP Exception, some parameters are missing"
+ ", unable to create the response", 0);
SIPResponse sipResponse = new SIPResponse();
sipResponse.setStatusCode(statusCode);
sipResponse.setCallId(callId);
sipResponse.setCSeq(cSeq);
sipResponse.setFrom(from);
sipResponse.setTo(to);
sipResponse.setVia(via);
sipResponse.setMaxForwards(maxForwards);
if (userAgent != null) {
sipResponse.setHeader(userAgent);
}
return sipResponse;
}
// Response Creation methods based on a Request
/**
* Creates a new Response message of type specified by the statusCode
* paramater, based on a specific Request with a new body in the form of a
* Java object and the body content type.
*
* @param statusCode -
* the new integer of the statusCode value of this Message.
* @param request -
* the received Reqest object upon which to base the Response.
* @param content -
* the new Object of the body content value of this Message.
* @param contentType -
* the new ContentTypeHeader object of the content type value of
* this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode or the body.
*/
public Response createResponse(int statusCode, Request request,
ContentTypeHeader contentType, Object content)
throws ParseException {
if (request == null || content == null || contentType == null)
throw new NullPointerException("null parameters");
SIPRequest sipRequest = (SIPRequest) request;
SIPResponse sipResponse = sipRequest.createResponse(statusCode);
sipResponse.setContent(content, contentType);
if (server != null) {
sipResponse.setHeader(server);
}
return sipResponse;
}
/**
* Creates a new Response message of type specified by the statusCode
* paramater, based on a specific Request with a new body in the form of a
* byte array and the body content type.
*
* @param statusCode -
* the new integer of the statusCode value of this Message.
* @param request -
* the received Reqest object upon which to base the Response.
* @param content -
* the new byte array of the body content value of this Message.
* @param contentType -
* the new ContentTypeHeader object of the content type value of
* this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode or the body.
*/
public Response createResponse(int statusCode, Request request,
ContentTypeHeader contentType, byte[] content)
throws ParseException {
if (request == null || content == null || contentType == null)
throw new NullPointerException("null Parameters");
SIPRequest sipRequest = (SIPRequest) request;
SIPResponse sipResponse = sipRequest.createResponse(statusCode);
sipResponse.setHeader((ContentType) contentType);
sipResponse.setMessageContent(content);
if (server != null) {
sipResponse.setHeader(server);
}
return sipResponse;
}
/**
* Creates a new Response message of type specified by the statusCode
* paramater, based on a specific Request message. This new Response does
* not contain a body.
*
* @param statusCode -
* the new integer of the statusCode value of this Message.
* @param request -
* the received Reqest object upon which to base the Response.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode.
*/
public Response createResponse(int statusCode, Request request)
throws ParseException {
if (request == null)
throw new NullPointerException("null parameters");
// if (LogWriter.needsLogging)
// LogWriter.logMessage("createResponse " + request);
SIPRequest sipRequest = (SIPRequest) request;
SIPResponse sipResponse = sipRequest.createResponse(statusCode);
// Remove the content from the message (Bug report from
// Antonis Karydas.
sipResponse.removeContent();
sipResponse.removeHeader(ContentTypeHeader.NAME);
if (server != null) {
sipResponse.setHeader(server);
}
return sipResponse;
}
/**
* Creates a new Request message of type specified by the method paramater,
* containing the URI of the Request, the mandatory headers of the message
* with a body in the form of a byte array and body content type.
*
* @param requestURI -
* the new URI object of the requestURI value of this Message.
* @param method -
* the new string of the method value of this Message.
* @param callId -
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq -
* the new CSeqHeader object of the cSeq value of this Message.
* @param from -
* the new FromHeader object of the from value of this Message.
* @param to -
* the new ToHeader object of the to value of this Message.
* @param via -
* the new List object of the ViaHeaders of this Message.
* @param contentType -
* the new ContentTypeHeader object of the content type value of
* this Message.
* @param content -
* the new byte array of the body content value of this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the method or the body.
*/
public Request createRequest(javax.sip.address.URI requestURI,
String method, CallIdHeader callId, CSeqHeader cSeq,
FromHeader from, ToHeader to, List via,
MaxForwardsHeader maxForwards, ContentTypeHeader contentType,
byte[] content) throws ParseException {
if (requestURI == null || method == null || callId == null
|| cSeq == null || from == null || to == null || via == null
|| maxForwards == null || content == null
|| contentType == null)
throw new NullPointerException("missing parameters");
SIPRequest sipRequest = new SIPRequest();
sipRequest.setRequestURI(requestURI);
sipRequest.setMethod(method);
sipRequest.setCallId(callId);
sipRequest.setCSeq(cSeq);
sipRequest.setFrom(from);
sipRequest.setTo(to);
sipRequest.setVia(via);
sipRequest.setMaxForwards(maxForwards);
sipRequest.setContent(content, contentType);
if (userAgent != null) {
sipRequest.setHeader(userAgent);
}
return sipRequest;
}
/**
* Creates a new Response message of type specified by the statusCode
* paramater, containing the mandatory headers of the message with a body in
* the form of a Java object and the body content type.
*
* @param statusCode
* the new integer of the statusCode value of this Message.
* @param callId
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq
* the new CSeqHeader object of the cSeq value of this Message.
* @param from
* the new FromHeader object of the from value of this Message.
* @param to
* the new ToHeader object of the to value of this Message.
* @param via
* the new List object of the ViaHeaders of this Message.
* @param contentType
* the new ContentTypeHeader object of the content type value of
* this Message.
* @param content
* the new Object of the body content value of this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode or the body.
*/
public Response createResponse(int statusCode, CallIdHeader callId,
CSeqHeader cSeq, FromHeader from, ToHeader to, List via,
MaxForwardsHeader maxForwards, ContentTypeHeader contentType,
Object content) throws ParseException {
if (callId == null || cSeq == null || from == null || to == null
|| via == null || maxForwards == null || content == null
|| contentType == null)
throw new NullPointerException("missing parameters");
SIPResponse sipResponse = new SIPResponse();
StatusLine statusLine = new StatusLine();
statusLine.setStatusCode(statusCode);
String reason = SIPResponse.getReasonPhrase(statusCode);
if (reason == null)
throw new ParseException(statusCode + " Unknown", 0);
statusLine.setReasonPhrase(reason);
sipResponse.setStatusLine(statusLine);
sipResponse.setCallId(callId);
sipResponse.setCSeq(cSeq);
sipResponse.setFrom(from);
sipResponse.setTo(to);
sipResponse.setVia(via);
sipResponse.setContent(content, contentType);
if ( userAgent != null) {
sipResponse.setHeader(userAgent);
}
return sipResponse;
}
/**
* Creates a new Response message of type specified by the statusCode
* paramater, containing the mandatory headers of the message with a body in
* the form of a byte array and the body content type.
*
* @param statusCode
* the new integer of the statusCode value of this Message.
* @param callId
* the new CallIdHeader object of the callId value of this
* Message.
* @param cSeq
* the new CSeqHeader object of the cSeq value of this Message.
* @param from
* the new FromHeader object of the from value of this Message.
* @param to
* the new ToHeader object of the to value of this Message.
* @param via
* the new List object of the ViaHeaders of this Message.
* @param contentType
* the new ContentTypeHeader object of the content type value of
* this Message.
* @param content
* the new byte array of the body content value of this Message.
* @throws ParseException
* which signals that an error has been reached unexpectedly
* while parsing the statusCode or the body.
*/
public Response createResponse(int statusCode, CallIdHeader callId,
CSeqHeader cSeq, FromHeader from, ToHeader to, List via,
MaxForwardsHeader maxForwards, ContentTypeHeader contentType,
byte[] content) throws ParseException {
if (callId == null || cSeq == null || from == null || to == null
|| via == null || maxForwards == null || content == null
|| contentType == null)
throw new NullPointerException("missing parameters");
SIPResponse sipResponse = new SIPResponse();
StatusLine statusLine = new StatusLine();
statusLine.setStatusCode(statusCode);
String reason = SIPResponse.getReasonPhrase(statusCode);
if (reason == null)
throw new ParseException(statusCode + " : Unknown", 0);
statusLine.setReasonPhrase(reason);
sipResponse.setStatusLine(statusLine);
sipResponse.setCallId(callId);
sipResponse.setCSeq(cSeq);
sipResponse.setFrom(from);
sipResponse.setTo(to);
sipResponse.setVia(via);
sipResponse.setContent(content, contentType);
if ( userAgent != null) {
sipResponse.setHeader(userAgent);
}
return sipResponse;
}
/**
* Create a request from a string. Conveniance method for UACs that want to
* create an outgoing request from a string. Only the headers of the request
* should be included in the String that is supplied to this method.
*
* @param requestString --
* string from which to create the message null string returns an
* empty message.
*/
public javax.sip.message.Request createRequest(String requestString)
throws java.text.ParseException {
if (requestString == null || requestString.equals("")) {
SIPRequest retval = new SIPRequest();
retval.setNullRequest();
return retval;
}
StringMsgParser smp = new StringMsgParser();
smp.setStrict(this.strict);
/*
* This allows you to catch parse exceptions and create invalid messages
* if you want.
*/
ParseExceptionListener parseExceptionListener = new ParseExceptionListener() {
public void handleException(ParseException ex,
SIPMessage sipMessage, Class headerClass,
String headerText, String messageText)
throws ParseException {
// Rethrow the error for the essential headers. Otherwise bad
// headers are simply
// recorded in the message.
if (testing) {
if (headerClass == From.class || headerClass == To.class
|| headerClass == CallID.class
|| headerClass == MaxForwards.class
|| headerClass == Via.class
|| headerClass == RequestLine.class
|| headerClass == StatusLine.class
|| headerClass == CSeq.class)
throw ex;
sipMessage.addUnparsed(headerText);
}
}
};
if (this.testing)
smp.setParseExceptionListener(parseExceptionListener);
SIPMessage sipMessage = smp.parseSIPMessage(requestString);
if (!(sipMessage instanceof SIPRequest))
throw new ParseException(requestString, 0);
return (SIPRequest) sipMessage;
}
/**
* Create a response from a string
*
* @param responseString --
* string from which to create the message null string returns an
* empty message.
*
*/
public Response createResponse(String responseString)
throws java.text.ParseException {
if (responseString == null)
return new SIPResponse();
StringMsgParser smp = new StringMsgParser();
SIPMessage sipMessage = smp.parseSIPMessage(responseString);
if (!(sipMessage instanceof SIPResponse))
throw new ParseException(responseString, 0);
return (SIPResponse) sipMessage;
}
/**
* Set the common UserAgent header for all requests created from this message factory.
* This header is applied to all Messages created from this Factory object except those
* that take String for an argument and create Message from the given String.
*
* @param userAgent -- the user agent header to set.
*
* @since 2.0
*/
public void setDefaultUserAgentHeader(UserAgentHeader userAgent) {
MessageFactoryImpl.userAgent = userAgent;
}
/**
* Set the common Server header for all responses created from this message factory.
* This header is applied to all Messages created from this Factory object except those
* that take String for an argument and create Message from the given String.
*
* @param userAgent -- the user agent header to set.
*
* @since 2.0
*/
public void setDefaultServerHeader(ServerHeader server) {
MessageFactoryImpl.server = server;
}
/**
* Get the default common UserAgentHeader.
*
* @return the user agent header.
*
* @since 2.0
*/
public static UserAgentHeader getDefaultUserAgentHeader() {
return userAgent;
}
/**
* Get the default common server header.
*
* @return the server header.
*/
public static ServerHeader getDefaultServerHeader() {
return server;
}
/**
* Set default charset used for encoding String content.
* @param charset
*/
public void setDefaultContentEncodingCharset(String charset) throws NullPointerException,
IllegalArgumentException {
if (charset == null ) throw new NullPointerException ("Null argument!");
MessageFactoryImpl.defaultContentEncodingCharset = charset;
}
public static String getDefaultContentEncodingCharset() {
return MessageFactoryImpl.defaultContentEncodingCharset;
}
public MultipartMimeContent createMultipartMimeContent(ContentTypeHeader multipartMimeCth,
String[] contentType,
String[] contentSubtype,
String[] contentBody) {
String boundary = multipartMimeCth.getParameter("boundary");
MultipartMimeContentImpl retval = new MultipartMimeContentImpl(multipartMimeCth);
for (int i = 0 ; i < contentType.length; i++ ) {
ContentTypeHeader cth = new ContentType(contentType[i],contentSubtype[i]);
ContentImpl contentImpl = new ContentImpl(contentBody[i],boundary);
contentImpl.setContentTypeHeader(cth);
retval.add(contentImpl);
}
return retval;
}
}
java/gov/nist/javax/sip/message/MessageObject.java 0100644 0000000 0000000 00000014516 13513104763 021216 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD) *
******************************************************************************/
package gov.nist.javax.sip.message;
import gov.nist.core.*;
import java.lang.reflect.*;
/**
* This is the root object from which all other objects in this package
* are derived. This class is never directly instantiated (and hence it
* is abstract).
*
* @version 1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:54 $
* @since 1.1
*
* @author M. Ranganathan
*
*
*/
public abstract class MessageObject extends GenericObject {
public abstract String encode();
public void dbgPrint() {
super.dbgPrint();
}
/**
* An introspection based string formatting method. We need this because
* in this package (although it is an exact duplicate of the one in
* the superclass) because it needs to access the protected members
* of the other objects in this class.
*/
public String debugDump() {
stringRepresentation = "";
Class myclass = getClass();
sprint(myclass.getName());
sprint("{");
Field[] fields = myclass.getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
Field f = fields[i];
// Only print protected and public members.
int modifier = f.getModifiers();
if (modifier == Modifier.PRIVATE)
continue;
Class fieldType = f.getType();
String fieldName = f.getName();
if (fieldName.compareTo("stringRepresentation") == 0) {
// avoid nasty recursions...
continue;
}
if (fieldName.compareTo("indentation") == 0) {
// formatting stuff - not relevant here.
continue;
}
sprint(fieldName + ":");
try {
// Primitive fields are printed with type: value
if (fieldType.isPrimitive()) {
String fname = fieldType.toString();
sprint(fname + ":");
if (fname.compareTo("int") == 0) {
int intfield = f.getInt(this);
sprint(intfield);
} else if (fname.compareTo("short") == 0) {
short shortField = f.getShort(this);
sprint(shortField);
} else if (fname.compareTo("char") == 0) {
char charField = f.getChar(this);
sprint(charField);
} else if (fname.compareTo("long") == 0) {
long longField = f.getLong(this);
sprint(longField);
} else if (fname.compareTo("boolean") == 0) {
boolean booleanField = f.getBoolean(this);
sprint(booleanField);
} else if (fname.compareTo("double") == 0) {
double doubleField = f.getDouble(this);
sprint(doubleField);
} else if (fname.compareTo("float") == 0) {
float floatField = f.getFloat(this);
sprint(floatField);
}
} else if (
GenericObject.class.isAssignableFrom(
fieldType)) {
if (f.get(this) != null) {
sprint(
((GenericObject) f.get(this)).debugDump(
this.indentation + 1));
} else {
sprint("");
}
} else if (GenericObjectList.class.isAssignableFrom(
fieldType)) {
if (f.get(this) != null) {
sprint(
((GenericObjectList) f.get(this)).debugDump(
indentation + 1));
} else {
sprint("");
}
} else {
// Dont do recursion on things that are not
// of our header type...
if (f.get(this) != null) {
sprint(f.get(this).getClass().getName() + ":");
} else {
sprint(fieldType.getName() + ":");
}
sprint("{");
if (f.get(this) != null) {
sprint(f.get(this).toString());
} else {
sprint("");
}
sprint("}");
}
} catch (IllegalAccessException ex1) {
continue; // we are accessing a private field...
}
}
sprint("}");
return stringRepresentation;
}
protected MessageObject() {
super();
}
/**
* Formatter with a given starting indentation (for nested structs).
*/
public String dbgPrint(int indent) {
int save = indentation;
indentation = indent;
String retval = this.toString();
indentation = save;
return retval;
}
}
java/gov/nist/javax/sip/message/MultipartMimeContent.java 0100644 0000000 0000000 00000001711 13513104763 022620 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import java.util.Iterator;
import java.util.List;
import javax.sip.header.ContentTypeHeader;
public interface MultipartMimeContent {
public abstract boolean add(Content content);
/**
* Return the Content type header to assign to the outgoing sip meassage.
*
* @return
*/
public abstract ContentTypeHeader getContentTypeHeader();
public abstract String toString();
/**
* Set the content by its type.
*
* @param content
*/
public abstract void addContent( Content content);
/**
* Retrieve the list of Content that is part of this MultitypeMime content.
*
* @return - the content iterator. Returns an empty iterator if no content list present.
*/
public Iterator getContents();
/**
* Get the number of Content parts.
*
* @return - the content parts.
*/
public int getContentCount();
}
java/gov/nist/javax/sip/message/MultipartMimeContentImpl.java 0100644 0000000 0000000 00000014102 13513104763 023440 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import gov.nist.javax.sip.header.HeaderFactoryExt;
import gov.nist.javax.sip.header.HeaderFactoryImpl;
import gov.nist.javax.sip.parser.StringMsgParser;
import java.text.ParseException;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import javax.sip.header.ContentDispositionHeader;
import javax.sip.header.ContentTypeHeader;
import javax.sip.header.Header;
import javax.sip.header.HeaderFactory;
import javax.sip.message.Message;
/**
* Content list for multipart mime content type.
*
* @author M. Ranganathan
*
*/
public class MultipartMimeContentImpl implements MultipartMimeContent {
private List contentList = new LinkedList();
private ContentTypeHeader multipartMimeContentTypeHeader;
private String boundary;
public static String BOUNDARY = "boundary";
/**
* Creates a default content list.
*/
public MultipartMimeContentImpl(ContentTypeHeader contentTypeHeader) {
this.multipartMimeContentTypeHeader = contentTypeHeader;
this.boundary = contentTypeHeader.getParameter(BOUNDARY);
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.message.MultipartMimeContentExt#add(gov.nist.javax.sip.message.Content)
*/
public boolean add(Content content) {
return contentList.add((ContentImpl) content);
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.message.MultipartMimeContentExt#getContentTypeHeader()
*/
public ContentTypeHeader getContentTypeHeader() {
return multipartMimeContentTypeHeader;
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.message.MultipartMimeContentExt#toString()
*/
@Override
public String toString() {
StringBuffer stringBuffer = new StringBuffer();
for (Content content : this.contentList) {
stringBuffer.append(content.toString());
}
return stringBuffer.toString();
}
/**
* unpack a multipart mime packet and return a list of content packets.
*
* @return -- an iterator of Content blocks.
*
*/
public void createContentList(String body) throws ParseException {
try {
HeaderFactoryExt headerFactory = new HeaderFactoryImpl();
String delimiter = this.getContentTypeHeader().getParameter(BOUNDARY);
if (delimiter == null) {
this.contentList = new LinkedList();
ContentImpl content = new ContentImpl(body, delimiter);
content.setContentTypeHeader(this.getContentTypeHeader());
this.contentList.add(content);
return;
}
String[] fragments = body.split("--" + delimiter + "\r\n");
for (String nextPart : fragments) {
// NOTE - we are not hanlding line folding for the sip header here.
if (nextPart == null) {
return;
}
StringBuffer strbuf = new StringBuffer(nextPart);
while (strbuf.length() > 0
&& (strbuf.charAt(0) == '\r' || strbuf.charAt(0) == '\n'))
strbuf.deleteCharAt(0);
if (strbuf.length() == 0)
continue;
nextPart = strbuf.toString();
int position = nextPart.indexOf("\r\n\r\n");
int off = 4;
if (position == -1) {
position = nextPart.indexOf("\n");
off = 2;
}
if (position == -1)
throw new ParseException("no content type header found in " + nextPart, 0);
String rest = nextPart.substring(position + off);
if (rest == null)
throw new ParseException("No content [" + nextPart + "]", 0);
// logger.debug("rest = [[" + rest + "]]");
String headers = nextPart.substring(0, position);
ContentImpl content = new ContentImpl(rest, boundary);
String[] headerArray = headers.split("\r\n");
for (String hdr : headerArray) {
Header header = headerFactory.createHeader(hdr);
if (header instanceof ContentTypeHeader) {
content.setContentTypeHeader((ContentTypeHeader) header);
} else if (header instanceof ContentDispositionHeader) {
content.setContentDispositionHeader((ContentDispositionHeader) header);
} else {
throw new ParseException("Unexpected header type " + header.getName(), 0);
}
contentList.add(content);
}
}
} catch (StringIndexOutOfBoundsException ex) {
throw new ParseException("Invalid Multipart mime format", 0);
}
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.message.MultipartMimeContentExt#getContentByType(java.lang.String,
* java.lang.String)
*/
public Content getContentByType(String contentType, String contentSubtype) {
Content retval = null;
if (contentList == null)
return null;
for (Content content : contentList) {
if (content.getContentTypeHeader().getContentType().equalsIgnoreCase(contentType)
&& content.getContentTypeHeader().getContentSubType().equalsIgnoreCase(
contentSubtype)) {
retval = content;
break;
}
}
return retval;
}
/*
* (non-Javadoc)
*
* @see gov.nist.javax.sip.message.MultipartMimeContentExt#setContent(java.lang.String,
* java.lang.String, gov.nist.javax.sip.message.Content)
*/
public void addContent(Content content) {
this.add(content);
}
public Iterator getContents() {
return this.contentList.iterator();
}
public int getContentCount() {
return this.contentList.size();
}
}
java/gov/nist/javax/sip/message/RequestExt.java 0100644 0000000 0000000 00000000300 13513104763 020576 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import javax.sip.message.Request;
/**
* Extensions for the JAIN-SIP Request interface.
*/
public interface RequestExt extends Request, MessageExt {
}
java/gov/nist/javax/sip/message/ResponseExt.java 0100644 0000000 0000000 00000000364 13513104763 020756 0 ustar 00 0000000 0000000 package gov.nist.javax.sip.message;
import javax.sip.message.Response;
/**
*Extension for the jain-sip Response interface. This is a convenience
*interface (placeholder).
*/
public interface ResponseExt extends Response, MessageExt {
}
java/gov/nist/javax/sip/message/SIPDuplicateHeaderException.java 0100644 0000000 0000000 00000004643 13513104763 023761 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD) *
*******************************************************************************/
package gov.nist.javax.sip.message;
import gov.nist.javax.sip.header.*;
import java.text.ParseException;
/**
* Duplicate header exception: thrown when there is more
* than one header of a type where there should only be one.
* The exception handler may choose to :
* 1. discard the duplicate by returning null
* 2. keep the duplicate by just returning it.
* 3. Discard the entire message by throwing an exception.
* @version 1.2 $Revision: 1.6 $ $Date: 2009/07/17 18:57:54 $
* @since 1.1
* @author M. Ranganathan
*/
public class SIPDuplicateHeaderException extends ParseException {
private static final long serialVersionUID = 8241107266407879291L;
protected SIPHeader sipHeader;
protected SIPMessage sipMessage;
public SIPDuplicateHeaderException(String msg) {
super(msg, 0);
}
public SIPMessage getSIPMessage() {
return sipMessage;
}
public SIPHeader getSIPHeader() {
return sipHeader;
}
public void setSIPHeader(SIPHeader sipHeader) {
this.sipHeader = sipHeader;
}
public void setSIPMessage(SIPMessage sipMessage) {
this.sipMessage = sipMessage;
}
}
java/gov/nist/javax/sip/message/SIPMessage.java 0100644 0000000 0000000 00000177201 13513104763 020444 0 ustar 00 0000000 0000000 /*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************************************************
* Product of NIST/ITL Advanced Networking Technologies Division (ANTD) *
******************************************************************************/
package gov.nist.javax.sip.message;
import gov.nist.core.InternalErrorHandler;
import gov.nist.javax.sip.SIPConstants;
import gov.nist.javax.sip.Utils;
import gov.nist.javax.sip.header.AlertInfo;
import gov.nist.javax.sip.header.Authorization;
import gov.nist.javax.sip.header.CSeq;
import gov.nist.javax.sip.header.CallID;
import gov.nist.javax.sip.header.Contact;
import gov.nist.javax.sip.header.ContactList;
import gov.nist.javax.sip.header.ContentLength;
import gov.nist.javax.sip.header.ContentType;
import gov.nist.javax.sip.header.ErrorInfo;
import gov.nist.javax.sip.header.ErrorInfoList;
import gov.nist.javax.sip.header.From;
import gov.nist.javax.sip.header.InReplyTo;
import gov.nist.javax.sip.header.MaxForwards;
import gov.nist.javax.sip.header.Priority;
import gov.nist.javax.sip.header.ProxyAuthenticate;
import gov.nist.javax.sip.header.ProxyAuthorization;
import gov.nist.javax.sip.header.ProxyRequire;
import gov.nist.javax.sip.header.ProxyRequireList;
import gov.nist.javax.sip.header.RSeq;
import gov.nist.javax.sip.header.RecordRouteList;
import gov.nist.javax.sip.header.RetryAfter;
import gov.nist.javax.sip.header.Route;
import gov.nist.javax.sip.header.RouteList;
import gov.nist.javax.sip.header.SIPETag;
import gov.nist.javax.sip.header.SIPHeader;
import gov.nist.javax.sip.header.SIPHeaderList;
import gov.nist.javax.sip.header.SIPHeaderNamesCache;
import gov.nist.javax.sip.header.SIPIfMatch;
import gov.nist.javax.sip.header.Server;
import gov.nist.javax.sip.header.Subject;
import gov.nist.javax.sip.header.To;
import gov.nist.javax.sip.header.Unsupported;
import gov.nist.javax.sip.header.UserAgent;
import gov.nist.javax.sip.header.Via;
import gov.nist.javax.sip.header.ViaList;
import gov.nist.javax.sip.header.WWWAuthenticate;
import gov.nist.javax.sip.header.Warning;
import gov.nist.javax.sip.parser.HeaderParser;
import gov.nist.javax.sip.parser.ParserFactory;
import gov.nist.javax.sip.parser.PipelinedMsgParser;
import gov.nist.javax.sip.parser.StringMsgParser;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Field;
import java.text.ParseException;
import java.util.Collection;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
import java.util.concurrent.ConcurrentLinkedQueue;
import javax.sip.InvalidArgumentException;
import javax.sip.SipException;
import javax.sip.header.AuthorizationHeader;
import javax.sip.header.CSeqHeader;
import javax.sip.header.CallIdHeader;
import javax.sip.header.ContactHeader;
import javax.sip.header.ContentDispositionHeader;
import javax.sip.header.ContentEncodingHeader;
import javax.sip.header.ContentLanguageHeader;
import javax.sip.header.ContentLengthHeader;
import javax.sip.header.ContentTypeHeader;
import javax.sip.header.ExpiresHeader;
import javax.sip.header.FromHeader;
import javax.sip.header.Header;
import javax.sip.header.MaxForwardsHeader;
import javax.sip.header.RecordRouteHeader;
import javax.sip.header.RouteHeader;
import javax.sip.header.ToHeader;
import javax.sip.header.ViaHeader;
import javax.sip.message.Request;
/*
* Acknowledgements: Yanick Belanger sent in a patch for the right content length when the content
* is a String. Bill Mccormick from Nortel Networks sent in a bug fix for setContent.
*
*/
/**
* This is the main SIP Message structure.
*
* @see StringMsgParser
* @see PipelinedMsgParser
*
* @version 1.2 $Revision: 1.53 $ $Date: 2009/12/16 14:58:40 $
* @since 1.1
*
* @author M. Ranganathan
*
*
*/
public abstract class SIPMessage extends MessageObject implements javax.sip.message.Message,
MessageExt {
// JvB: use static here?
private String contentEncodingCharset = MessageFactoryImpl.getDefaultContentEncodingCharset();
/*
* True if this is a null request.
*/
protected boolean nullRequest;
/**
* unparsed headers
*/
protected LinkedList unrecognizedHeaders;
/**
* List of parsed headers (in the order they were added)
*/
protected ConcurrentLinkedQueue headers;
/**
* Direct accessors for frequently accessed headers
*/
protected From fromHeader;
protected To toHeader;
protected CSeq cSeqHeader;
protected CallID callIdHeader;
protected ContentLength contentLengthHeader;
protected MaxForwards maxForwardsHeader;
// Cumulative size of all the headers.
protected int size;
// Payload
private String messageContent;
private byte[] messageContentBytes;
private Object messageContentObject;
// Table of headers indexed by name.
private Hashtable nameTable;
/**
* The application data pointer. This is un-interpreted by the stack. This is provided as a
* convenient way of keeping book-keeping data for applications.
*/
protected Object applicationData;
/**
* Return true if the header belongs only in a Request.
*
* @param sipHeader is the header to test.
*/
public static boolean isRequestHeader(SIPHeader sipHeader) {
return sipHeader instanceof AlertInfo || sipHeader instanceof InReplyTo
|| sipHeader instanceof Authorization || sipHeader instanceof MaxForwards
|| sipHeader instanceof UserAgent || sipHeader instanceof Priority
|| sipHeader instanceof ProxyAuthorization || sipHeader instanceof ProxyRequire
|| sipHeader instanceof ProxyRequireList || sipHeader instanceof Route
|| sipHeader instanceof RouteList || sipHeader instanceof Subject
|| sipHeader instanceof SIPIfMatch;
}
/**
* Return true if the header belongs only in a response.
*
* @param sipHeader is the header to test.
*/
public static boolean isResponseHeader(SIPHeader sipHeader) {
return sipHeader instanceof ErrorInfo || sipHeader instanceof ProxyAuthenticate
|| sipHeader instanceof Server || sipHeader instanceof Unsupported
|| sipHeader instanceof RetryAfter || sipHeader instanceof Warning
|| sipHeader instanceof WWWAuthenticate || sipHeader instanceof SIPETag
|| sipHeader instanceof RSeq;
}
/**
* Get the headers as a linked list of encoded Strings
*
* @return a linked list with each element of the list containing a string encoded header in
* canonical form.
*/
public LinkedList getMessageAsEncodedStrings() {
LinkedList retval = new LinkedList();
Iterator li = headers.iterator();
while (li.hasNext()) {
SIPHeader sipHeader = (SIPHeader) li.next();
if (sipHeader instanceof SIPHeaderList) {
SIPHeaderList< ? > shl = (SIPHeaderList< ? >) sipHeader;
retval.addAll(shl.getHeadersAsEncodedStrings());
} else {
retval.add(sipHeader.encode());
}
}
return retval;
}
/**
* Encode only the message and exclude the contents (for debugging);
*
* @return a string with all the headers encoded.
*/
protected String encodeSIPHeaders() {
StringBuffer encoding = new StringBuffer();
Iterator it = this.headers.iterator();
while (it.hasNext()) {
SIPHeader siphdr = (SIPHeader) it.next();
if (!(siphdr instanceof ContentLength))
siphdr.encode(encoding);
}
return contentLengthHeader.encode(encoding).append(NEWLINE).toString();
}
/**
* Encode all the headers except the contents. For debug logging.
*/
public abstract String encodeMessage();
/**
* Get A dialog identifier constructed from this messsage. This is an id that can be used to
* identify dialogs.
*
* @param isServerTransaction is a flag that indicates whether this is a server transaction.
*/
public abstract String getDialogId(boolean isServerTransaction);
/**
* Template match for SIP messages. The matchObj is a SIPMessage template to match against.
* This method allows you to do pattern matching with incoming SIP messages. Null matches wild
* card.
*
* @param other is the match template to match against.
* @return true if a match occured and false otherwise.
*/
public boolean match(Object other) {
if (other == null)
return true;
if (!other.getClass().equals(this.getClass()))
return false;
SIPMessage matchObj = (SIPMessage) other;
Iterator li = matchObj.getHeaders();
while (li.hasNext()) {
SIPHeader hisHeaders = (SIPHeader) li.next();
List myHeaders = this.getHeaderList(hisHeaders.getHeaderName());
// Could not find a header to match his header.
if (myHeaders == null || myHeaders.size() == 0)
return false;
if (hisHeaders instanceof SIPHeaderList) {
ListIterator< ? > outerIterator = ((SIPHeaderList< ? >) hisHeaders)
.listIterator();
while (outerIterator.hasNext()) {
SIPHeader hisHeader = (SIPHeader) outerIterator.next();
if (hisHeader instanceof ContentLength)
continue;
ListIterator< ? > innerIterator = myHeaders.listIterator();
boolean found = false;
while (innerIterator.hasNext()) {
SIPHeader myHeader = (SIPHeader) innerIterator.next();
if (myHeader.match(hisHeader)) {
found = true;
break;
}
}
if (!found)
return false;
}
} else {
SIPHeader hisHeader = hisHeaders;
ListIterator innerIterator = myHeaders.listIterator();
boolean found = false;
while (innerIterator.hasNext()) {
SIPHeader myHeader = (SIPHeader) innerIterator.next();
if (myHeader.match(hisHeader)) {
found = true;
break;
}
}
if (!found)
return false;
}
}
return true;
}
/**
* Merge a request with a template
*
* @param template -- template to merge with.
*
*/
public void merge(Object template) {
if (!template.getClass().equals(this.getClass()))
throw new IllegalArgumentException("Bad class " + template.getClass());
SIPMessage templateMessage = (SIPMessage) template;
Object[] templateHeaders = templateMessage.headers.toArray();
for (int i = 0; i < templateHeaders.length; i++) {
SIPHeader hdr = (SIPHeader) templateHeaders[i];
String hdrName = hdr.getHeaderName();
List myHdrs = this.getHeaderList(hdrName);
if (myHdrs == null) {
this.attachHeader(hdr);
} else {
ListIterator it = myHdrs.listIterator();
while (it.hasNext()) {
SIPHeader sipHdr = (SIPHeader) it.next();
sipHdr.merge(hdr);
}
}
}
}
/**
* Encode this message as a string. This is more efficient when the payload is a string
* (rather than a binary array of bytes). If the payload cannot be encoded as a UTF-8 string
* then it is simply ignored (will not appear in the encoded message).
*
* @return The Canonical String representation of the message (including the canonical string
* representation of the SDP payload if it exists).
*/
public String encode() {
StringBuffer encoding = new StringBuffer();
Iterator it = this.headers.iterator();
while (it.hasNext()) {
SIPHeader siphdr = (SIPHeader) it.next();
if (!(siphdr instanceof ContentLength))
encoding.append(siphdr.encode());
}
// Append the unrecognized headers. Headers that are not
// recognized are passed through unchanged.
for (String unrecognized : this.unrecognizedHeaders) {
encoding.append(unrecognized).append(NEWLINE);
}
encoding.append(contentLengthHeader.encode()).append(NEWLINE);
if (this.messageContentObject != null) {
String mbody = this.getContent().toString();
encoding.append(mbody);
} else if (this.messageContent != null || this.messageContentBytes != null) {
String content = null;
try {
if (messageContent != null)
content = messageContent;
else {
// JvB: Check for 'charset' parameter which overrides the default UTF-8
content = new String(messageContentBytes, getCharset() );
}
} catch (UnsupportedEncodingException ex) {
InternalErrorHandler.handleException(ex);
}
encoding.append(content);
}
return encoding.toString();
}
/**
* Encode the message as a byte array. Use this when the message payload is a binary byte
* array.
*
* @return The Canonical byte array representation of the message (including the canonical
* byte array representation of the SDP payload if it exists all in one contiguous
* byte array).
*/
public byte[] encodeAsBytes(String transport) {
if (this instanceof SIPRequest && ((SIPRequest) this).isNullRequest()) {
return "\r\n\r\n".getBytes();
}
// JvB: added to fix case where application provides the wrong transport
// in the topmost Via header
ViaHeader topVia = (ViaHeader) this.getHeader(ViaHeader.NAME);
try {
topVia.setTransport(transport);
} catch (ParseException e) {
InternalErrorHandler.handleException(e);
}
StringBuffer encoding = new StringBuffer();
synchronized (this.headers) {
Iterator it = this.headers.iterator();
while (it.hasNext()) {
SIPHeader siphdr = (SIPHeader) it.next();
if (!(siphdr instanceof ContentLength))
siphdr.encode(encoding);
}
}
contentLengthHeader.encode(encoding);
encoding.append(NEWLINE);
byte[] retval = null;
byte[] content = this.getRawContent();
if (content != null) {
// Append the content
byte[] msgarray = null;
try {
msgarray = encoding.toString().getBytes( getCharset() );
} catch (UnsupportedEncodingException ex) {
InternalErrorHandler.handleException(ex);
}
retval = new byte[msgarray.length + content.length];
System.arraycopy(msgarray, 0, retval, 0, msgarray.length);
System.arraycopy(content, 0, retval, msgarray.length, content.length);
} else {
// Message content does not exist.
try {
retval = encoding.toString().getBytes( getCharset() );
} catch (UnsupportedEncodingException ex) {
InternalErrorHandler.handleException(ex);
}
}
return retval;
}
/**
* clone this message (create a new deep physical copy). All headers in the message are
* cloned. You can modify the cloned copy without affecting the original. The content is
* handled as follows: If the content is a String, or a byte array, a new copy of the content
* is allocated and copied over. If the content is an Object that supports the clone method,
* then the clone method is invoked and the cloned content is the new content. Otherwise, the
* content of the new message is set equal to the old one.
*
* @return A cloned copy of this object.
*/
public Object clone() {
SIPMessage retval = (SIPMessage) super.clone();
retval.nameTable = new Hashtable();
retval.fromHeader = null;
retval.toHeader = null;
retval.cSeqHeader = null;
retval.callIdHeader = null;
retval.contentLengthHeader = null;
retval.maxForwardsHeader = null;
if (this.headers != null) {
retval.headers = new ConcurrentLinkedQueue();
for (Iterator iter = headers.iterator(); iter.hasNext();) {
SIPHeader hdr = (SIPHeader) iter.next();
retval.attachHeader((SIPHeader) hdr.clone());
}
}
if (this.messageContentBytes != null)
retval.messageContentBytes = (byte[]) this.messageContentBytes.clone();
if (this.messageContentObject != null)
retval.messageContentObject = makeClone(messageContentObject);
retval.unrecognizedHeaders = this.unrecognizedHeaders;
return retval;
}
/**
* Get the string representation of this header (for pretty printing the generated structure).
*
* @return Formatted string representation of the object. Note that this is NOT the same as
* encode(). This is used mainly for debugging purposes.
*/
public String debugDump() {
stringRepresentation = "";
sprint("SIPMessage:");
sprint("{");
try {
Field[] fields = this.getClass().getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
Field f = fields[i];
Class< ? > fieldType = f.getType();
String fieldName = f.getName();
if (f.get(this) != null && SIPHeader.class.isAssignableFrom(fieldType)
&& fieldName.compareTo("headers") != 0) {
sprint(fieldName + "=");
sprint(((SIPHeader) f.get(this)).debugDump());
}
}
} catch (Exception ex) {
InternalErrorHandler.handleException(ex);
}
sprint("List of headers : ");
sprint(headers.toString());
sprint("messageContent = ");
sprint("{");
sprint(messageContent);
sprint("}");
if (this.getContent() != null) {
sprint(this.getContent().toString());
}
sprint("}");
return stringRepresentation;
}
/**
* Constructor: Initializes lists and list headers. All the headers for which there can be
* multiple occurances in a message are derived from the SIPHeaderListClass. All singleton
* headers are derived from SIPHeader class.
*/
public SIPMessage() {
this.unrecognizedHeaders = new LinkedList();
this.headers = new ConcurrentLinkedQueue();
nameTable = new Hashtable();
try {
this.attachHeader(new ContentLength(0), false);
} catch (Exception ex) {
}
}
/**
* Attach a header and die if you get a duplicate header exception.
*
* @param h SIPHeader to attach.
*/
private void attachHeader(SIPHeader h) {
if (h == null)
throw new IllegalArgumentException("null header!");
try {
if (h instanceof SIPHeaderList) {
SIPHeaderList< ? > hl = (SIPHeaderList< ? >) h;
if (hl.isEmpty()) {
return;
}
}
attachHeader(h, false, false);
} catch (SIPDuplicateHeaderException ex) {
// InternalErrorHandler.handleException(ex);
}
}
/**
* Attach a header (replacing the original header).
*
* @param sipHeader SIPHeader that replaces a header of the same type.
*/
public void setHeader(Header sipHeader) {
SIPHeader header = (SIPHeader) sipHeader;
if (header == null)
throw new IllegalArgumentException("null header!");
try {
if (header instanceof SIPHeaderList) {
SIPHeaderList< ? > hl = (SIPHeaderList< ? >) header;
// Ignore empty lists.
if (hl.isEmpty())
return;
}
this.removeHeader(header.getHeaderName());
attachHeader(header, true, false);
} catch (SIPDuplicateHeaderException ex) {
InternalErrorHandler.handleException(ex);
}
}
/**
* Set a header from a linked list of headers.
*
* @param headers -- a list of headers to set.
*/
public void setHeaders(java.util.List headers) {
ListIterator listIterator = headers.listIterator();
while (listIterator.hasNext()) {
SIPHeader sipHeader = (SIPHeader) listIterator.next();
try {
this.attachHeader(sipHeader, false);
} catch (SIPDuplicateHeaderException ex) {
}
}
}
/**
* Attach a header to the end of the existing headers in this SIPMessage structure. This is
* equivalent to the attachHeader(SIPHeader,replaceflag,false); which is the normal way in
* which headers are attached. This was added in support of JAIN-SIP.
*
* @param h header to attach.
* @param replaceflag if true then replace a header if it exists.
* @throws SIPDuplicateHeaderException If replaceFlag is false and only a singleton header is
* allowed (fpr example CSeq).
*/
public void attachHeader(SIPHeader h, boolean replaceflag) throws SIPDuplicateHeaderException {
this.attachHeader(h, replaceflag, false);
}
/**
* Attach the header to the SIP Message structure at a specified position in its list of
* headers.
*
* @param header Header to attach.
* @param replaceFlag If true then replace the existing header.
* @param top Location in the header list to insert the header.
* @exception SIPDuplicateHeaderException if the header is of a type that cannot tolerate
* duplicates and one of this type already exists (e.g. CSeq header).
* @throws IndexOutOfBoundsException If the index specified is greater than the number of
* headers that are in this message.
*/
public void attachHeader(SIPHeader header, boolean replaceFlag, boolean top)
throws SIPDuplicateHeaderException {
if (header == null) {
throw new NullPointerException("null header");
}
SIPHeader h;
if (ListMap.hasList(header) && !SIPHeaderList.class.isAssignableFrom(header.getClass())) {
SIPHeaderList hdrList = ListMap.getList(header);
hdrList.add(header);
h = hdrList;
} else {
h = header;
}
String headerNameLowerCase = SIPHeaderNamesCache.toLowerCase(h.getName());
if (replaceFlag) {
nameTable.remove(headerNameLowerCase);
} else if (nameTable.containsKey(headerNameLowerCase) && !(h instanceof SIPHeaderList)) {
if (h instanceof ContentLength) {
try {
ContentLength cl = (ContentLength) h;
contentLengthHeader.setContentLength(cl.getContentLength());
} catch (InvalidArgumentException e) {
}
}
// Just ignore duplicate header.
return;
}
SIPHeader originalHeader = (SIPHeader) getHeader(header.getName());
// Delete the original header from our list structure.
if (originalHeader != null) {
Iterator li = headers.iterator();
while (li.hasNext()) {
SIPHeader next = (SIPHeader) li.next();
if (next.equals(originalHeader)) {
li.remove();
}
}
}
if (!nameTable.containsKey(headerNameLowerCase)) {
nameTable.put(headerNameLowerCase, h);
headers.add(h);
} else {
if (h instanceof SIPHeaderList) {
SIPHeaderList< ? > hdrlist = (SIPHeaderList< ? >) nameTable
.get(headerNameLowerCase);
if (hdrlist != null)
hdrlist.concatenate((SIPHeaderList) h, top);
else
nameTable.put(headerNameLowerCase, h);
} else {
nameTable.put(headerNameLowerCase, h);
}
}
// Direct accessor fields for frequently accessed headers.
if (h instanceof From) {
this.fromHeader = (From) h;
} else if (h instanceof ContentLength) {
this.contentLengthHeader = (ContentLength) h;
} else if (h instanceof To) {
this.toHeader = (To) h;
} else if (h instanceof CSeq) {
this.cSeqHeader = (CSeq) h;
} else if (h instanceof CallID) {
this.callIdHeader = (CallID) h;
} else if (h instanceof MaxForwards) {
this.maxForwardsHeader = (MaxForwards) h;
}
}
/**
* Remove a header given its name. If multiple headers of a given name are present then the
* top flag determines which end to remove headers from.
*
* @param headerName is the name of the header to remove.
* @param top -- flag that indicates which end of header list to process.
*/
public void removeHeader(String headerName, boolean top) {
String headerNameLowerCase = SIPHeaderNamesCache.toLowerCase(headerName);
SIPHeader toRemove = (SIPHeader) nameTable.get(headerNameLowerCase);
// nothing to do then we are done.
if (toRemove == null)
return;
if (toRemove instanceof SIPHeaderList) {
SIPHeaderList< ? > hdrList = (SIPHeaderList< ? >) toRemove;
if (top)
hdrList.removeFirst();
else
hdrList.removeLast();
// Clean up empty list
if (hdrList.isEmpty()) {
Iterator