org.zoolu.sip.message
Class Message

java.lang.Object
  |
  +--org.zoolu.sip.message.BaseMessage
        |
        +--org.zoolu.sip.message.Message

public class Message

extends BaseMessage

Class Message extends class sip.message.BaseMessage adding some SIP extensions.

Class Message supports all methods and header definened in RFC3261, plus:

• method MESSAGE (RFC3428)
• method REFER (RFC3515)
• header Refer-To
• header Referred-By
• header Event

Fields inherited from class org.zoolu.sip.message.BaseMessage

connection_id, MAX_PKT_SIZE, PROTO_SCTP, PROTO_TCP, PROTO_TLS, PROTO_UDP, remote_addr, remote_port, transport_proto

Constructor Summary

Message()
Costructs a new empty Message

Message(byte[] buff, int offset, int len)
Costructs a new Message

Message(Message msg)
Costructs a new Message

Message(java.lang.String str)
Costructs a new Message

Message(UdpPacket packet)
Costructs a new Message

Method Summary

java.lang.Object	clone() Creates and returns a clone of the Message
AllowEventsHeader	getAllowEventsHeader() Gets AllowEventsHeader
EventHeader	getEventHeader() Gets EventHeader
ReferredByHeader	getReferredByHeader() Gets ReferredByHeader
ReferToHeader	getReferToHeader() Gets ReferToHeader
SubscriptionStateHeader	getSubscriptionStateHeader() Gets SubscriptionStateHeader
boolean	hasAllowEventsHeader() Whether the message has the AllowEventsHeader
boolean	hasEventHeader() Whether the message has the EventHeader
boolean	hasReferredByHeader() Whether the message has the Referred-By header
boolean	hasReferToHeader() Whether the message has the Refer-To header
boolean	hasSubscriptionStateHeader() Whether the message has the Subscription-State header
boolean	isMessage() Returns boolean value to indicate if Message is a MESSAGE request (RFC3428)
boolean	isNotify() Returns boolean value to indicate if Message is a NOTIFY request (RFC3265)
boolean	isPublish() Returns boolean value to indicate if Message is a PUBLISH request (RFC3903)
boolean	isRefer() Returns boolean value to indicate if Message is a REFER request (RFC3515)
boolean	isSubscribe() Returns boolean value to indicate if Message is a SUBSCRIBE request (RFC3265)
void	removeAllowEventsHeader() Removes AllowEventsHeader from Message (if it exists)
void	removeEventHeader() Removes EventHeader from Message (if it exists)
void	removeReferredByHeader() Removes ReferredByHeader from Message (if it exists)
void	removeReferToHeader() Removes ReferToHeader from Message (if it exists)
void	removeSubscriptionStateHeader() Removes SubscriptionStateHeader from Message (if it exists)
void	setAllowEventsHeader(AllowEventsHeader h) Sets AllowEventsHeader
void	setEventHeader(EventHeader h) Sets EventHeader
void	setReferredByHeader(ReferredByHeader h) Sets ReferredByHeader
void	setReferToHeader(ReferToHeader h) Sets ReferToHeader
void	setSubscriptionStateHeader(SubscriptionStateHeader h) Sets SubscriptionStateHeader

Methods inherited from class org.zoolu.sip.message.BaseMessage

addContactHeader, addContacts, addHeader, addHeaderAfter, addHeaderBefore, addHeaders, addHeaders, addHeaders, addHeaders, addHeadersAfter, addHeadersAfter, addHeadersBefore, addHeadersBefore, addRecordRouteHeader, addRecordRoutes, addRouteHeader, addRoutes, addViaHeader, addVias, createsDialog, getAcceptHeader, getAlertInfoHeader, getAllowHeader, getAuthenticationInfoHeader, getAuthorizationHeader, getBody, getBodyType, getCallIdHeader, getConnectionId, getContactHeader, getContacts, getContentLengthHeader, getContentTypeHeader, getCSeqHeader, getDateHeader, getDialogId, getExpiresHeader, getFirstLine, getFromHeader, getHeader, getHeaders, getLength, getMaxForwardsHeader, getMethodId, getProxyAuthenticateHeader, getProxyAuthorizationHeader, getRecordRouteHeader, getRecordRoutes, getRemoteAddress, getRemotePort, getRequestLine, getRouteHeader, getRoutes, getServerHeader, getStatusLine, getSubjectHeader, getToHeader, getTransactionId, getTransactionMethod, getTransportProtocol, getUserAgentHeader, getViaHeader, getVias, getWwwAuthenticateHeader, hasAcceptHeader, hasAlertInfoHeader, hasAllowHeader, hasAuthenticationInfoHeader, hasAuthorizationHeader, hasBody, hasCallIdHeader, hasContactHeader, hasContentLengthHeader, hasContentTypeHeader, hasCSeqHeader, hasDateHeader, hasExpiresHeader, hasFromHeader, hasHeader, hasMaxForwardsHeader, hasProxyAuthenticateHeader, hasProxyAuthorizationHeader, hasRecordRouteHeader, hasRequestLine, hasRouteHeader, hasServerHeader, hasStatusLine, hasSubjectHeader, hasToHeader, hasUserAgentHeader, hasViaHeader, hasWwwAuthenticateHeader, isAck, isBye, isCancel, isInfo, isInvite, isOption, isRegister, isRequest, isRequest, isResponse, removeAcceptHeader, removeAlertInfoHeader, removeAllHeaders, removeAllowHeader, removeAuthenticationInfoHeader, removeAuthorizationHeader, removeBody, removeCallIdHeader, removeContacts, removeContentLengthHeader, removeContentTypeHeader, removeCSeqHeader, removeDateHeader, removeExpiresHeader, removeFirstLine, removeFromHeader, removeHeader, removeHeader, removeMaxForwardsHeader, removeProxyAuthenticateHeader, removeProxyAuthorizationHeader, removeRecordRouteHeader, removeRecordRoutes, removeRequestLine, removeRouteHeader, removeRoutes, removeServerHeader, removeStatusLine, removeSubjectHeader, removeToHeader, removeUserAgentHeader, removeViaHeader, removeVias, removeWwwAuthenticateHeader, rfc2543RouteAdapt, rfc2543toRfc3261RouteUpdate, setAcceptHeader, setAlertInfoHeader, setAllowHeader, setAuthenticationInfoHeader, setAuthorizationHeader, setBody, setBody, setCallIdHeader, setConnectionId, setContactHeader, setContacts, setContentLengthHeader, setContentTypeHeader, setCSeqHeader, setDateHeader, setExpiresHeader, setFromHeader, setHeader, setHeaders, setMaxForwardsHeader, setMessage, setProxyAuthenticateHeader, setProxyAuthorizationHeader, setRecordRoutes, setRemoteAddress, setRemotePort, setRequestLine, setRoutes, setServerHeader, setStatusLine, setSubjectHeader, setToHeader, setTransport, setUserAgentHeader, setVias, setWwwAuthenticateHeader, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message()

Costructs a new empty Message

Message

public Message(java.lang.String str)

Costructs a new Message

Message

public Message(byte[] buff,
               int offset,
               int len)

Costructs a new Message

Message

public Message(UdpPacket packet)

Costructs a new Message

Message

public Message(Message msg)

Costructs a new Message

Method Detail

clone

public java.lang.Object clone()

Creates and returns a clone of the Message

Overrides:

clone in class BaseMessage

isMessage

public boolean isMessage()
                  throws java.lang.NullPointerException

Returns boolean value to indicate if Message is a MESSAGE request (RFC3428)

isRefer

public boolean isRefer()
                throws java.lang.NullPointerException

Returns boolean value to indicate if Message is a REFER request (RFC3515)

isNotify

public boolean isNotify()
                 throws java.lang.NullPointerException

Returns boolean value to indicate if Message is a NOTIFY request (RFC3265)

isSubscribe

public boolean isSubscribe()
                    throws java.lang.NullPointerException

Returns boolean value to indicate if Message is a SUBSCRIBE request (RFC3265)

isPublish

public boolean isPublish()
                  throws java.lang.NullPointerException

Returns boolean value to indicate if Message is a PUBLISH request (RFC3903)

hasReferToHeader

public boolean hasReferToHeader()

Whether the message has the Refer-To header

getReferToHeader

public ReferToHeader getReferToHeader()

Gets ReferToHeader

setReferToHeader

public void setReferToHeader(ReferToHeader h)

Sets ReferToHeader

removeReferToHeader

public void removeReferToHeader()

Removes ReferToHeader from Message (if it exists)

hasReferredByHeader

public boolean hasReferredByHeader()

Whether the message has the Referred-By header

getReferredByHeader

public ReferredByHeader getReferredByHeader()

Gets ReferredByHeader

setReferredByHeader

public void setReferredByHeader(ReferredByHeader h)

Sets ReferredByHeader

removeReferredByHeader

public void removeReferredByHeader()

Removes ReferredByHeader from Message (if it exists)

hasEventHeader

public boolean hasEventHeader()

Whether the message has the EventHeader

getEventHeader

public EventHeader getEventHeader()

Gets EventHeader

setEventHeader

public void setEventHeader(EventHeader h)

Sets EventHeader

removeEventHeader

public void removeEventHeader()

Removes EventHeader from Message (if it exists)

hasAllowEventsHeader

public boolean hasAllowEventsHeader()

Whether the message has the AllowEventsHeader

getAllowEventsHeader

public AllowEventsHeader getAllowEventsHeader()

Gets AllowEventsHeader

setAllowEventsHeader

public void setAllowEventsHeader(AllowEventsHeader h)

Sets AllowEventsHeader

removeAllowEventsHeader

public void removeAllowEventsHeader()

Removes AllowEventsHeader from Message (if it exists)

hasSubscriptionStateHeader

public boolean hasSubscriptionStateHeader()

Whether the message has the Subscription-State header

getSubscriptionStateHeader

public SubscriptionStateHeader getSubscriptionStateHeader()

Gets SubscriptionStateHeader

setSubscriptionStateHeader

public void setSubscriptionStateHeader(SubscriptionStateHeader h)

Sets SubscriptionStateHeader

removeSubscriptionStateHeader

public void removeSubscriptionStateHeader()

Removes SubscriptionStateHeader from Message (if it exists)