io.connecto.connectoapi

Class ConnectoAPI

java.lang.Object

io.connecto.connectoapi.ConnectoAPI

public class ConnectoAPI
extends Object

Simple interface to the Connecto tracking API, intended for use in server-side applications. Users are encouraged to review our Javascript API for reporting user events in web applications, and our Android API for use in Android mobile applications. The Java API doesn't provide or assume any threading model, and is designed such that recording events and sending them can be easily separated.

Constructor Summary

Constructors

Constructor and Description
ConnectoAPI() Constructs a ConnectoAPI object associated with the production, Connecto services.
ConnectoAPI(String endpoint, String rulesendpoint, int timeout) Create a ConnectoAPI associated with custom URLS for the Connecto service.

Method Summary

Modifier and Type	Method and Description
void	deliver(ClientDelivery toSend) Attempts to send a given delivery to the Connecto servers.
SegmentResponse	getSegments(String readKey, String userId) This api will get the user segment that is a list of matched segment rules.
void	sendMessage(org.json.JSONObject message) Sends a single message to Connecto servers.
void	setTimeout(int timeoutInMs) Set timeout for HTTP cals.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectoAPI

public ConnectoAPI()

Constructs a ConnectoAPI object associated with the production, Connecto services.

ConnectoAPI

public ConnectoAPI(String endpoint,
                   String rulesendpoint,
                   int timeout)

Create a ConnectoAPI associated with custom URLS for the Connecto service. Useful for testing and proxying. Most callers should use the constructor with no arguments.

Parameters:

endpoint - a URL that will accept Connecto events and identify messages

See Also:

ConnectoAPI()

Method Detail

setTimeout

public void setTimeout(int timeoutInMs)

Set timeout for HTTP cals.

Parameters:

timeoutInMs - an integer representing milliseconds

sendMessage

public void sendMessage(org.json.JSONObject message)
                 throws ConnectoMessageException,
                        IOException

Sends a single message to Connecto servers. Each call to sendMessage results in a blocking call to remote Connecto servers. To send multiple messages at once, see #deliver(ClientDelivery)

Parameters:

message - A JSONObject formatted by #MessageBuilder

Throws:

ConnectoMessageException - if the given JSONObject is not (apparently) a Connecto message. This is a RuntimeException, callers should take care to submit only correctly formatted messages.

IOException - if

deliver

public void deliver(ClientDelivery toSend)
             throws IOException

Attempts to send a given delivery to the Connecto servers. Will block, possibly on multiple server requests. For most applications, this method should be called in a separate thread or in a queue consumer.

Parameters:

toSend - a ClientDelivery containing a number of Connecto messages

Throws:

IOException - if its unable to parse messages

See Also:

ClientDelivery

getSegments

public SegmentResponse getSegments(String readKey,
                                   String userId)
                            throws IOException

This api will get the user segment that is a list of matched segment rules.

Parameters:

readKey - an authorization key provided to you in Connecto admin

userId - a user id whose segments are being requested.

Throws:

IOException