com.ebmwebsourcing.wsstar.notification.definition.inout
Class WSNotificationWriter

java.lang.Object
  com.ebmwebsourcing.wsstar.notification.definition.inout.WSNotificationWriter

public class WSNotificationWriter
extends java.lang.Object

This class provides a collection of methods that enable conversion of a "WS-{Base/Brokered}Notification java type" object into a Document object. This conversion uses JAXB "unmarshalling" mechanism

Author:

Thierry Déjean - eBM WebSourcing

Method Summary

static WSNotificationWriter	getInstance() Return an unique - respect to the Singleton design pattern - instance of the WSNotificationWriter class.
static WSNotificationWriter	getInstance(java.lang.String[] nsAndPrefixForMarshalling) Return an unique - respect to the Singleton design pattern - instance of the WSNotificationWriter class.
org.w3c.dom.Document	writeDestroyRegistration(DestroyRegistration destRegObj) marchall a DestroyRegistration object.
org.w3c.dom.Document	writeDestroyRegistrationResponse(DestroyRegistrationResponse destRegRespObj) marchall a DestroyRegistrationResponse object.
org.w3c.dom.Document	writeGetCurrentMessage(GetCurrentMessage getCurMsgObj) marshall an GetCurrentMessage object
org.w3c.dom.Document	writeGetCurrentMessageResponse(GetCurrentMessageResponse getCurMsgRespObj) marshall an GetCurrentMessageResponse object
org.w3c.dom.Document	writeMessageType(Message message) marshall a Message object
org.w3c.dom.Document	writeNotify(Notify notifyObj) marchall a Notify object.
org.w3c.dom.Document	writePublisherRegistrationRP(PublisherRegistrationRP pubRegRPObj) marchall a PublisherRegistrationRP object.
void	writePublisherRegistrationRP(PublisherRegistrationRP registrationRP, java.io.File persist) method used to persist PublisherRegistrationRP java object to a file
org.w3c.dom.Document	writeQueryExpressionType(QueryExpressionType queryExpression) marshall a QueryExpressionType object
org.w3c.dom.Document	writeRegisterPublisher(RegisterPublisher regPubObj) marchall a RegisterPublisher object.
org.w3c.dom.Document	writeRegisterPublisherResponse(RegisterPublisherResponse regPubRespObj) marchall a RegisterPublisherResponse object.
org.w3c.dom.Document	writeRenew(Renew renewObj) marshall an Renew object
org.w3c.dom.Document	writeRenewResponse(RenewResponse renewRespObj) marshall an RenewResponse object
org.w3c.dom.Document	writeSubscribe(Subscribe subsObj) marshall a Subscribe object
org.w3c.dom.Document	writeSubscribeResponse(SubscribeResponse subsRespObj) marshall a SubscribeResponse object
void	writeSubscribeResponse(SubscribeResponse subscribeResp, java.io.File persist) method used to persist SubscribeResponse java object to a file
org.w3c.dom.Document	writeSubscriptionManagerRP(SubscriptionManagerRP subsRPObj) marshall a SubscriptionManagerRP object
void	writeSubscriptionManagerRP(SubscriptionManagerRP subscriptionRP, java.io.File persist) method used to persist SubscriptionManagerRP java object to a file
void	writeSubscriptionToFile(SubscriptionManagerRP subscription, java.io.File file) marshall a SubscriptionManagerRP into a file (used to persist the java object)
org.w3c.dom.Document	writeTopicExpressionType(TopicExpressionType topicExpression) marshall a TopicExpressionType object
org.w3c.dom.Document	writeTopicNamespaceType(TopicNamespaceType namespace) marshall a TopicNamespaceType object
org.w3c.dom.Document	writeTopicSetType(TopicSetType topicSet) marshall a TopicSetType object
org.w3c.dom.Document	writeTopicType(TopicType topic) marshall a TopicType object
org.w3c.dom.Document	writeUnsubscribe(Unsubscribe unsubsObj) marshall an Unsubscribe object
org.w3c.dom.Document	writeUnsubscribeResponse(UnsubscribeResponse unsubsRespObj) marshall an UnsubscribeResponse object

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static WSNotificationWriter getInstance()

Return an unique - respect to the Singleton design pattern - instance of the WSNotificationWriter class.

Returns:

a unique WSNotificationFactory instance.

getInstance

public static WSNotificationWriter getInstance(java.lang.String[] nsAndPrefixForMarshalling)

Return an unique - respect to the Singleton design pattern - instance of the WSNotificationWriter class.

Returns:

a unique WSNotificationFactory instance.

writeNotify

public org.w3c.dom.Document writeNotify(Notify notifyObj)
                                 throws WSNotificationException

marchall a Notify object.

Parameters:

notifyObj - Notify Java object to marshall

Returns:

Document representation of the Notify Java type

Throws:

WSNotificationException

writeRegisterPublisher

public org.w3c.dom.Document writeRegisterPublisher(RegisterPublisher regPubObj)
                                            throws WSNotificationException

marchall a RegisterPublisher object.

Parameters:

regPubObj - RegisterPublisher Java object to marshall

Returns:

Document representation of the RegisterPublisher Java type

Throws:

WSNotificationException

writeRegisterPublisherResponse

public org.w3c.dom.Document writeRegisterPublisherResponse(RegisterPublisherResponse regPubRespObj)
                                                    throws WSNotificationException

marchall a RegisterPublisherResponse object.

Parameters:

regPubRespObj - RegisterPublisherResponse Java object to marshall

Returns:

Document representation of the RegisterPublisherResponse Java type

Throws:

WSNotificationException

writePublisherRegistrationRP

public org.w3c.dom.Document writePublisherRegistrationRP(PublisherRegistrationRP pubRegRPObj)
                                                  throws WSNotificationException

marchall a PublisherRegistrationRP object.

Parameters:

pubRegRPObj - PublisherRegistrationRP Java object to marshall

Returns:

Document representation of the PublisherRegistrationRP Java type

Throws:

WSNotificationException

writeDestroyRegistration

public org.w3c.dom.Document writeDestroyRegistration(DestroyRegistration destRegObj)
                                              throws WSNotificationException

marchall a DestroyRegistration object.

Parameters:

destRegObj - DestroyRegistration Java object to marshall

Returns:

Document representation of the DestroyRegistration Java type

Throws:

WSNotificationException

writeDestroyRegistrationResponse

public org.w3c.dom.Document writeDestroyRegistrationResponse(DestroyRegistrationResponse destRegRespObj)
                                                      throws WSNotificationException

marchall a DestroyRegistrationResponse object.

Parameters:

destRegRespObj - DestroyRegistrationResponse Java object to marshall

Returns:

Document representation of the DestroyRegistrationResponse Java type

Throws:

WSNotificationException

writeSubscribe

public org.w3c.dom.Document writeSubscribe(Subscribe subsObj)
                                    throws WSNotificationException

marshall a Subscribe object

Parameters:

subsObj - SubscribeResponse Java object to marshall

Returns:

Document representation of the Subscribe Java type

Throws:

WSNotificationException

writeSubscribeResponse

public org.w3c.dom.Document writeSubscribeResponse(SubscribeResponse subsRespObj)
                                            throws WSNotificationException

marshall a SubscribeResponse object

Parameters:

subsRespObj - SubscribeResponse Java object to marshall

Returns:

Document representation of the SubscribeResponse Java type

Throws:

WSNotificationException

writeUnsubscribe

public org.w3c.dom.Document writeUnsubscribe(Unsubscribe unsubsObj)
                                      throws WSNotificationException

marshall an Unsubscribe object

Parameters:

unsubsObj - Unsubscribe Java object to marshall

Returns:

Document representation of the Unsubscribe Java type

Throws:

WSNotificationException

writeUnsubscribeResponse

public org.w3c.dom.Document writeUnsubscribeResponse(UnsubscribeResponse unsubsRespObj)
                                              throws WSNotificationException

marshall an UnsubscribeResponse object

Parameters:

unsubsRespObj - UnsubscribeResponse Java object to marshall

Returns:

Document representation of the UnsubscribeResponse Java type

Throws:

WSNotificationException

writeGetCurrentMessage

public org.w3c.dom.Document writeGetCurrentMessage(GetCurrentMessage getCurMsgObj)
                                            throws WSNotificationException

marshall an GetCurrentMessage object

Parameters:

getCurMsgObj - GetCurrentMessage Java object to marshall

Returns:

Document representation of the GetCurrentMessage Java type

Throws:

WSNotificationException

writeGetCurrentMessageResponse

public org.w3c.dom.Document writeGetCurrentMessageResponse(GetCurrentMessageResponse getCurMsgRespObj)
                                                    throws WSNotificationException

marshall an GetCurrentMessageResponse object

Parameters:

getCurMsgRespObj - GetCurrentMessageResponse Java object to marshall

Returns:

Document representation of the GetCurrentMessageResponse Java type

Throws:

WSNotificationException

writeRenew

public org.w3c.dom.Document writeRenew(Renew renewObj)
                                throws WSNotificationException

marshall an Renew object

Parameters:

renewObj - Renew Java object to marshall

Returns:

Document representation of the Renew Java type

Throws:

WSNotificationException

writeRenewResponse

public org.w3c.dom.Document writeRenewResponse(RenewResponse renewRespObj)
                                        throws WSNotificationException

marshall an RenewResponse object

Parameters:

renewRespObj - RenewResponse Java object to marshall

Returns:

Document representation of the RenewResponse Java type

Throws:

WSNotificationException

writeSubscriptionToFile

public void writeSubscriptionToFile(SubscriptionManagerRP subscription,
                                    java.io.File file)
                             throws WSNotificationException

marshall a SubscriptionManagerRP into a file (used to persist the java object)

Parameters:

subscription - the SubscriptionManagerRP java object to persist

file - File object used to persist SubscriptionManagerRP Object

Throws:

WSNotificationException

writeSubscriptionManagerRP

public org.w3c.dom.Document writeSubscriptionManagerRP(SubscriptionManagerRP subsRPObj)
                                                throws WSNotificationException

marshall a SubscriptionManagerRP object

Parameters:

subsRPObj - SubscriptionManagerRP Java object to marshall

Returns:

Document representation of the SubscriptionManager Java type

Throws:

WSNotificationException

writeTopicExpressionType

public org.w3c.dom.Document writeTopicExpressionType(TopicExpressionType topicExpression)
                                              throws WSNotificationException

marshall a TopicExpressionType object

Parameters:

topicExpression - TopicExpressionType Java object to marshall

Returns:

representation of the TopicExpressionType Java type

Throws:

WSNotificationException

writeQueryExpressionType

public org.w3c.dom.Document writeQueryExpressionType(QueryExpressionType queryExpression)
                                              throws WSNotificationException

marshall a QueryExpressionType object

Parameters:

topicExpression - QueryExpressionType Java object to marshall

Returns:

Document representation of the QueryExpressionType Java type

Throws:

WSNotificationException

writeMessageType

public org.w3c.dom.Document writeMessageType(Message message)
                                      throws WSNotificationException

marshall a Message object

Parameters:

topicExpression - Message Java object to marshall

Returns:

Document representation of the Message Java type

Throws:

WSNotificationException

writeTopicType

public org.w3c.dom.Document writeTopicType(TopicType topic)
                                    throws WSNotificationException

marshall a TopicType object

Parameters:

topic - TopicType Java object to marshall

Returns:

Document representation of the TopicType Java type

Throws:

WSNotificationException

writeTopicNamespaceType

public org.w3c.dom.Document writeTopicNamespaceType(TopicNamespaceType namespace)
                                             throws WSNotificationException

marshall a TopicNamespaceType object

Parameters:

namespace - TopicNamespaceType Java object to marshall

Returns:

Document representation of the TopicNamespaceType Java type

Throws:

WSNotificationException

writeTopicSetType

public org.w3c.dom.Document writeTopicSetType(TopicSetType topicSet)
                                       throws WSNotificationException

marshall a TopicSetType object

Parameters:

namespace - TopicSetType Java object to marshall

Returns:

Document representation of the TopicSetType Java type

Throws:

WSNotificationException

writeSubscriptionManagerRP

public void writeSubscriptionManagerRP(SubscriptionManagerRP subscriptionRP,
                                       java.io.File persist)
                                throws WSNotificationException

method used to persist SubscriptionManagerRP java object to a file

Parameters:

subscriptionRP - the SubscriptionManagerRP java Object to persist

persist - the File which the object must be persisted in

Throws:

WSNotificationException

writeSubscribeResponse

public void writeSubscribeResponse(SubscribeResponse subscribeResp,
                                   java.io.File persist)
                            throws WSNotificationException

method used to persist SubscribeResponse java object to a file

Parameters:

subscriptionRP - the SubscribeResponse java Object to persist

persist - the File which the object must be persisted in

Throws:

WSNotificationException

writePublisherRegistrationRP

public void writePublisherRegistrationRP(PublisherRegistrationRP registrationRP,
                                         java.io.File persist)
                                  throws WSNotificationException

method used to persist PublisherRegistrationRP java object to a file

Parameters:

subscriptionRP - the PublisherRegistrationRP java Object to persist

persist - the File which the object must be persisted in

Throws:

WSNotificationException