com.ibm.portal.resolver
Interface Lookup

All Superinterfaces:

Disposable

public interface Lookup
extends Disposable

Constructs an XML source document that represents an individual ATOM entry. This entry contains metadata for the POC in addition to the URLs to the POC services that are associated with the URI.

Implementations of Lookup do not need to be threadsafe, because clients will call the LookupService to get new instances on a per-context basis. Cleanup and potential object pooling can be done via the implementation of the Disposable interface. Clients are required to call Disposable.dispose() for each instance of Lookup.

Example of a calling sequence

 LookupService service = ...;
 Lookup lookup = service.newLookup(...);
 try {
   Source src = lookup.getSource();
   ...
 } finally {
   lookup.dispose();
 }
 

Consider to implement the interface XmlDataSource and CacheControlDataSource to specify cache headers. The expiration for the default implementation can be configured via a config service setting. Use remote.cache.expiration.view.SCHEME as the key for the expiry for the view lookup and remote.cache.expiration.download.SCHEME as the key for the expiry for the download lookup.

Since:

6.1.0

See Also:

XmlDataSource, CacheControlDataSource

Note:

This interface is designed to be implemented by clients.

Method Summary

javax.xml.transform.Source

getSource() Returns a new JAXP source object that can be used to generate a stream of XML events that represent an ATOM entry.

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

getSource

javax.xml.transform.Source getSource()
                                     throws javax.xml.transform.TransformerException,
                                            org.xml.sax.SAXException,
                                            java.io.IOException

Returns a new JAXP source object that can be used to generate a stream of XML events that represent an ATOM entry.

Returns:

The source object of the XML events, must not be null.

Throws:

javax.xml.transform.TransformerException - - if a potential transformation used to generate the source failed

org.xml.sax.SAXException - - if a SAX exception occurred

java.io.IOException - - if an IO exception occurred