BeanTransporterBase

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.novell.sentinel.client.bean
Class BeanTransporterBase

java.lang.Object
  com.novell.sentinel.client.bean.BeanTransporterBase<B,P>


Type Parameters:: B - Bean type (e.g., IdentityBean); P - HTTP content parser type (e.g., JSONParser or org.xml.sax.Parser)

All Implemented Interfaces:: BeanTransporter

Direct Known Subclasses:: BeanTransporterJSON, BeanTransporterSyncBase

public abstract class BeanTransporterBase
extends Object
implements BeanTransporter
extends Object
implements BeanTransporter

Base class for GWT and asynchronous Java BeanTransporter implementations.

Nested Class Summary
`static class`	`BeanTransporterBase.ParseException` Generic carrier exception to allow derived classes to report errors in parsing HTTP results.

Field Summary

Fields inherited from interface com.novell.sentinel.client.bean.BeanTransporter
`NO_FIELDS, UNLIMITED_PAGE_SIZE`

Constructor Summary
`protected`	`BeanTransporterBase(BeanMetaData<? extends B> _beanMD, HttpRequestor<P> _requestor, UriConstructorFactory _urlFactory)` Constructor for derived classes.

Method Summary
`void`	`cleanup(String url, OnBeanDelete handler)` Issues a cleanup request to the server for the passed URL.
`void`	`count(OnBeanCount handler)` Get a count of the data instances available.
`void`	`count(String query, OnBeanCount handler)` Get a count of the data instances available, optionally filtered by the passed query.
`protected abstract B`	`createBean(P parser)` Derived classes must create a single instance of class B from the HTTP GET result content obtained from the parser parameter.
`protected abstract PagedBeanCollection<B>`	`createPage(P parser)` Derived classes must create a PagedBeanCollection instance based on the HTTP GET result content obtained from the parser parameter.
`protected abstract P`	`createParser(B bean)` Derived classes must create a data source from which can be obtained the content data for an HTTP PUT or POST request.
`void`	`delete(B bean, OnBeanDelete handler)` Delete the data instance represented by the passed bean.
`void`	`delete(String url, OnBeanDelete handler)` Delete the data instance at the specified URL.
`void`	`get(String url, Iterable<String> fields, OnBeanLoad<B> handler)` Get the data at the passed URL in a bean.
`void`	`get(String url, OnOctetStreamLoad handler)` Get the octet stream value of an object attribute referenced by the passed URL.
`protected BeanMetaData<? extends B>`	`getBeanMD()` Return the metadata for the bean-type handled by this instance.
`String`	`getLocaleName()` Get the locale name currently set in the implementing instance.
`HttpRequestor<P>`	`getRequestor()` Get the HttpRequestor used by this instance.
`List<String>`	`getSortFields()` Get the sort field names currently set in the implementing instance.
`UriConstructorFactory`	`getUrlFactory()` Get the URL creator factory used by this instance.
`void`	`list(OnBeanPageLoad<B> handler)` Get a collection of the beans available.
`void`	`list(String query, int pageSize, Iterable<String> fields, boolean getChangeCounts, OnBeanPageLoad<B> handler)` Get a collection of the data instances available, optionally filtered by the passed query.
`void`	`list(String query, int pageSize, Iterable<String> fields, OnBeanPageLoad<B> handler)` Get a collection of the data instances available, optionally filtered by the passed query.
`void`	`listFromURL(String url, int pageSize, Iterable<String> fields, boolean getChangeCounts, OnBeanPageLoad<B> handler)` Get a collection of the data instances available at the passed URL.
`void`	`listFromURL(String url, int pageSize, Iterable<String> fields, OnBeanPageLoad<B> handler)` Get a collection of the data instances available at the passed URL.
`void`	`listFromURL(String url, OnBeanPageLoad<B> handler)` Get a collection of the beans available at the passed URL.
`protected abstract long`	`parseCount(P parser)` Derived classes must parse the item count returned as a result of an HTTP GET request.
`protected abstract String`	`parseURL(P parser)` Derived classes must parse the URL returned as a result of an HTTP POST request.
`void`	`post(B bean, OnBeanPost handler)` Create a new data instance.
`void`	`put(B bean, OnBeanPut handler)` Update the underlying Sentinel data from the passed bean.
`void`	`put(String url, byte[] data, OnBeanPut handler)` Put the octet stream value of an object attribute referenced by the passed URL.
`void`	`setLocaleName(String localeName)` Set the name of the locale to use to sort list results if an order is used.
`void`	`setSortFields(List<String> sortFields)` Set list of field names on which to sort list results.

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

Constructor Detail

BeanTransporterBase

protected BeanTransporterBase(BeanMetaData<? extends B> _beanMD,
                              HttpRequestor<P> _requestor,
                              UriConstructorFactory _urlFactory)

Constructor for derived classes.

Parameters:: _beanMD - The metadata of the SentinelBean implementation.; _requestor - The interface through which HTTP requests will be made.; _urlFactory - The factory instance from which request URLs will be constructed. The factory must return UriConstructor instances which are pre-loaded with the base URL of the Sentinel DataObject REST API.

Method Detail