oracle.syndicate.client
Interface SyndicateConnection

public interface SyndicateConnection

Provides methods for Oracle Syndication Services client applications to interact with the server. Its methods allows for requesting a catalog of available offers, subscribe to offers, request content packages. It also provides subscription management and package management APIs.

Since:

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

Method Summary

Cancellation	cancelSubscription(java.lang.String subscriptionID, java.lang.String reason, java.lang.String xmlLang) Sends a request for the cancellation of the supplied subscription for the supplied reasons.
OfferResponse	changeSubscription(java.lang.String subscriptionID) Sends a request for a change of the supplied subscription.
void	close() Closes the connection to the syndication server and release the associated resources.
Response	confirm(java.lang.String packageID) Sends the confirmation for the delivery of a previous content package.
Catalog	getCatalog() Returns the catalog of offers available for subscription.
EventsResponse	getEvents(ISODateTime dStart, ISODateTime dStop, java.lang.String subscriptionID) Returns the list of event performed by this subscriber in the supplied time period for the supplied subscription.
PackageResponse	getPackage(java.lang.String subscriptionID, java.lang.String params, SAXPackageHandler pkgHndlr) Sends an get package request for the supplied subscription.
PackageResponse	getPackage(java.lang.String subscriptionID, java.lang.String currentState, java.lang.String params, SAXPackageHandler icePkgHndlr) Sends an get package request for the supplied subscription.
StatusResponse	getStatus() Returns a status summary for all the subscriptions owned by the subscriber associated with this connection.
StatusResponse	getStatus(java.lang.String subscriptionID) Returns a status summary for the supplied subscription owned by the subscriber associated with this connection.
SyndicateSubscriber	getSubscriber() Returns the subscriber associated with this connection
Response	ping() Pings the syndication server associated with this connection to verify if it alive.
Response	push(java.lang.String subscriptionID, java.lang.String state) Sends a request asking server to push now on the provided subscription id The following responses are expected under different conditions condition 1: the request is valid and push has been scheduled response : ICE-CODE with status code 200 condition 2: the request is invalid because the push deliveryrule is not allowed to push at this time response : ICE-CODE with status code 422 condition 3: the request is invalid because there is no push deliveryrule associated with this subscription response : ICE-CODE with status code 409
SubscriptionResponse	subscribe(Offer offer) Sends a request for subscription to the supplied offer and starts negotiation process with the syndicator.
Response	unconfirm(java.lang.String packageID) Sends the negative confirmation for the delivery of a previous content package: by doing so, the user notifies the server that the previous delivered package has not been received correctly and therefore its content will have to be re-delivered in the next get package request.

Method Detail

getSubscriber

public SyndicateSubscriber getSubscriber()

Returns the subscriber associated with this connection

ping

public Response ping()
              throws SyndicateException

Pings the syndication server associated with this connection to verify if it alive.

cancelSubscription

public Cancellation cancelSubscription(java.lang.String subscriptionID,
                                       java.lang.String reason,
                                       java.lang.String xmlLang)
                                throws SyndicateException

Sends a request for the cancellation of the supplied subscription for the supplied reasons.

changeSubscription

public OfferResponse changeSubscription(java.lang.String subscriptionID)
                                 throws SyndicateException

Sends a request for a change of the supplied subscription. The respose is an offer response which can be modified accordingly to the desired change, (e.g. change a push URL) and then re-submitted to the server using the subscribe method.

getCatalog

public Catalog getCatalog()
                   throws SyndicateException

Returns the catalog of offers available for subscription.

getEvents

public EventsResponse getEvents(ISODateTime dStart,
ISODateTime dStop,
                                java.lang.String subscriptionID)
                         throws SyndicateException

Returns the list of event performed by this subscriber in the supplied time period for the supplied subscription.

getPackage

public PackageResponse getPackage(java.lang.String subscriptionID,
                                  java.lang.String params,
SAXPackageHandler pkgHndlr)
                           throws SyndicateException

Sends an get package request for the supplied subscription. The subscription state will be retrieved using the registered SyndicateClientStateHandler if any. Upon receiving the response from the server it updates the state of the subscription.

Parameters:

subscriptionID, - ID of the subscription for which the get package request is issued.

param, - optional parameters associated with this get package request

pkgHndlr, - Package handler to be invoked to store the received package content

Returns:

PackageResponse contains the package metadata such as pkg ID but not the content. The content can be process and stored by the supplied SAXPackageHandler.

getPackage

public PackageResponse getPackage(java.lang.String subscriptionID,
                                  java.lang.String currentState,
                                  java.lang.String params,
SAXPackageHandler icePkgHndlr)
                           throws SyndicateException

Sends an get package request for the supplied subscription. The subscription state will be retrieved using the registered SyndicateClientStateHandler if any. Upon receiving the response from the server it updates the state of the subscription.

Parameters:

subscriptionID, - ID of the subscription for which the get package request is issued.

param, - optional parameters associated with this get package request

pkgHndlr, - Package handler to be invoked to store the received package content

Returns:

PackageResponse contains the package metadata such as pkg ID but not the content. The content can be process and stored by the supplide SAXPackageHandler. If the returned PackageResponse shows that a confirmation is necessary, the confirm method with the package ID as a parameter can be used to confirm the complete delivery of the content package.

getStatus

public StatusResponse getStatus()
                         throws SyndicateException

Returns a status summary for all the subscriptions owned by the subscriber associated with this connection.

getStatus

public StatusResponse getStatus(java.lang.String subscriptionID)
                         throws SyndicateException

Returns a status summary for the supplied subscription owned by the subscriber associated with this connection.

confirm

public Response confirm(java.lang.String packageID)
                 throws SyndicateException

Sends the confirmation for the delivery of a previous content package.

Parameters:

packageID, - ID of the package that you want to confirm. The ID can be accessed through the PackageResponse structure returned by the getPackage call.

unconfirm

public Response unconfirm(java.lang.String packageID)
                   throws SyndicateException

Sends the negative confirmation for the delivery of a previous content package: by doing so, the user notifies the server that the previous delivered package has not been received correctly and therefore its content will have to be re-delivered in the next get package request.

Parameters:

packageID, - ID of the package that you want to unconfirm. The ID can be accessed through the PackageResponse structure returned by the getPackage call.

subscribe

public SubscriptionResponse subscribe(Offer offer)
                               throws SyndicateException,
NegotiationException

Sends a request for subscription to the supplied offer and starts negotiation process with the syndicator. If the negotation is required, NegotiationException will be raised, otherwise SyndicateSubscription will be returned.

close

public void close()
           throws SyndicateException

Closes the connection to the syndication server and release the associated resources.

push

public Response push(java.lang.String subscriptionID,
                     java.lang.String state)
              throws SyndicateException

Sends a request asking server to push now on the provided subscription id The following responses are expected under different conditions condition 1: the request is valid and push has been scheduled response : ICE-CODE with status code 200 condition 2: the request is invalid because the push deliveryrule is not allowed to push at this time response : ICE-CODE with status code 422 condition 3: the request is invalid because there is no push deliveryrule associated with this subscription response : ICE-CODE with status code 409