Pathfinder (pathfinder-android 0.0.13 API)

java.lang.Object
- xyz.thepathfinder.android.Pathfinder

```
public class Pathfinder
extends Object
```
The Pathfinder class is the main entry point to the Pathfinder API. To create the Pathfinder class you need a valid application identifier provided from your Pathfinder service manager, we provide the ability to get an application identifier from thepathfinder.xyz. The connection also requires a JWT in the form of a String to authenticate the user. The URI to your pathfinder provider is also required to initiate the connection.

The default cluster is available via the getDefaultCluster() method. Any other cluster available to the user may be obtained through the getCluster(String) method, where the path is of the form "/default/clusterName/subclusterName/subsubclusterName".

Note, when connecting thePathfinder object the thread is blocked until the web socket to the Pathfinder service is opened.
```
   Pathfinder pathfinder = new Pathfinder("myAppId", "UserJWT");
   pathfinder.connect();
   Cluster cluster = pathfinder.getCluster("/default/cluster1/subcluster2");
   MyClusterListener clusterListener = new MyClusterListener();
   cluster.addListener(clusterListener);
   cluster.connect();
 // more code ...
   pathfinder.close();
```
See Also:
Cluster, Commodity, Transport

Field Summary

Fields
Modifier and Type	Field and Description
`private ConnectionConfiguration`	`connectionConfiguration` Configures the opening connection header.
`private static org.slf4j.Logger`	`logger`
`private PathfinderServices`	`services` Keeps track of all the Pathfinder models and connection to the server.
`private URI`	`webSocketUrl` URL to the Pathfinder server being connected to.

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`Pathfinder(String applicationIdentifier, String userCredentials)` Constructs a Pathfinder object.
`protected`	`Pathfinder(String applicationIdentifier, String userCredentials, URI webSocketUrl)` Constructs a Pathfinder object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the web socket connection to the Pathfinder server with a normal close condition.
`void`	`close(CloseReason reason)` Closes the web socket connection to the Pathfinder server, if it is still open, with the specified reason.
`private void`	`connect()` Establishes a connection to the Pathfinder server, if the connection is not already open.
`private void`	`constructPathfinder(String applicationIdentifier, String userCredentials)`
`static Pathfinder`	`create(String applicationIdentifier)`
`Cluster`	`getCluster(String path)` Gets an unconnected cluster pointing to the path specified.
`Commodity`	`getCommodity(String path)` Gets an unconnected commodity pointing to the path specified.
`Cluster`	`getDefaultCluster()` Gets an unconnected cluster pointing to the default cluster for the application identifier provided.
`protected long`	`getReceivedMessageCount()` Returns the number of web socket messages received from the Pathfinder server.
`protected long`	`getSentMessageCount()` Returns the number of web socket messages sent to the Pathfinder server.
`Transport`	`getTransport(String path)` Gets an unconnected transport pointing to the path specified.
`boolean`	`isConnected()` Returns `true` if the web socket connection to the Pathfinder server is open.

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

- Field Detail
  - logger
```
private static final org.slf4j.Logger logger
```
  - services
```
private PathfinderServices services
```
    Keeps track of all the Pathfinder models and connection to the server.
  - webSocketUrl
```
private URI webSocketUrl
```
    URL to the Pathfinder server being connected to.
  - connectionConfiguration
```
private ConnectionConfiguration connectionConfiguration
```
    Configures the opening connection header.
- Constructor Detail
  - Pathfinder
```
private Pathfinder(String applicationIdentifier,
          String userCredentials)
```
    Constructs a Pathfinder object.
    
    Parameters:
    applicationIdentifier - application Identifier provided by a Pathfinder service provider
    userCredentials - JWT of the user's credentials
  - Pathfinder
```
protected Pathfinder(String applicationIdentifier,
          String userCredentials,
          URI webSocketUrl)
```
    Constructs a Pathfinder object.
    
    Parameters:
    applicationIdentifier - application Identifier provided by a Pathfinder service provider
    userCredentials - JWT of the user's credentials
    webSocketUrl - URL to the Pathfinder web socket service provider
- Method Detail
  - create
```
public static Pathfinder create(String applicationIdentifier)
                         throws IOException
```
    Throws:
    
    IOException
  - constructPathfinder
```
private void constructPathfinder(String applicationIdentifier,
                       String userCredentials)
```
  - connect
```
private void connect()
              throws IOException
```
    Establishes a connection to the Pathfinder server, if the connection is not already open. This method blocks until the connection is established.
    
    Throws:
    
    IOException - problem connecting to the Pathfinder server
  - getDefaultCluster
```
public Cluster getDefaultCluster()
```
    Gets an unconnected cluster pointing to the default cluster for the application identifier provided.
    
    Returns:
    an unconnected cluster
  - getCluster
```
public Cluster getCluster(String path)
```
    Gets an unconnected cluster pointing to the path specified.
    
    Parameters:
    path - to the cluster
    
    Returns:
    an unconnected cluster
  - getCommodity
```
public Commodity getCommodity(String path)
```
    Gets an unconnected commodity pointing to the path specified.
    
    Parameters:
    path - to the commodity
    
    Returns:
    an unconnected commodity
  - getTransport
```
public Transport getTransport(String path)
```
    Gets an unconnected transport pointing to the path specified.
    
    Parameters:
    path - to the transport
    
    Returns:
    an unconnected transport
  - isConnected
```
public boolean isConnected()
```
    Returns true if the web socket connection to the Pathfinder server is open.
    
    Returns:
    true if the connection is still open
  - getSentMessageCount
```
protected long getSentMessageCount()
```
    Returns the number of web socket messages sent to the Pathfinder server.
    
    Returns:
    The number of web socket messages sent
  - getReceivedMessageCount
```
protected long getReceivedMessageCount()
```
    Returns the number of web socket messages received from the Pathfinder server.
    
    Returns:
    The number of web socket messsages received.
  - close
```
public void close()
           throws IOException
```
    Closes the web socket connection to the Pathfinder server with a normal close condition.
    
    Throws:
    
    IOException - If there was error closing the connection.
  - close
```
public void close(CloseReason reason)
           throws IOException
```
    Closes the web socket connection to the Pathfinder server, if it is still open, with the specified reason.
    
    Parameters:
    reason - The reason to close the connection.
    
    Throws:
    
    IOException - If there was error closing the connection.

Class Pathfinder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

services

webSocketUrl

connectionConfiguration

Constructor Detail

Pathfinder

Pathfinder

Method Detail

create

constructPathfinder

connect

getDefaultCluster

getCluster

getCommodity

getTransport

isConnected

getSentMessageCount

getReceivedMessageCount

close

close