gov.nist.javax.sip.header
Class Event

java.lang.Object
  gov.nist.core.GenericObject
      gov.nist.javax.sip.header.SIPObject
          gov.nist.javax.sip.header.SIPHeader
              gov.nist.javax.sip.header.ParametersHeader
                  gov.nist.javax.sip.header.Event

All Implemented Interfaces:

Cloneable, EventHeader, Header, Parameters, Serializable, SIPHeaderNames

public class Event

extends ParametersHeader

implements EventHeader

Event SIP Header.

Version:

JAIN-SIP-1.1

Author:

M. Ranganathan
, Olivier Deruelle
This code is in the public domain.

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.sip.header.EventHeader

NAME

Fields inherited from interface gov.nist.javax.sip.header.SIPHeaderNames

ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Event()
Creates a new instance of Event

Method Summary

String	encodeBody() Encode in canonical form.
String	getEventId() Gets the id of the EventHeader.
String	getEventType() Gets the eventType of the EventHeader.
boolean	match(Event matchTarget) Return true if the given event header matches the supplied one.
void	setEventId(String eventId) Sets the id to the newly supplied eventId string.
void	setEventType(String eventType) Sets the eventType to the newly supplied eventType string.

Methods inherited from class gov.nist.javax.sip.header.ParametersHeader

getNameValue, getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter

Methods inherited from class gov.nist.javax.sip.header.SIPHeader

encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName

Methods inherited from class gov.nist.javax.sip.header.SIPObject

clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString

Methods inherited from class gov.nist.core.GenericObject

getClassFromName, getMatcher, isMySubclass, match, setMatcher

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.Parameters

getParameter, getParameterNames, removeParameter, setParameter

Methods inherited from interface javax.sip.header.Header

clone, equals, getName, toString

Constructor Detail

Event

public Event()

Creates a new instance of Event

Method Detail

setEventType

public void setEventType(String eventType)
                  throws ParseException

Sets the eventType to the newly supplied eventType string.

Specified by:

setEventType in interface EventHeader

Parameters:

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.

getEventType

public String getEventType()

Gets the eventType of the EventHeader.

Specified by:

getEventType in interface EventHeader

Returns:

the string object identifing the eventType of EventHeader.

setEventId

public void setEventId(String eventId)
                throws ParseException

Sets the id to the newly supplied eventId string.

Specified by:

setEventId in interface EventHeader

Parameters:

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.

getEventId

public String getEventId()

Gets the id of the EventHeader. This method may return null if the "eventId" is not set.

Specified by:

getEventId in interface EventHeader

Returns:

the string object identifing the eventId of EventHeader.

encodeBody

public String encodeBody()

Encode in canonical form.

Returns:

String

match

public boolean match(Event matchTarget)

Return true if the given event header matches the supplied one.

Parameters:

matchTarget - -- event header to match against.