SpaceFinder (GigaSpaces XAP 14.2.0 API)

java.lang.Object
- com.j_spaces.core.client.SpaceFinder

Direct Known Subclasses:: CacheFinder

Deprecated.

Use UrlSpaceConfigurer instead.

@Deprecated
public class SpaceFinder
extends Object

 This utility class provides accessing to Container proxy
 or Space proxy (IJSpace).

  The SpaceFinder is designed to provide a unified interface for finding a
 space/container in each of the mode specified.
 In addition to the lookup option there is another option of finding the space
 via its container.
  To provide a unified manager of accessing the space in any of the above modes
 we will use a url based interface which will provide the information of the
 protocol and the address of the space that should be found.

 The general format for this URL is as follows:

 Protocol://[host]:[port]/[container_name]/[space_name]?[query_string]

 Protocol: [ rmi | jini | java ]
           The "java" protocol enables working with an embedded space. When choosing so
           one should specify in the query string one of three space operations:

           > create - to create a new space
            example of "mySpace" space creation:

            java://myHost/myContinaer/mySpace?create

           > open - To open  an existing space in an embedded mode:
            example of opening "mySpace" space:

            java://myHost/myContinaer/mySpace?open

           > destroy - for destroy  an existing space:
            example of destroying "mySpace" space:

            java://myHost/myContinaer/mySpace?destroy

 Host: The host name. Can be '*', when JINI is used as a protocol, the host
       value determines whether to use Unicast or Multicast.

 Port: the registry or lookup port. If the port is  not specified,
       the default port 10098 will be used.

 Container Name: The name of the container, which holds the space.
                 If the container name is '*' then the container attribute will be ignored and
 the
                 space will be looked for directly regardless of the container that holds it .

 Examples of space url's:

 1. Looking for a space using JINI Unicast protocol.
    jini://mylookuphost/mycontainername/myspace
  Or
    jini://*/*/myspace

 2. Looking for a space using the JINI multicast protocol.
    jini://*/containername/myspace
  Or
    jini://*/*/myspace

 3. looking for a container regardless of the space it contains in any of the above methods:
    jini://mylookuphost/mycontainername
    jini://*/mycontainername

 For more details, examples and options see SpaceURL

Version:: 1.0
Author:: Igor Goldenberg
See Also:: SpaceURL

Field Summary

Fields
Modifier and Type Field and Description

protected Logger _logger
Deprecated.

Fields
Modifier and Type	Field and Description
`protected Logger`	`_logger` Deprecated.

Constructor Summary

Constructors
Modifier Constructor and Description

protected SpaceFinder()
Deprecated.

Singleton.

Constructors
Modifier	Constructor and Description
`protected`	`SpaceFinder()` Deprecated. Singleton.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Object`	`find(SpaceURL spaceURL)` Deprecated. The general format for this URL is as follows: Protocol://[host]:[port]/[container_name]/[space_name]?[query_string] Protocol: [ RMI \| JINI \| JAVA ] This method also supports multiple URLs separate by ";", e.i.
`static Object`	`find(SpaceURL[] spaceURLs, CredentialsProvider credentialsProvider)` Deprecated.
`static Object`	`find(SpaceURL spaceURL, CredentialsProvider credentialsProvider)` Deprecated. The general format for this URL is as follows: Protocol://[host]:[port]/[container_name]/[space_name]?[query_string] Protocol: [ RMI \| JINI \| JAVA ] This method also supports multiple URLs separate by ";", e.i.
`static Object`	`find(SpaceURL spaceURL, CredentialsProvider credentialsProvider, long timeout, LookupType lookupType)` Deprecated.
`static Object`	`find(String urls)` Deprecated. The general format for this URL is as follows: Protocol://[host]:[port]/[container_name]/[space_name]?[query_string] Protocol: [ RMI \| JINI \| JAVA ] This method also supports multiple URLs separate by ";", e.i.
`static Object`	`find(String[] urls)` Deprecated. SpaceFinder.find multiple URL provides ability to define space search order.
`static Object`	`find(String urls, Properties customProperties)` Deprecated. The general format for this URL is as follows: Protocol://[host]:[port]/[container_name]/[space_name]?[query_string] Protocol: [ RMI \| JINI \| JAVA ] This method also supports multiple URLs separate by ";", e.i.
`static Object`	`find(String urls, Properties customProperties, LifeCycle lifeCycle, CredentialsProvider credentialsProvider)` Deprecated. Finds or creates an instance of a GigaSpace based on the specified spaceURL.
`static IRemoteSpace`	`findJiniSpace(SpaceURL url, String spaceUuid, Properties customProperties, long timeout, LookupType lookupType)` Deprecated. Returns Either LRMISpaceImpl or SpaceProxyImpl.
`protected Object`	`findService(SpaceURL[] spaceURLs, Properties customProperties, LifeCycle lifeCycle, CredentialsProvider credentialsProvider)` Deprecated.
`protected Object`	`findService(SpaceURL url, Properties customProperties, LifeCycle lifeCycle, CredentialsProvider credentialsProvider, long timeout, LookupType lookupType)` Deprecated. The main method of SpaceFinder to find single Space or Container proxy.
`protected Object`	`findService(String[] urls)` Deprecated.
`protected Object`	`findService(String url, Properties customProperties, LifeCycle lifeCycle, CredentialsProvider credentialsProvider)` Deprecated.
`static void`	`main(String[] args)` Deprecated. This main provides the following options: 1.
`static SpaceURL`	`verifyURL(String url)` Deprecated. Verifies for validation if the specified `url` is valid and returns `SpaceURL` object that contains all information about specified `url`.

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

Field Detail
- _logger
```
protected final Logger _logger
```
  Deprecated.

Constructor Detail
- SpaceFinder
```
protected SpaceFinder()
```
  Deprecated.
  
  Singleton.

Method Detail

verifyURL
```
public static SpaceURL verifyURL(String url)
                          throws MalformedURLException
```
Deprecated.

Verifies for validation if the specified url is valid and returns SpaceURL object that contains all information about specified url. This method also support multiple URLs separate by ";"

Parameters:

url - The url to verify.

Returns:

Returns SpaceURL object that contains all information about specified url.

Throws:

MalformedURLException - Throws exception if specified url is not valid.

find
```
public static Object find(String[] urls)
                   throws FinderException
```
Deprecated.

SpaceFinder.find multiple URL provides ability to define space search order. It is useful when Jini URL for locating services on the network is not available. If the first space URL is unavailable, SpaceFinder will try the next one until a live proxy will be found. If all URLs are unavailable this method throws FinderException

Parameters:

urls - Array of SpaceFinder URLs.

Returns:

Returns single found proxy.

Throws:

FinderException - Failed to found proxy.All URLs are unavailable.

find

public static Object find(String urls)
                   throws FinderException

Deprecated.

 The general format for this URL is as follows:
 Protocol://[host]:[port]/[container_name]/[space_name]?[query_string]
 Protocol: [ RMI | JINI | JAVA ]
 This method also supports multiple URLs separate by ";",
 e.i. jini://localhost/containerName/SpaceName;jini://'*'/containerName/SpaceName;
 It is useful when Jini URL for locating services on the network is not available.
        If the first space URL is unavailable, SpaceFinder will try the next one until a live proxy
 will be found.
 If all URLs are unavailable this method throws FinderException

Parameters:: urls - Space URL
Returns:: Returns single Space or Container proxy.
Throws:: FinderException - During finding space or container.

find

public static Object find(String urls,
                          Properties customProperties)
                   throws FinderException

Deprecated.

 The general format for this URL is as follows:
 Protocol://[host]:[port]/[container_name]/[space_name]?[query_string]
 Protocol: [ RMI | JINI | JAVA ]
 This method also supports multiple URLs separate by ";",
 e.i. jini://localhost/containerName/SpaceName;jini://'*'/containerName/SpaceName;
 It is useful when Jini URL for locating services on the network is not available.
    If the first space URL is unavailable, SpaceFinder will try the next one until a live
 proxy will be found.
 If all URLs are unavailable this method throws FinderException

Parameters:: urls - Space URL; customProperties - Custom Properties object which overwrites the space/container/cluster configurations.
Returns:: Returns single Space or Container proxy.
Throws:: FinderException - During finding space or container.

find
```
public static Object find(String urls,
                          Properties customProperties,
                          LifeCycle lifeCycle,
                          CredentialsProvider credentialsProvider)
                   throws FinderException
```
Deprecated.

Finds or creates an instance of a GigaSpace based on the specified spaceURL.

Parameters:

urls - The general format for this URL is as follows: Protocol://[host]:[port]/[container_name]/[space_name]. Must not be null

customProperties - Optional custom Properties object which overwrites the space/container/cluster configurations, used when creating a new instance

lifeCycle - Optional reference for hosting environment. This parameter is passed as the LifeCycle argument to the implementation's constructor if the GigaSpaces instance is created. If this argument is null, then a default, no-op LifeCycle object will be assigned. If the GigaSpaces instance already exists, this parameter is ignored.

credentialsProvider - credentials to be used for authentication against a remote secured space; may be null.

Returns:

The proxy to a newly created GigaSpaces instance or to an instance that matches the specification of the spaceURL parameter.

Throws:

FinderException - If there are exception creating or finding the GigaSpaces instance

NullPointerException - if the spaceURL parameter is null

find

public static Object find(SpaceURL spaceURL)
                   throws FinderException

Deprecated.

 The general format for this URL is as follows:
 Protocol://[host]:[port]/[container_name]/[space_name]?[query_string]
 Protocol: [ RMI | JINI | JAVA ]
 This method also supports multiple URLs separate by ";",
 e.i. jini://localhost/containerName/SpaceName;jini://'*'/containerName/SpaceName;
 It is useful when Jini URL for locating services on the network is not available.
        If the first space URL is unavailable, SpaceFinder will try the next one until a live proxy
 will be found.
 If all URLs are unavailable this method throws FinderException

Parameters:: spaceURL - Space URL
Returns:: Returns single Space or Container proxy.
Throws:: FinderException - During finding space or container.

find

public static Object find(SpaceURL spaceURL,
                          CredentialsProvider credentialsProvider)
                   throws FinderException

Deprecated.

 The general format for this URL is as follows:
 Protocol://[host]:[port]/[container_name]/[space_name]?[query_string]
 Protocol: [ RMI | JINI | JAVA ]
 This method also supports multiple URLs separate by ";",
 e.i. jini://localhost/containerName/SpaceName;jini://'*'/containerName/SpaceName;
 It is useful when Jini URL for locating services on the network is not available.
        If the first space URL is unavailable, SpaceFinder will try the next one until a live proxy
 will be found.
 If all URLs are unavailable this method throws FinderException

Parameters:: credentialsProvider - credentials to be used for authentication against a remote secured space; may be null.
Returns:: Returns single Space or Container proxy.
Throws:: FinderException - During finding space or container.

find

public static Object find(SpaceURL spaceURL,
                          CredentialsProvider credentialsProvider,
                          long timeout,
                          LookupType lookupType)
                   throws FinderException

Deprecated.

Throws:: FinderException

find

public static Object find(SpaceURL[] spaceURLs,
                          CredentialsProvider credentialsProvider)
                   throws FinderException

Deprecated.

Throws:: FinderException

findService

protected Object findService(String url,
                             Properties customProperties,
                             LifeCycle lifeCycle,
                             CredentialsProvider credentialsProvider)
                      throws FinderException

Deprecated.

Throws:: FinderException

findService

protected Object findService(String[] urls)
                      throws FinderException

Deprecated.

Throws:: FinderException

findService

protected Object findService(SpaceURL[] spaceURLs,
                             Properties customProperties,
                             LifeCycle lifeCycle,
                             CredentialsProvider credentialsProvider)
                      throws FinderException

Deprecated.

Throws:: FinderException

findService

protected Object findService(SpaceURL url,
                             Properties customProperties,
                             LifeCycle lifeCycle,
                             CredentialsProvider credentialsProvider,
                             long timeout,
                             LookupType lookupType)
                      throws FinderException

Deprecated.

The main method of SpaceFinder to find single Space or Container proxy. If the proxy is not found throws FinderException.

Parameters:: url - The valid SpaceFinder URL to Container or Space.; credentialsProvider - security credentials to be used for authentication in case of a secured space; may be null.
Returns:: Returns single found proxy.
Throws:: FinderException - Failed to find proxy of desired url.

findJiniSpace

public static IRemoteSpace findJiniSpace(SpaceURL url,
                                         String spaceUuid,
                                         Properties customProperties,
                                         long timeout,
                                         LookupType lookupType)
                                  throws FinderException

Deprecated.

Returns Either LRMISpaceImpl or SpaceProxyImpl.

Throws:: FinderException

main
```
public static void main(String[] args)
                 throws FinderException
```
Deprecated.

This main provides the following options: 1. Starts container or container with an embedded space. i.e. java SpaceFinder java://localhost:10098/containerName or java://localhost:10098/containerName/mySpace or /./mySpace (which translates to java://localhost:10098/containerName/mySpace?schema=default) or /./mySpace?schema=cache (which translates to java://localhost:10098/containerName/mySpace?schema=cache) For more options see usage printouts.
2. Verify if a Space/Container running. i.e. java SpaceFinder rmi://hostname/containerName/SpaceName

Parameters:

args - args[0] should be the space url

Throws:

FinderException - During finding space or container.

Class SpaceFinder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_logger

Constructor Detail

SpaceFinder

Method Detail

verifyURL

find

find

find

find

find

find

find

find

findService

findService

findService

findService

findJiniSpace

main