com.rusticisoftware.tincan

Class RemoteLRS

java.lang.Object

com.rusticisoftware.tincan.RemoteLRS

All Implemented Interfaces:

LRS

public class RemoteLRS
extends Object
implements LRS

Class used to communicate with a TCAPI endpoint synchronously

Constructor Summary

Constructors

Constructor and Description
RemoteLRS()
RemoteLRS(TCAPIVersion version)

Method Summary

Modifier and Type	Method and Description
AboutLRSResponse	about()
String	calculateBasicAuth()
protected boolean	canEqual(Object other)
LRSResponse	clearState(Activity activity, Agent agent, UUID registration)
LRSResponse	deleteActivityProfile(ActivityProfileDocument profile)
LRSResponse	deleteAgentProfile(AgentProfileDocument profile)
LRSResponse	deleteState(StateDocument state)
static void	destroy()
boolean	equals(Object o)
String	getAuth()
URL	getEndpoint()
HashMap	getExtended()
static long	getHTTPClientConnectTimeout() Deprecated. set your own HTTP client using setHttpClient(HttpClient client)
String	getPassword()
Boolean	getPrettyJSON()
String	getUsername()
TCAPIVersion	getVersion()
int	hashCode()
StatementsResultLRSResponse	moreStatements(String moreURL)
StatementsResultLRSResponse	queryStatements(StatementsQueryInterface query)
ActivityLRSResponse	retrieveActivity(Activity activity)
ActivityProfileLRSResponse	retrieveActivityProfile(String id, Activity activity)
ProfileKeysLRSResponse	retrieveActivityProfileIds(Activity activity)
AgentProfileLRSResponse	retrieveAgentProfile(String id, Agent agent)
ProfileKeysLRSResponse	retrieveAgentProfileIds(Agent agent)
PersonLRSResponse	retrievePerson(Agent agent)
StateLRSResponse	retrieveState(String id, Activity activity, Agent agent, UUID registration)
ProfileKeysLRSResponse	retrieveStateIds(Activity activity, Agent agent, UUID registration)
StatementLRSResponse	retrieveStatement(String id)
StatementLRSResponse	retrieveStatement(String id, boolean attachments)
StatementLRSResponse	retrieveVoidedStatement(String id)
StatementLRSResponse	retrieveVoidedStatement(String id, boolean attachments)
LRSResponse	saveActivityProfile(ActivityProfileDocument profile)
LRSResponse	saveAgentProfile(AgentProfileDocument profile)
LRSResponse	saveState(StateDocument state)
StatementLRSResponse	saveStatement(Statement statement)
StatementsResultLRSResponse	saveStatements(List<Statement> statements)
void	setAuth(String auth)
void	setEndpoint(String str)
void	setExtended(HashMap extended)
static void	setHttpClient(org.eclipse.jetty.client.HttpClient client)
static void	setHTTPClientConnectTimeout(long timeout) Deprecated. set your own HTTP client using setHttpClient(HttpClient client)
void	setPassword(String str)
void	setPrettyJSON(Boolean prettyJSON)
void	setUsername(String str)
void	setVersion(TCAPIVersion version)
String	toString()
LRSResponse	updateActivityProfile(ActivityProfileDocument profile)
LRSResponse	updateAgentProfile(AgentProfileDocument profile)
LRSResponse	updateState(StateDocument state)
Boolean	usePrettyJSON() Alternate Getter method for readability of code

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteLRS

public RemoteLRS(TCAPIVersion version)

RemoteLRS

@Generated(value="lombok")
public RemoteLRS()

Method Detail

getHTTPClientConnectTimeout

@Deprecated
public static long getHTTPClientConnectTimeout()

Deprecated. set your own HTTP client using setHttpClient(HttpClient client)

Get the connect timeout value for the default HTTP client

setHTTPClientConnectTimeout

@Deprecated
public static void setHTTPClientConnectTimeout(long timeout)

Deprecated. set your own HTTP client using setHttpClient(HttpClient client)

Set the connect timeout value for the default HTTP client

setHttpClient

public static void setHttpClient(org.eclipse.jetty.client.HttpClient client)
                          throws Exception

Throws:

Exception

destroy

public static void destroy()
                    throws Exception

Throws:

Exception

setEndpoint

public void setEndpoint(String str)
                 throws MalformedURLException

Throws:

MalformedURLException

setUsername

public void setUsername(String str)

setPassword

public void setPassword(String str)

usePrettyJSON

public Boolean usePrettyJSON()

Alternate Getter method for readability of code

calculateBasicAuth

public String calculateBasicAuth()

about

public AboutLRSResponse about()

Specified by:

about in interface LRS

saveStatement

public StatementLRSResponse saveStatement(Statement statement)

Specified by:

saveStatement in interface LRS

saveStatements

public StatementsResultLRSResponse saveStatements(List<Statement> statements)

Specified by:

saveStatements in interface LRS

retrieveStatement

public StatementLRSResponse retrieveStatement(String id)

Specified by:

retrieveStatement in interface LRS

retrieveVoidedStatement

public StatementLRSResponse retrieveVoidedStatement(String id)

Specified by:

retrieveVoidedStatement in interface LRS

retrieveStatement

public StatementLRSResponse retrieveStatement(String id,
                                              boolean attachments)

Specified by:

retrieveStatement in interface LRS

retrieveVoidedStatement

public StatementLRSResponse retrieveVoidedStatement(String id,
                                                    boolean attachments)

Specified by:

retrieveVoidedStatement in interface LRS

queryStatements

public StatementsResultLRSResponse queryStatements(StatementsQueryInterface query)

Specified by:

queryStatements in interface LRS

moreStatements

public StatementsResultLRSResponse moreStatements(String moreURL)

Specified by:

moreStatements in interface LRS

retrieveStateIds

public ProfileKeysLRSResponse retrieveStateIds(Activity activity,
                                               Agent agent,
                                               UUID registration)

Specified by:

retrieveStateIds in interface LRS

retrieveState

public StateLRSResponse retrieveState(String id,
                                      Activity activity,
                                      Agent agent,
                                      UUID registration)

Specified by:

retrieveState in interface LRS

saveState

public LRSResponse saveState(StateDocument state)

Specified by:

saveState in interface LRS

updateState

public LRSResponse updateState(StateDocument state)

Specified by:

updateState in interface LRS

deleteState

public LRSResponse deleteState(StateDocument state)

Specified by:

deleteState in interface LRS

clearState

public LRSResponse clearState(Activity activity,
                              Agent agent,
                              UUID registration)

Specified by:

clearState in interface LRS

retrieveActivity

public ActivityLRSResponse retrieveActivity(Activity activity)

Specified by:

retrieveActivity in interface LRS

retrieveActivityProfileIds

public ProfileKeysLRSResponse retrieveActivityProfileIds(Activity activity)

Specified by:

retrieveActivityProfileIds in interface LRS

retrieveActivityProfile

public ActivityProfileLRSResponse retrieveActivityProfile(String id,
                                                          Activity activity)

Specified by:

retrieveActivityProfile in interface LRS

saveActivityProfile

public LRSResponse saveActivityProfile(ActivityProfileDocument profile)

Specified by:

saveActivityProfile in interface LRS

updateActivityProfile

public LRSResponse updateActivityProfile(ActivityProfileDocument profile)

Specified by:

updateActivityProfile in interface LRS

deleteActivityProfile

public LRSResponse deleteActivityProfile(ActivityProfileDocument profile)

Specified by:

deleteActivityProfile in interface LRS

retrievePerson

public PersonLRSResponse retrievePerson(Agent agent)

Specified by:

retrievePerson in interface LRS

retrieveAgentProfileIds

public ProfileKeysLRSResponse retrieveAgentProfileIds(Agent agent)

Specified by:

retrieveAgentProfileIds in interface LRS

retrieveAgentProfile

public AgentProfileLRSResponse retrieveAgentProfile(String id,
                                                    Agent agent)

Specified by:

retrieveAgentProfile in interface LRS

saveAgentProfile

public LRSResponse saveAgentProfile(AgentProfileDocument profile)

Specified by:

saveAgentProfile in interface LRS

updateAgentProfile

public LRSResponse updateAgentProfile(AgentProfileDocument profile)

Specified by:

updateAgentProfile in interface LRS

deleteAgentProfile

public LRSResponse deleteAgentProfile(AgentProfileDocument profile)

Specified by:

deleteAgentProfile in interface LRS

getEndpoint

@Generated(value="lombok")
public URL getEndpoint()

getVersion

@Generated(value="lombok")
public TCAPIVersion getVersion()

getUsername

@Generated(value="lombok")
public String getUsername()

getPassword

@Generated(value="lombok")
public String getPassword()

getAuth

@Generated(value="lombok")
public String getAuth()

getExtended

@Generated(value="lombok")
public HashMap getExtended()

getPrettyJSON

@Generated(value="lombok")
public Boolean getPrettyJSON()

setVersion

@Generated(value="lombok")
public void setVersion(TCAPIVersion version)

setAuth

@Generated(value="lombok")
public void setAuth(String auth)

setExtended

@Generated(value="lombok")
public void setExtended(HashMap extended)

setPrettyJSON

@Generated(value="lombok")
public void setPrettyJSON(Boolean prettyJSON)

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

@Generated(value="lombok")
protected boolean canEqual(Object other)

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Object

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Object