oracle.syndicate.client.handler.file
Class FileSAXPackageHandler

java.lang.Object
  |
  +--oracle.syndicate.client.handler.file.FileSAXPackageHandler

All Implemented Interfaces:

SAXHandler, SAXPackageHandler, oracle.syndicate.client.exmsgs.SyndicateClientExceptionConstants

public class FileSAXPackageHandler

extends java.lang.Object

implements SAXPackageHandler, oracle.syndicate.client.exmsgs.SyndicateClientExceptionConstants

Implemenation of the SAXPackageHandler which stores delivered packages in the file system. The root directory used to stored the delivered content is supplied as a constractor parameters.

Since:

release specific (what release of product did this appear in)

Fields inherited from interface oracle.syndicate.client.exmsgs.SyndicateClientExceptionConstants

DAV_PKG_HANDLER_BADROOT, DAV_PKG_HANDLER_CANNOT_CONNECT, DAV_PKG_HANDLER_UNABLE_CLOSE_ITEM, DAV_PKG_HANDLER_UNABLE_CREATE_ITEM, DAV_PKG_HANDLER_UNABLE_DELETE_ITEM, DAV_PKG_HANDLER_UNABLE_FLUSH_ITEM, DAV_SYND_CLIENT_INV_URL, FILE_PKG_HANDLER_BADROOT, FILE_PKG_HANDLER_UNABLE_CLOSE_ITEM, FILE_PKG_HANDLER_UNABLE_CREATE_ITEM, FILE_PKG_HANDLER_UNABLE_FLUSH_ITEM, PORTAL_CANNOT_READ_DAV, PORTAL_ERR_GETTING_CONN, PORTAL_SH_CANNOT_CREATE_SBT, PORTAL_SH_CANNOT_FIND_CHANNEL, PORTAL_SH_CANNOT_FIND_REPORT, PORTAL_SH_CANNOT_FIND_SBB, PORTAL_SH_CANNOT_FIND_SBT, PORTAL_SH_DUPLICATE_SUBSCRIBER, PORTAL_SH_DUPLICATE_SUBSCRIPTION, PORTAL_SH_ERR_GETTING_REPORT, PORTAL_SH_ERR_JNDI_LOOKUP, PORTAL_SH_ERR_REP_BUSY, PORTAL_SH_ERR_SBT_BAD_SBBID, PORTAL_SH_ERR_SBT_BUSY, PORTAL_SH_INVALID_ID_FORMAT, PORTAL_SRH_CANNOT_FIND_CHID, PORTAL_SRH_CANNOT_FIND_CONN, PORTAL_SRH_CANNOT_FIND_DAVURL, STATE_HANDLER_CANNOT_REMOVE_SBB, STATE_HANDLER_UNAVAILABLE, SYND_CLIENT_CANNOT_LOAD, SYND_CLIENT_NO_PROPERTY, UDDI_ADMIN_ONLY_ACTION, UNEXPECTED_INTERNAL_EXCEPTION, XML_ICE_SH_DUPLICATE_SUBSCRIBER, XML_ICE_SH_DUPLICATE_SUBSCRIPTION, XML_ICE_SH_FILE_CANNOTCREATE, XML_ICE_SH_FILE_CANNOTPARSE, XML_ICE_SH_FILE_CANNOTREAD, XML_ICE_SH_FILE_ERRORWRITE, XML_ICE_SH_FILE_ISDIRECTORY, XML_PARSER_CONFIGURATION

Method Summary

void	endItem(SyndicatePackage icePackage, Item iceItem) Called when the end a package item is encountered.
void	endItemGroup(SyndicatePackage icePackage, ItemGroup iceItemGroup) Called when the end a package item group is encountered.
void	endPackage(SyndicatePackage icePackage) Called when the end of a content package is encountered.
void	error(SyndicatePackage icePackage, SyndicateException ex) Called when an error is encoutered while parsing the content package
static FileSAXPackageHandler	getInstance(java.lang.String storageRootDir, boolean bRandomRootDir, java.lang.String sbtID) Factory method returing a new instance of the FileSAXPackageHandler.
void	itemCharacters(SyndicatePackage icePackage, Item iceItem, char[] buff, int iStart, int iLength) Called when a package item content is encountered.
void	itemRef(SyndicatePackage icePackage, ItemRef iceItemRef) Called when a package item reference is encountered.
void	itemRemove(SyndicatePackage icePackage, ItemRemove iceItemRemove) Called when a package item remove is encountered.
void	startItem(SyndicatePackage icePackage, Item iceItem) Called when a new beginning of a package item is encountered.
void	startItemGroup(SyndicatePackage icePackage, ItemGroup iceItemGroup) Called when the beginning a package item group is encountered.
void	startPackage(SyndicatePackage icePackage) Called when a new beginning of a content package is encountered.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FileSAXPackageHandler getInstance(java.lang.String storageRootDir,
                                                boolean bRandomRootDir,
                                                java.lang.String sbtID)
                                         throws SyndicateException

Factory method returing a new instance of the FileSAXPackageHandler. The supplied storageRootDir parameter defines the root directory for the storage of the delivered content. If the destination directory does not exists and cannot be created an exception will be thrown.

Parameters:

storageRootDir - destination directory for the delivered content

startPackage

public void startPackage(SyndicatePackage icePackage)
                  throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when a new beginning of a content package is encountered.

Specified by:

startPackage in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

startItemGroup

public void startItemGroup(SyndicatePackage icePackage,
ItemGroup iceItemGroup)
                    throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when the beginning a package item group is encountered.

Specified by:

startItemGroup in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

ItemGroup - allows for accessing the item group metadata

startItem

public void startItem(SyndicatePackage icePackage,
Item iceItem)
               throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when a new beginning of a package item is encountered.

Specified by:

startItem in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

Item - allows for accessing the item metadata

itemCharacters

public void itemCharacters(SyndicatePackage icePackage,
Item iceItem,
                           char[] buff,
                           int iStart,
                           int iLength)
                    throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when a package item content is encountered.

Specified by:

itemCharacters in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

Item - allows for accessing the item metadata

buff, - buffer containing the item content

buff, - start index in buff for the beginnign of the buffer content

buff, - length of the buffer content

endItem

public void endItem(SyndicatePackage icePackage,
Item iceItem)
             throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when the end a package item is encountered.

Specified by:

endItem in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

Item - allows for accessing the item metadata

endItemGroup

public void endItemGroup(SyndicatePackage icePackage,
ItemGroup iceItemGroup)
                  throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when the end a package item group is encountered.

Specified by:

endItemGroup in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

ItemGroup - allows for accessing the item group metadata

itemRemove

public void itemRemove(SyndicatePackage icePackage,
ItemRemove iceItemRemove)
                throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when a package item remove is encountered.

Specified by:

itemRemove in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

ItemRemove - allows for accessing the item remove metadata

itemRef

public void itemRef(SyndicatePackage icePackage,
ItemRef iceItemRef)
             throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when a package item reference is encountered.

Specified by:

itemRef in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

ItemRef - allows for accessing the item reference metadata

endPackage

public void endPackage(SyndicatePackage icePackage)
                throws SyndicateException

Description copied from interface: SAXPackageHandler

Called when the end of a content package is encountered.

Specified by:

endPackage in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

error

public void error(SyndicatePackage icePackage,
SyndicateException ex)

Description copied from interface: SAXPackageHandler

Called when an error is encoutered while parsing the content package

Specified by:

error in interface SAXPackageHandler

Following copied from interface: oracle.syndicate.client.handler.SAXPackageHandler

Parameters:

SyndicatePackage - allows for accessing package metadata

SyndicateException - the exception raised by during the package content parsing