Main Page | Packages | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

org.openmobileis.services.common.CallingServiceManager Class Reference

List of all members.

Detailed Description

Title: OpenMobileIS project source
Description: Calling service manager is use to keep an historic of different service call to be able to return to a calling service when a specific function has been done.

It can be use to profide facility to fill form. For exemple in a form if you want to provide search to fill a property, you register the form calling service and after search the search result service redirect to the registered form service. For each session a calling service is created. Use the service session to get current calling service. Multiple calling service can be registered. A stack structure is use to push and pop service.

The stack can only be peek. Return URL contain a call to the RegisteredServicePopService that pop the URI and call the registered service URI

Author:
Philippe Delrieu
Since:
JDK 1.1
Version:
1.0.

Definition at line 53 of file CallingServiceManager.java.

Public Member Functions

 CallingServiceManager ()
 Constructor for CallingServiceManager.
Array getRegistedCallingServiceList ()
 return the stack of registered service.
Hashtable getCallingServiceParameters ()
 return the registered service parameters that is on the top of the stack return null if no service is registered
void pushCallingService (String serviceURI, HttpServletRequest req)
 push the specified service name on the calling service stack
String popCallingService ()
 Removes the calling service URI at the top of this stack and returns that calling service URI as the value of this function.
String peekCallingService ()
 Looks at the calling service URI at the top of this stack without removing it from the stack.
String getCallingServiceURL ()
 Verify if a service is registered and return the service url that manage calling service redirection.
boolean isEmpty ()
 Tests if this calling service stack is empty.
boolean peekToTheSpecifiedCallingService (String serviceURI)
 pop the stack until the specified calling service URI is found.
void clearStack ()
 clear the service URI stack


Member Function Documentation

String org.openmobileis.services.common.CallingServiceManager.getCallingServiceURL  ) 
 

Verify if a service is registered and return the service url that manage calling service redirection.

return null if not calling service is registered.

Definition at line 129 of file CallingServiceManager.java.

References org.openmobileis.services.common.CallingServiceManager.peekCallingService().

Array org.openmobileis.services.common.CallingServiceManager.getRegistedCallingServiceList  ) 
 

return the stack of registered service.

This stack is use to keep an historic of service call to access a function. during service call. Service URI are push on the stack. To return to the last registered service us pop or peek

Returns:
: the registered service name. Null if no service is registered

Definition at line 74 of file CallingServiceManager.java.

String org.openmobileis.services.common.CallingServiceManager.peekCallingService  ) 
 

Looks at the calling service URI at the top of this stack without removing it from the stack.

return the calling service URI return null if no service is registered

Definition at line 117 of file CallingServiceManager.java.

References org.openmobileis.common.util.collection.Array.get().

Referenced by org.openmobileis.services.common.CallingServiceManager.getCallingServiceURL().

boolean org.openmobileis.services.common.CallingServiceManager.peekToTheSpecifiedCallingService String  serviceURI  ) 
 

pop the stack until the specified calling service URI is found.

The service is not removed from the calling service URI stack. If the service is not found, the stack is not modified. return true if the service URI is found, false otherwise.

Definition at line 151 of file CallingServiceManager.java.

References org.openmobileis.common.util.collection.Array.add(), org.openmobileis.common.util.collection.Array.clone(), and org.openmobileis.common.util.collection.Array.remove().

Referenced by org.openmobileis.services.common.RedirectToFromCallingService.run().

String org.openmobileis.services.common.CallingServiceManager.popCallingService  ) 
 

Removes the calling service URI at the top of this stack and returns that calling service URI as the value of this function.

return null if no service is registered

Definition at line 102 of file CallingServiceManager.java.

References org.openmobileis.common.util.collection.Array.remove().

Referenced by org.openmobileis.services.common.RedirectToFromCallingService.run().


The documentation for this class was generated from the following file:
Generated on Wed Dec 14 21:05:39 2005 for OpenMobileIS by  doxygen 1.4.4