xyz.thepathfinder.android.Pathfinder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pathfinder-android Show documentation
Show all versions of pathfinder-android Show documentation
Android/Java client library for the Pathfinder service
package xyz.thepathfinder.android;
import org.glassfish.tyrus.client.ClientManager;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.websocket.ClientEndpointConfig;
import javax.websocket.CloseReason;
import javax.websocket.DeploymentException;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Collections;
import java.util.List;
import java.util.Map;
/**
*
* 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 {@link #getDefaultCluster} method. Any other cluster available to
* the user may be obtained through the {@link #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.addAuthenticationListener(new MyAuthListener());
* pathfinder.connect();
* Cluster cluster = pathfinder.getCluster("/root/cluster1/subcluster2");
* MyClusterListener clusterListener = new MyClusterListener();
* cluster.addListener(clusterListener);
* cluster.connect();
* {@literal // more code ...}
* pathfinder.close();
*
* @author David Robinson
* @version 0.0.1
* @see Cluster
* @see Commodity
* @see Transport
*/
public class Pathfinder {
/**
* Logs actions performed by the class.
*/
private static final Logger logger = LoggerFactory.getLogger(Pathfinder.class);
/**
* The default authentication server URI.
*/
private static final String DEFAULT_AUTH_URI = "http://auth.thepathfinder.xyz/connection";
/**
* The default web socket URI.
*/
private static final String DEFAULT_WEBSOCKET_URI = "ws://api.thepathfinder.xyz/socket";
/**
* Application Identifier that identifies the application on the pathfinder server.
*/
private final String applicationIdentifier;
/**
* The authenticator controlling the authentication sequence.
*/
private Authenticator authenticator;
/**
* Keeps track of all the Pathfinder models and connection to the server.
*/
private PathfinderServices services;
/**
* URL to the Pathfinder server being connected to.
*/
private URI webSocketUrl;
/**
* Constructs a Pathfinder object.
*
* @param applicationIdentifier application Identifier provided by a Pathfinder service provider
* @param userCredentials JWT of the user's credentials
*/
public Pathfinder(String applicationIdentifier, String userCredentials) {
try {
this.webSocketUrl = new URI(DEFAULT_WEBSOCKET_URI);
} catch (URISyntaxException e) {
logger.error(e.getMessage());
}
this.applicationIdentifier = applicationIdentifier;
this.constructPathfinderServices(applicationIdentifier, userCredentials, DEFAULT_AUTH_URI);
}
/**
* Constructs a Pathfinder object.
*
* @param applicationIdentifier application Identifier provided by a Pathfinder service provider
* @param userCredentials JWT of the user's credentials
*/
public Pathfinder(String applicationIdentifier, String userCredentials, String authenticationServerURL) {
try {
this.webSocketUrl = new URI(DEFAULT_WEBSOCKET_URI);
} catch (URISyntaxException e) {
logger.error(e.getMessage());
}
this.applicationIdentifier = applicationIdentifier;
this.constructPathfinderServices(applicationIdentifier, userCredentials, authenticationServerURL);
}
/**
* Constructs a Pathfinder object.
*
* @param applicationIdentifier application Identifier provided by a Pathfinder service provider
* @param userCredentials JWT of the user's credentials
* @param webSocketUrl URL to the Pathfinder web socket service provider
*/
protected Pathfinder(String applicationIdentifier, String userCredentials, URI webSocketUrl) {
this.applicationIdentifier = applicationIdentifier;
this.webSocketUrl = webSocketUrl;
this.constructPathfinderServices(applicationIdentifier, userCredentials, DEFAULT_AUTH_URI);
}
/**
* Sets the {@link PathfinderServices} object.
*
* @param userCredentials the user's identity JWT.
*/
private void constructPathfinderServices(String applicationIdentifier, String userCredentials, String authenticationServerURL) {
Connection connection = new Connection();
ModelRegistry registry = new ModelRegistry();
this.services = new PathfinderServices(registry, connection);
this.authenticator = new Authenticator(applicationIdentifier, userCredentials, authenticationServerURL, this.services);
AuthenticationMessageHandler messageHandler = new AuthenticationMessageHandler(authenticator);
connection.setMessageHandler(messageHandler);
}
/**
* Establishes a connection to the Pathfinder server, if the connection is not already open.
* This method doesn't blocks until the connection is established.
*
* @throws RuntimeException if could not connect to the Pathfinder server.
*/
public void connect() {
if (!this.isConnected()) {
ClientManager clientManager = new ClientManager();
ClientEndpointConfig.Configurator configurator = new ClientEndpointConfig.Configurator() {
@Override
public void beforeRequest(Map> header) {
header.put("Authorization", Collections.singletonList(applicationIdentifier));
}
};
ClientEndpointConfig configuration = ClientEndpointConfig.Builder.create().configurator(configurator).build();
try {
clientManager.asyncConnectToServer(this.services.getConnection(), configuration, this.webSocketUrl);
} catch (DeploymentException e) {
// Invalid annotated connection object and connection problems
logger.error("Deployment Exception: " + e.getMessage());
throw new RuntimeException(e);
}
}
}
/**
* Adds an {@link AuthenticationListener} to listen for the success or failure
* of the authentication sequence.
*
* @param listener to add.
*/
public void addAuthenticationListener(AuthenticationListener listener) {
this.authenticator.addListener(listener);
}
/**
* Gets an unconnected cluster pointing to the default cluster for the application identifier provided.
*
* @return an unconnected cluster
*/
public Cluster getDefaultCluster() {
return Cluster.getInstance(Path.DEFAULT_PATH, this.services);
}
/**
* Gets an unconnected cluster pointing to the path specified.
*
* @param path to the cluster
* @return an unconnected cluster
*/
public Cluster getCluster(String path) {
return Cluster.getInstance(path, this.services);
}
/**
* Gets an unconnected commodity pointing to the path specified.
*
* @param path to the commodity
* @return an unconnected commodity
*/
public Commodity getCommodity(String path) {
return Commodity.getInstance(path, this.services);
}
/**
* Gets an unconnected transport pointing to the path specified.
*
* @param path to the transport
* @return an unconnected transport
*/
public Transport getTransport(String path) {
return Transport.getInstance(path, this.services);
}
/**
* Returns true if the web socket connection to the Pathfinder server is open.
*
* @return true if the connection is still open
*/
public boolean isConnected() {
return this.services.getConnection().isConnected();
}
/**
* Returns the number of web socket messages sent to the Pathfinder server.
*
* @return The number of web socket messages sent
*/
protected long getSentMessageCount() {
return this.services.getConnection().getSentMessageCount();
}
/**
* Returns the number of web socket messages received from the Pathfinder server.
*
* @return The number of web socket messsages received.
*/
protected long getReceivedMessageCount() {
return this.services.getConnection().getReceivedMessageCount();
}
/**
* Closes the web socket connection to the Pathfinder server with a normal close condition.
*
* @throws IOException If there was error closing the connection.
*/
public void close() throws IOException {
CloseReason reason = new CloseReason(CloseReason.CloseCodes.NORMAL_CLOSURE, "Connection ended by user");
this.close(reason);
}
/**
* Closes the web socket connection to the Pathfinder server, if it is still open, with the specified reason.
*
* @param reason The reason to close the connection.
* @throws IOException If there was error closing the connection.
*/
public void close(CloseReason reason) throws IOException {
if (this.isConnected()) {
logger.info("Connection closed");
this.services.getConnection().close(reason);
}
}
}