OracleAS Syndication Services API Reference
10g (9.0.4)

Part No. B10399-01

oracle.syndicate.client.servlet
Class SyndicateClientServlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--oracle.syndicate.client.servlet.SyndicateClientServlet
All Implemented Interfaces:
java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, oracle.syndicate.client.exmsgs.SyndicateClientExceptionConstants

public class SyndicateClientServlet
extends javax.servlet.http.HttpServlet
implements oracle.syndicate.client.exmsgs.SyndicateClientExceptionConstants

Parametrizable servlet class which can be configured as a listener for content packages pushed by syndication services. The servlet expects one servlet parameter to be set in its web.xml to identify the name class be used for its SyndicatorRequestHandler. The Servlet dynamically loads the class specified during its init and delegates the handling of incoming packages to it. An implementation of the SyndicatorRequestHandler which stores pushed content to the file system using the FileSAXPackageHandler is supplied in the FileSyndicatorRequestHandler. To configure the SyndicateClientServlet to use the such handler, add the following servlet parameters in the web.xml of your war module:

<init-param>
<param-name>oracle.syndicate.client.handler.SyndicatorRequestHandler</param-name>
<param-value>oracle.syndicate.client.handler.file.FileSyndicatorRequestHandler</param-value>
</init-param>
<init-param>
<param-name>oracle.syndicate.client.handler.file.FileSyndicatorRequestHandler.rootDir</param-name>
<param-value>/tmp/syndication_client</param-value>
</init-param>

The second parameter is used to supply the location in the file system where the syndicated pushed content will be stored.

Upon a successful processing of a pushed package - meaning that all the package content has been received, if necessary decoded, and finally stored, the SyndicateClientServlet replies to the server with a "received and confirm" code. If the pushed package required a delivery confirmation such confirmation will be returned with the reply code and not in a separate round trip as it is required in the pull case.

Since:
release specific (what release of product did this appear in)
See Also:
Serialized Form

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

 

Constructor Summary
SyndicateClientServlet()
           

 

Method Summary
 void destroy()
           
 void doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void init(javax.servlet.ServletConfig config)
          Initalizes the servlet by instanting the SyndicatorRequestHandler to be used and settings its proerpties.

 

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

 

Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

SyndicateClientServlet

public SyndicateClientServlet()
Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException
Initalizes the servlet by instanting the SyndicatorRequestHandler to be used and settings its proerpties. The propertis to be set are identifed by all the properties whose name startes with the class name of the SyndicatorRequestHandler specified.
Overrides:
init in class javax.servlet.GenericServlet

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   java.io.IOException
Overrides:
doPost in class javax.servlet.http.HttpServlet

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  java.io.IOException
Overrides:
doGet in class javax.servlet.http.HttpServlet

destroy

public void destroy()
Overrides:
destroy in class javax.servlet.GenericServlet

Copyright © 2001, 2003, Oracle. All rights reserved.

Copyright © 2001, 2003, Oracle. All rights reserved.