sipxtacklib  Version 3.3
Public Member Functions | List of all members
SipSubscribeServerEventHandler Class Reference

Class for specializing the handling of SIP Events in SipSubscribeServer. More...

#include <SipSubscribeServerEventHandler.h>

Public Member Functions

 SipSubscribeServerEventHandler ()
 Default Dialog constructor. More...
 
virtual ~SipSubscribeServerEventHandler ()
 Destructor. More...
 
virtual UtlBoolean getKeys (const SipMessage &subscribeRequest, UtlString &resourceId, UtlString &eventTypeKey, UtlString &eventType)
 Determine what the resourceId, eventTypeKey, and eventType should be for this SUBSCRIBE request. More...
 
virtual UtlBoolean isAuthenticated (const SipMessage &subscribeRequest, const UtlString &resourceId, const UtlString &eventTypeKey, SipMessage &subscribeResponse)
 Determine if the given SUBSCRIBE request is authenticated to subscribe. More...
 
virtual UtlBoolean isAuthorized (const SipMessage &subscribeRequest, const UtlString &resourceId, const UtlString &eventTypeKey, SipMessage &subscribeResponse)
 Determine if the given SUBSCRIBE request is authorized to subscribe. More...
 
virtual UtlBoolean getNotifyContent (const UtlString &resourceId, const UtlString &eventTypeKey, const UtlString &eventType, SipPublishContentMgr &contentMgr, const char *allowHeaderValue, SipMessage &notifyRequest)
 Fill in the event specific content for the identified resource and eventTypeKey. More...
 

Detailed Description

Class for specializing the handling of SIP Events in SipSubscribeServer.

This class provides the default behavior for SIP event packages handled by SipSubscribeServer. Event packages which wish to change or extend the default behavior should derived from this class and override the behavior of methods implemented by this class.

Constructor & Destructor Documentation

Default Dialog constructor.

Destructor.

Member Function Documentation

UtlBoolean getKeys ( const SipMessage subscribeRequest,
UtlString &  resourceId,
UtlString &  eventTypeKey,
UtlString &  eventType 
)
virtual

Determine what the resourceId, eventTypeKey, and eventType should be for this SUBSCRIBE request.

The default behavior is to use the identify from the request URI as the resourceId and the event type token from the Event header as the eventTypeKey. Some event packages may wish to override this (e.g. the host part of the resourceID, which will usually be an IP addressmay make sense in some cases to be substituted with the domain name. In some event packages, the content of the event state information will vary based upon some Event header parameters, in which cases it may make sense to include that event header parameter in a consistant order and format in the eventTypeKey.)

UtlBoolean isAuthenticated ( const SipMessage subscribeRequest,
const UtlString &  resourceId,
const UtlString &  eventTypeKey,
SipMessage subscribeResponse 
)
virtual

Determine if the given SUBSCRIBE request is authenticated to subscribe.

Default behavior is to not require any authentication.

UtlBoolean isAuthorized ( const SipMessage subscribeRequest,
const UtlString &  resourceId,
const UtlString &  eventTypeKey,
SipMessage subscribeResponse 
)
virtual

Determine if the given SUBSCRIBE request is authorized to subscribe.

Default behavior is to allow any request to subscribe

UtlBoolean getNotifyContent ( const UtlString &  resourceId,
const UtlString &  eventTypeKey,
const UtlString &  eventType,
SipPublishContentMgr contentMgr,
const char *  allowHeaderValue,
SipMessage notifyRequest 
)
virtual

Fill in the event specific content for the identified resource and eventTypeKey.

The default behavior is to attach the content yielded from contentMgr->getContent.


sipXtackLib home page