org.mobicents.slee.enabler.sip
Interface PublicationClientChild

All Known Subinterfaces:

PublicationClientChildSbbLocalObject

All Known Implementing Classes:

PublicationClientChildSbb

public interface PublicationClientChild

Interface for SIP-Publication-Client(EPA/PUA). Upon creation of publication, enabler stores information:

• eventPackage
• MIME type
• entity
• ecsAddress

Enabler also manages current etag value. Each enabler instance manages single publication.

Author:

baranowb, martins

Method Summary

java.lang.String	getEntity() Retrieve entity for which this child publishes.
java.lang.String	getETag() Retrieve ETag used in last publish request.
void	modifyPublication(java.lang.String document, java.lang.String contentType, java.lang.String contentSubType, int expires) Modifies publication with passed document.
void	newPublication(java.lang.String entity, java.lang.String eventPackage, java.lang.String document, java.lang.String contentType, java.lang.String contentSubType, int expires) This method should be used to create new publication.
void	removePublication() Issues remove request.
void	setParentSbb(PublicationClientParentSbbLocalObject parent) Set parent which will be notified about call results.

Method Detail

newPublication

void newPublication(java.lang.String entity,
                    java.lang.String eventPackage,
                    java.lang.String document,
                    java.lang.String contentType,
                    java.lang.String contentSubType,
                    int expires)

This method should be used to create new publication.

Parameters:

entity - - entity id handling this part of publication. AOR of resource.

eventPackage - - name of event package, ie: "publish"

document - - encoded document, which should be sent for publication

contentType - - main type of MIME type

contentSubType - - sub type of MIME type

expires - - number of seconds for which publication should be active. If its equal to 0, it means ESC/PA should determine expires interval by itself.

modifyPublication

void modifyPublication(java.lang.String document,
                       java.lang.String contentType,
                       java.lang.String contentSubType,
                       int expires)

Modifies publication with passed document. Update request uses stored information(ETag,entity,ecs address and MIME).

Parameters:

document - - encoded document, which should be sent for publication

contentType - - main type of MIME type

contentSubType - - sub type of MIME type

expires - - number of seconds for which publication should be active

removePublication

void removePublication()

Issues remove request. Request uses uses stored information(ETag,entity,ecs address). After this operation, Publication child can be used to public something new.

getEntity

java.lang.String getEntity()

Retrieve entity for which this child publishes.

Returns:

getETag

java.lang.String getETag()

Retrieve ETag used in last publish request.

Returns:

setParentSbb

void setParentSbb(PublicationClientParentSbbLocalObject parent)

Set parent which will be notified about call results.

Parameters:

parent -