com.ibm.tivoli.maximo.skd.applet

Class SerializedDataManager<RequestType,ReplyType>

java.lang.Object

com.ibm.tivoli.maximo.skd.applet.SerializedDataManager<RequestType,ReplyType>

Direct Known Subclasses:

AppletActionSerializedDataManager, CachedDataManager, CapacityPlanningDataManager, FWMDataManager, ItemDataManager, OtherResourcesDataManager

public abstract class SerializedDataManager<RequestType,ReplyType>
extends java.lang.Object

Data Manager for managing the interactions between the applet and the server. A DataManager requires that you implement the createUrl() method and that the servlet that you are calling returns the serialized data in its body response. Optionally, but recommended, you can also implemented the getRemoteObjectInstance() method to ensure that your data manager also works in Standalone App mode (ie, for developmer testing) Where possible you should use the fetch() method which does an asynchronous call to the server and returns the reply to the passed SerializedDataManager.AsyncReply handler. If required, you can can call the fetchAndWait() method, but the user experience may be degraded, since the UI will be blocked while the operation is happening. The SerializedDataManager is a generic class and you need to pass your own RequestType and ReplyType.

Author:

sls

See Also:

for an example of how to implement a {@link SerializedDataManager}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SerializedDataManager.AsyncReply<ReplyType> Async Reply Handler for handling the remote reply

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTP_ONLY_COOKIES skdviewer.properties entry for enabling httpOnly cookies

Constructor Summary

Constructors

Constructor and Description
SerializedDataManager() Create serialize data manager with default pool size

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelCurrentRequests() Cancel any currently running tasks to make room in the pool for new submissions
boolean	convertReplyToObject() Returns true if the HTTP reply (ie the data stream) could be converted into an object.
void	fetch(RequestType args, SerializedDataManager.AsyncReply<ReplyType> replyHandler) Fetches the data from the server.
ReplyType	fetchAndWait(RequestType args) Fetches the data from the server and waits for a reply.
boolean	isBusy(RequestType args) Returns true if the manager is currently servicing the request.
boolean	isCompressed() Return true if the reply stream is a compressed object.
boolean	isPost() Return true if the HTTP communications should POST the data.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTTP_ONLY_COOKIES

public static final java.lang.String HTTP_ONLY_COOKIES

skdviewer.properties entry for enabling httpOnly cookies

See Also:

Constant Field Values

Constructor Detail

SerializedDataManager

public SerializedDataManager()

Create serialize data manager with default pool size

Method Detail

cancelCurrentRequests

public void cancelCurrentRequests()

Cancel any currently running tasks to make room in the pool for new submissions

isPost

public boolean isPost()

Return true if the HTTP communications should POST the data. Would require that the implementation also implement the postData() method.

Returns:

convertReplyToObject

public boolean convertReplyToObject()

Returns true if the HTTP reply (ie the data stream) could be converted into an object. The default is true, so that the response data will be converted to the ReplyType instance, but there may be cases where you don't want this to happen. For example if you are sending data to the server, and your response type is Void then set override this method to return false;

Returns:

isCompressed

public boolean isCompressed()

Return true if the reply stream is a compressed object. Returing true here will append the compress flag to the url, so that the server will compress the stream before sending it back.

Returns:

isBusy

public boolean isBusy(RequestType args)

Returns true if the manager is currently servicing the request. If you don't want to have multiple hits to the server for the same operation, then check this before calling fetch()

Parameters:

args - serice args that would have been passed to the fetch() operation

Returns:

fetch

public void fetch(RequestType args,
         SerializedDataManager.AsyncReply<ReplyType> replyHandler)

Fetches the data from the server. createUrl() is called to craft the URL and the service is invoked in a new thread. The SerializedDataManager.AsyncReply handler will be notified about the response.

Parameters:

args - URL/Service parameters to be passed to createUrl()

replyHandler - SerializedDataManager.AsyncReply instance to handle the success or error

fetchAndWait

public ReplyType fetchAndWait(RequestType args)
                       throws java.lang.Exception

Fetches the data from the server and waits for a reply. It is not recommended to use this method since it will cause a UI performance issue as you make the user wait for a reply from the server.

Parameters:

args - service/url parameters to be passed to createUrl()

Returns:

data instance from the server

Throws:

java.lang.Exception - if there was an error