1600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/* 2600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Conditions Of Use 3600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 4600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software was developed by employees of the National Institute of 5600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Standards and Technology (NIST), an agency of the Federal Government. 6600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Pursuant to title 15 Untied States Code Section 105, works of NIST 7600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* employees are not subject to copyright protection in the United States 8600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* and are considered to be in the public domain. As a result, a formal 9600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* license is not needed to use the software. 10600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 11600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* This software is provided by NIST as a service and is expressly 12600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED 13600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF 14600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT 15600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* AND DATA ACCURACY. NIST does not warrant or make any representations 16600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* regarding the use of the software or the results thereof, including but 17600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* not limited to the correctness, accuracy, reliability or usefulness of 18600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* the software. 19600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 20600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Permission to use this software is contingent upon your acceptance 21600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* of the terms of this agreement 22600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 23600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* . 24600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 25600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*/ 26600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/******************************************************************************* 27600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Product of NIST/ITL Advanced Networking Technologies Division (ANTD). * 28600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*******************************************************************************/ 29600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpackage gov.nist.javax.sip.header; 30600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 31600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport javax.sip.header.*; 32600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangimport java.text.ParseException; 33600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 34600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang/** 35600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* Event SIP Header. 36600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 37600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*@version 1.2 $Revision: 1.7 $ $Date: 2007/06/28 15:08:42 $ 38600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*@since 1.1 39600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 40600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*@author M. Ranganathan <br/> 41600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*@author Olivier Deruelle <br/> 42600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 43600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang* 44600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang*/ 45600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wangpublic class Event extends ParametersHeader implements EventHeader { 46600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 47600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 48600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Comment for <code>serialVersionUID</code> 49600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 50600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang private static final long serialVersionUID = -6458387810431874841L; 51600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 52600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected String eventType; 53600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 54600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 55600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Creates a new instance of Event 56600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 57600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public Event() { 58600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang super(EVENT); 59600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 60600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 61600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 62600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Sets the eventType to the newly supplied eventType string. 63600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 64600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param eventType - the new string defining the eventType supported 65600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * in this EventHeader 66600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws ParseException which signals that an error has been reached 67600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * unexpectedly while parsing the eventType value. 68600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 69600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setEventType(String eventType) throws ParseException { 70600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (eventType == null) 71600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new NullPointerException(" the eventType is null"); 72600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.eventType = eventType; 73600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 74600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 75600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 76600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Gets the eventType of the EventHeader. 77600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 78600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the string object identifing the eventType of EventHeader. 79600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 80600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getEventType() { 81600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return eventType; 82600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 83600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 84600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 85600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Sets the id to the newly supplied <var>eventId</var> string. 86600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 87600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param eventId - the new string defining the eventId of this EventHeader 88600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @throws ParseException which signals that an error has been reached 89600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * unexpectedly while parsing the eventId value. 90600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 91600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public void setEventId(String eventId) throws ParseException { 92600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (eventId == null) 93600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang throw new NullPointerException(" the eventId parameter is null"); 94600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang setParameter(ParameterNames.ID, eventId); 95600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 96600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 97600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 98600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Gets the id of the EventHeader. This method may return null if the 99600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * "eventId" is not set. 100600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return the string object identifing the eventId of EventHeader. 101600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 102600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String getEventId() { 103600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return getParameter(ParameterNames.ID); 104600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 105600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 106600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 107600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Encode in canonical form. 108600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @return String 109600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 110600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public String encodeBody() { 111600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return encodeBody(new StringBuffer()).toString(); 112600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 113600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 114600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang protected StringBuffer encodeBody(StringBuffer buffer) { 115600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (eventType != null) 116600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(eventType); 117600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 118600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (!parameters.isEmpty()) { 119600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang buffer.append(SEMICOLON); 120600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang this.parameters.encode(buffer); 121600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 122600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return buffer; 123600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 124600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang 125600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang /** 126600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * Return true if the given event header matches the supplied one. 127600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * 128600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang * @param matchTarget -- event header to match against. 129600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang */ 130600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang public boolean match(Event matchTarget) { 131600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang if (matchTarget.eventType == null && this.eventType != null) 132600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 133600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang else if (matchTarget.eventType != null && this.eventType == null) 134600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 135600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang else if (this.eventType == null && matchTarget.eventType == null) 136600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 137600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang else if (getEventId() == null && matchTarget.getEventId() != null) 138600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 139600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang else if (getEventId() != null && matchTarget.getEventId() == null) 140600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return false; 141600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang return matchTarget.eventType.equalsIgnoreCase(this.eventType) 142600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang && ((this.getEventId() == matchTarget.getEventId()) 143600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang || this.getEventId().equalsIgnoreCase(matchTarget.getEventId())); 144600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang } 145600c7a4bbc7348167293eac928192e695b4ad5baChung-yih Wang} 146