oracle.syndication.client.local
Interface ICEClient

All Known Implementing Classes:

ICESampleClient

public abstract interface ICEClient

Interface that an ICE Client should expect from a client library that communicates using ICE 1.1 to an ICE Server.

Method Summary

Type	Method
java.io.Reader	createGetCatalogPayload(java.lang.String szPayloadId, java.lang.String szRequestId) Creates the get-catalog request payload as a reader
java.io.Reader	createGetPackagePayload(java.lang.String szPayloadId, java.lang.String szRequestId, java.lang.String szSubscriptionId, java.lang.String szCurrState) Creates the get-package request payload as a reader
java.io.Reader	createSubscribePayload(java.lang.String szPayloadId, java.lang.String szRequestId, Ice_offer offer) Creates the subscribe (ice-offer) request payload as a reader
java.io.Reader	createUnsubscribePayload(java.lang.String szPayloadId, java.lang.String szRequestId, java.lang.String szSubscriptionId) Creates the cancel-subscription request payload as a reader
Ice_payload	getCatalog(java.lang.String payload_id, java.lang.String request_id) Asks for the catalog from the specified server.
Ice_payload	getEvents(java.lang.String payload_id, java.lang.String request_id, java.lang.String format, ISODatetime start, ISODatetime stop, java.lang.String subscription_id) get events for a specified subscription within certain timeframe
java.lang.String	getId() Each client should have a unique Identifier to use to set the sender-id attribute in an ice-sender.
int	getInterval() Each client should have the default value for its preference for PUSH delivery interval
java.lang.String	getName() Each client should have a name that can be used set the sender-name attribute in an ice-sender
Ice_payload	getPackage(java.lang.String payload_id, java.lang.String request_id, java.lang.String subscription_id, java.lang.String current_state) PULL package ( content ) for an existing subscription
Ice_payload	getStatus(java.lang.String payload_id, java.lang.String request_id, java.lang.String subscription_id) get status for a specified subscription
java.lang.String	getUri() Each client should be able to tell the server which URL to PUSH the content to if the content that is subscribed to supports the PUSH model of delivery.
Ice_payload	subscribe(java.lang.String payload_id, java.lang.String request_id, Ice_offer ice_offer) Subscribe to the offer from the catalog provided by the server and establish the business term and delivery policies
Ice_payload	unsubscribe(java.lang.String payload_id, java.lang.String request_id, java.lang.String szSubscriptionId) Cancel subscription

Method Detail

getId

public java.lang.String getId()

Each client should have a unique Identifier to use to set the sender-id attribute in an ice-sender.

getName

public java.lang.String getName()

Each client should have a name that can be used set the sender-name attribute in an ice-sender

getUri

public java.lang.String getUri()

Each client should be able to tell the server which URL to PUSH the content to if the content that is subscribed to supports the PUSH model of delivery.

getInterval

public int getInterval()

Each client should have the default value for its preference for PUSH delivery interval

createGetCatalogPayload

public java.io.Reader createGetCatalogPayload(java.lang.String szPayloadId,
                                              java.lang.String szRequestId)

Creates the get-catalog request payload as a reader

createSubscribePayload

public java.io.Reader createSubscribePayload(java.lang.String szPayloadId,
                                             java.lang.String szRequestId,
                                             Ice_offer offer)

Creates the subscribe (ice-offer) request payload as a reader

createUnsubscribePayload

public java.io.Reader createUnsubscribePayload(java.lang.String szPayloadId,
                                               java.lang.String szRequestId,
                                               java.lang.String szSubscriptionId)

Creates the cancel-subscription request payload as a reader

createGetPackagePayload

public java.io.Reader createGetPackagePayload(java.lang.String szPayloadId,
                                              java.lang.String szRequestId,
                                              java.lang.String szSubscriptionId,
                                              java.lang.String szCurrState)

Creates the get-package request payload as a reader

getCatalog

public Ice_payload getCatalog(java.lang.String payload_id,
                              java.lang.String request_id)
                       throws OSSException

Asks for the catalog from the specified server.

Parameters:

payload_id - The sender specifies the unique id for the "get-catalog" request payload

request_id - The sender spefified the unique id for the individual request inside the GETCATALOG request payload ( mutiple request supported in ICE1.1)

Returns:

Response payload from the syndication server

subscribe

public Ice_payload subscribe(java.lang.String payload_id,
                             java.lang.String request_id,
                             Ice_offer ice_offer)
                      throws OSSException

Subscribe to the offer from the catalog provided by the server and establish the business term and delivery policies

Parameters:

payload_id - The sender specifies the unique id for the "subscribe" request payload

request_id - The sender spefified the unique id for the individual request inside the "subscribe" request payload ( mutiple request supported in ICE1.1)

ice_offer - The offer list which the subscriber is about to subscribe to.

Returns:

Server response

unsubscribe

public Ice_payload unsubscribe(java.lang.String payload_id,
                               java.lang.String request_id,
                               java.lang.String szSubscriptionId)
                        throws OSSException

Cancel subscription

Parameters:

payload_id - The payload id generated by the local client system. Must be unique across all the payloads sent out by this client application.

request_id - The request id to identify the current "cancel- subscription" request which is generated by the local client system and should be unique within the same ice payload across all the requests.

szSubscriptionId - The unique id known to both the client ( as the subscriber ) and the syndication server, which is assigned to the client by the server during the subscribing time

Returns:

Server response

getPackage

public Ice_payload getPackage(java.lang.String payload_id,
                              java.lang.String request_id,
                              java.lang.String subscription_id,
                              java.lang.String current_state)
                       throws OSSException

PULL package ( content ) for an existing subscription

Parameters:

payload_id - The payload id generated by the local client system. Must be unique across all the payloads sent out by this client application.

request_id - The request id to identify the current "get-package" request which is generated by the local client system and should be unique within the same ice payload across all the requests.

szSubscriptionId - The unique id known to both the client ( as the subscriber ) and the syndication server, which is assigned to the client by the server during the subscribing time.

Returns:

Server response

getStatus

public Ice_payload getStatus(java.lang.String payload_id,
                             java.lang.String request_id,
                             java.lang.String subscription_id)
                      throws OSSException

get status for a specified subscription

Parameters:

payload_id - The payload id generated by the local client system. Must be unique across all the payloads sent out by this client application.

request_id - The request id to identify the current "get-status" request which is generated by the local client system and should be unique within the same ice payload across all the requests.

szSubscriptionId - The unique id known to both the client ( as the subscriber ) and the syndication server, which is assigned to the client by the server during the subscribing time.

Returns:

Server response

getEvents

public Ice_payload getEvents(java.lang.String payload_id,
                             java.lang.String request_id,
                             java.lang.String format,
                             ISODatetime start,
                             ISODatetime stop,
                             java.lang.String subscription_id)
                      throws OSSException

get events for a specified subscription within certain timeframe

Parameters:

payload_id - The payload id generated by the local client system. Must be unique across all the payloads sent out by this client application.

request_id - The request id to identify the current "get-status" request which is generated by the local client system and should be unique within the same ice payload across all the requests.

format - should be "ice" in current implementation

start - used to filter returned events

stop - used to filter returned events

szSubscriptionId - The unique id known to both the client ( as the subscriber ) and the syndication server, which is assigned to the client by the server during the subscribing time.

Returns:

Server response