org.jumpi
Interface JumpiFactory

All Known Implementing Classes:

JumpiFactory

public interface JumpiFactory

A JumpiFactory is used by a Jumpi client application to get a Jumpi instance to use for communicating.

Since JumpiFactory is an interface, the question remains how a Jumpi client application knows which class implements the JumpiFactory interface, or how it gets a reference to a JumpiFactory. This detail is implementation dependent. Jumpi does not prescribe that a JumpiFactory be available through JNDI. This can be considered the method of choice for J2SE and J2EE environments. However JNDI is not (yet) available for MIDP devices. It is sufficient that a Jumpi client application knows the name of a class which implements JumpiFactory.

Method Summary

Jumpi	getJumpi() Return a Jumpi instance.
Jumpi	getJumpi(java.util.Hashtable parameters) Return a Jumpi instance.

Method Detail

getJumpi

public Jumpi getJumpi(java.util.Hashtable parameters)
               throws java.lang.Exception

Return a Jumpi instance. A JumpiFactory may allow read-only parameters to be passed in order to customize the factory functioning. For example, configuration file names or classnames of configuration loaders can be passed to a factory. Furthermore this method could be used to override default configuration properties of the Jumpi instance.

The returned Jumpi instance is fully configured but has yet to be started via Jumpi.startup(). Any error condition ocured instantiating the Jumpi instance or its configuration throws an Exception.

Parameters:

parameters - read-only implementation specific parameters.

Returns:

a Jumpi instance.

Throws:

java.lang.Exception - if any error condition ocured while creating the Jumpi instance.

getJumpi

public Jumpi getJumpi()
               throws java.lang.Exception

Return a Jumpi instance. Since no customization parameters are provided, the JumpiFactory alone determines the loading and configuration of the Jumpi instance.

The returned Jumpi instance is fully configured but has yet to be started via Jumpi.startup(). Any error condition ocured instantiating the Jumpi instance or its configuration throws an Exception.

Returns:

a Jumpi instance.

Throws:

java.lang.Exception - if any error condition ocured while creating the Jumpi instance.

See Also:

getJumpi(Hashtable)