net.wildfyre.api

Class Internal

java.lang.Object

net.wildfyre.api.Internal

public class Internal
extends java.lang.Object

This class represents the internals of the WildFyre Java Client Library. This class was written to give lower-level access to developers. When possible, prefer using the WildFyre class.

Note that you should call init() after any modification of the token, otherwise the behavior of this class is not defined.

Constructor Summary

Constructors

Constructor and Description
Internal()

Method Summary

Modifier and Type	Method and Description
static void	clean() Cleans the cache -- that is, removes every object that is not valid anymore from it (see Descriptor.isValid()).
static void	clear() Fully clears the cache, but keeps the token.
static java.util.Optional<User>	getCachedUser(int id) Gets the cached version of a user.
static LoggedUser	getMe() Gets the current user, that is, the user that corresponds to the saved token.
static int	getMyId() The ID of the logged-in user.
static java.lang.String	getToken() Returns the token used for authentication.
static void	init() Connects to the server & tries to access the logged-user's ID.
static boolean	isMyId(int id) Checks whether a user ID is the ID of the current user.
static void	requestToken(java.lang.String username, java.lang.String password) Requests a token using a username and a password.
static void	reset() Resets the API.
static void	setToken(java.lang.String token) Sets the token used by the API.
static void	submit(java.lang.Runnable task) Submits a new task to be executed concurrently.

Methods inherited from class java.lang.Object

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

Constructor Detail

Internal

public Internal()

Method Detail

clear

public static void clear()

Fully clears the cache, but keeps the token.

See Also:

Only remove the data that has expired

clean

public static void clean()

Cleans the cache -- that is, removes every object that is not valid anymore from it (see Descriptor.isValid()).

See Also:

Remove all data, not only the expired data

reset

public static void reset()

Resets the API.

This means that the user's token is removed, and the cache is fully cleared.

getCachedUser

public static java.util.Optional<User> getCachedUser(int id)

Gets the cached version of a user. Note that this will NEVER query the server, no matter what happens. You should probably user User.query(int) instead.

Parameters:

id - the user's ID

Returns:

The user found for the specified ID in the cache, or the default value.

getMe

public static LoggedUser getMe()

Gets the current user, that is, the user that corresponds to the saved token.

Returns:

The current user.

isMyId

public static boolean isMyId(int id)

Checks whether a user ID is the ID of the current user.

Returns:

true if the provided ID is the ID of the logged-in user.

getMyId

public static int getMyId()

The ID of the logged-in user.

Returns:

The ID of the logged-in user.

getToken

public static java.lang.String getToken()

Returns the token used for authentication.

Returns:

The token.

submit

public static void submit(java.lang.Runnable task)

Submits a new task to be executed concurrently.

Parameters:

task - the task to be executed concurrently.

requestToken

public static void requestToken(java.lang.String username,
                                java.lang.String password)
                         throws Request.CantConnectException

Requests a token using a username and a password. This request is NOT executed concurrently (since the client cannot do anything until connected).

Parameters:

username - the user's username

password - the user's password

Throws:

Request.CantConnectException - if the API cannot connect to the server

setToken

public static void setToken(java.lang.String token)

Sets the token used by the API. Note that no verification regarding the token's validity is done by this method.

Parameters:

token - the new token

init

public static void init()
                 throws Request.CantConnectException

Connects to the server & tries to access the logged-user's ID. This is needed so the API can identify whether a post is owned or not by the user.

Throws:

Request.CantConnectException - if the API cannot connect to the server