enterprises.orbital.evekit.ws.account

Class AccountWS

java.lang.Object

enterprises.orbital.evekit.ws.account.AccountWS

@Path(value="/ws/v1/account")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public class AccountWS
extends Object

Constructor Summary

Constructors

Constructor and Description
AccountWS()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	charEndpoints(javax.servlet.http.HttpServletRequest request) Return list of character ESI endpoints.
javax.ws.rs.core.Response	checkAdmin(javax.servlet.http.HttpServletRequest request) Check whether the authenticated user is an admin.
static javax.ws.rs.core.Response	checkRequireAdmin(enterprises.orbital.evekit.account.EveKitUserAccount user, long uid) Checks whether the authenticated user is an administrator in cases where the ID of the authenticated user is different than the ID of the user being acted upon.
javax.ws.rs.core.Response	corpEndpoints(javax.servlet.http.HttpServletRequest request) Return list of corporation ESI endpoints.
static javax.ws.rs.core.Response	createUserNotLoggedResponse() Generate a response for a user who is not logged in.
javax.ws.rs.core.Response	deleteAccessKey(javax.servlet.http.HttpServletRequest request, long uid, long aid, long kid) Delete access key.
javax.ws.rs.core.Response	deleteSyncAccount(javax.servlet.http.HttpServletRequest request, long uid, long aid) Delete sync account.
javax.ws.rs.core.Response	getAccessKey(javax.servlet.http.HttpServletRequest request, long uid, long aid, long kid) Get list of access keys.
javax.ws.rs.core.Response	getSyncAccount(javax.servlet.http.HttpServletRequest request, long uid, long aid) Retrieve list of sync accounts.
javax.ws.rs.core.Response	getUser(javax.servlet.http.HttpServletRequest request) Get the currently authenticated user.
javax.ws.rs.core.Response	getUserLastSource(javax.servlet.http.HttpServletRequest request, long uid) Get the last source used to login for the specified user (or currently logged in user).
javax.ws.rs.core.Response	getUserSources(javax.servlet.http.HttpServletRequest request, long uid) Return the list of all auth sources for the specified user (or the currently logged in user).
javax.ws.rs.core.Response	listUsers(javax.servlet.http.HttpServletRequest request) List all users who have authenticated at least once with the site.
javax.ws.rs.core.Response	requestSync(javax.servlet.http.HttpServletRequest request, long uid, long aid) Create a synchronization request for an account.
javax.ws.rs.core.Response	restoreSyncAccount(javax.servlet.http.HttpServletRequest request, long uid, long aid) Restore an account marked for deletion.
javax.ws.rs.core.Response	saveAccessKey(javax.servlet.http.HttpServletRequest request, long uid, long aid, long kid, enterprises.orbital.evekit.account.SynchronizedAccountAccessKey key) Create or update an access key.
javax.ws.rs.core.Response	saveSyncAccount(javax.servlet.http.HttpServletRequest request, long uid, long aid, String name, boolean charType, boolean autoSync) Create or update a synchronized account.
javax.ws.rs.core.Response	toggleActive(javax.servlet.http.HttpServletRequest request, long uid, boolean active) Change the active state for a user.
javax.ws.rs.core.Response	toggleAutoSync(javax.servlet.http.HttpServletRequest request, long uid, long aid, boolean autosync) Change auto synchronization of a synchronized account

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountWS

public AccountWS()

Method Detail

checkRequireAdmin

public static javax.ws.rs.core.Response checkRequireAdmin(enterprises.orbital.evekit.account.EveKitUserAccount user,
                                                          long uid)

Checks whether the authenticated user is an administrator in cases where the ID of the authenticated user is different than the ID of the user being acted upon.

Parameters:

user - authenticated user

uid - ID of the user being acted upon, or -1 if another user is NOT being acted upon

Returns:

an error response if the authenticated user must be an admin but is not, otherwise null

createUserNotLoggedResponse

public static javax.ws.rs.core.Response createUserNotLoggedResponse()

Generate a response for a user who is not logged in.

Returns:

ready to return error response.

getSyncAccount

@Path(value="/sync_account/{uid}/{aid}")
 @GET
public javax.ws.rs.core.Response getSyncAccount(@Context
                                                                                               javax.servlet.http.HttpServletRequest request,
                                                                                               @PathParam(value="uid")
                                                                                               long uid,
                                                                                               @PathParam(value="aid")
                                                                                               long aid)

Retrieve list of sync accounts.

Parameters:

request - incoming HTTP request

uid - requesting user, or -1 for logged in user

aid - requested account, or -1 for all accounts

Returns:

list of accounts

saveSyncAccount

@Path(value="/sync_account/{uid}/{aid}")
 @POST
public javax.ws.rs.core.Response saveSyncAccount(@Context
                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                 @PathParam(value="uid")
                                                                                                 long uid,
                                                                                                 @PathParam(value="aid")
                                                                                                 long aid,
                                                                                                 @QueryParam(value="name")
                                                                                                 String name,
                                                                                                 @QueryParam(value="charType")
                                                                                                 boolean charType,
                                                                                                 @QueryParam(value="autoSync")
                                                                                                 boolean autoSync)

Create or update a synchronized account.

Parameters:

request - incoming HTTP request

uid - requesting user, or -1 to use the currently logged in user

aid - account to update, or -1 to create a new account

name - name of new account, or new name of existing account

charType - if true, account will synchronize a character type. False otherwise. Ignored for updates to existing accounts.

autoSync - if true, account will auto-synchronize. False otherwise.

Returns:

newly created or modified account

deleteSyncAccount

@Path(value="/sync_account/{uid}/{aid}")
 @DELETE
public javax.ws.rs.core.Response deleteSyncAccount(@Context
                                                                                                     javax.servlet.http.HttpServletRequest request,
                                                                                                     @PathParam(value="uid")
                                                                                                     long uid,
                                                                                                     @PathParam(value="aid")
                                                                                                     long aid)

Delete sync account.

Parameters:

request - incoming HTTP request

uid - requesting user, or -1 for the currently logged in user

aid - account to delete

Returns:

OK if marked for delete is successful

restoreSyncAccount

@Path(value="/restore_sync_account/{uid}/{aid}")
 @PUT
public javax.ws.rs.core.Response restoreSyncAccount(@Context
                                                                                                           javax.servlet.http.HttpServletRequest request,
                                                                                                           @PathParam(value="uid")
                                                                                                           long uid,
                                                                                                           @PathParam(value="aid")
                                                                                                           long aid)

Restore an account marked for deletion.

Parameters:

request - incoming HTTP request

uid - requesting user, or -1 to use current logged in user

aid -

Returns:

requestSync

@Path(value="/start_sync/{uid}/{aid}")
 @GET
public javax.ws.rs.core.Response requestSync(@Context
                                                                                          javax.servlet.http.HttpServletRequest request,
                                                                                          @PathParam(value="uid")
                                                                                          long uid,
                                                                                          @PathParam(value="aid")
                                                                                          long aid)

Create a synchronization request for an account.

Parameters:

request - incoming HTTP request

uid - requesting user, or -1 to use the logged in user

aid - account to synchronize

Returns:

OK if the request is created properly

getAccessKey

@Path(value="/access_key/{uid}/{aid}/{kid}")
 @GET
public javax.ws.rs.core.Response getAccessKey(@Context
                                                                                                 javax.servlet.http.HttpServletRequest request,
                                                                                                 @PathParam(value="uid")
                                                                                                 long uid,
                                                                                                 @PathParam(value="aid")
                                                                                                 long aid,
                                                                                                 @PathParam(value="kid")
                                                                                                 long kid)

Get list of access keys.

Parameters:

request - incoming HTTP request

uid - user for which keys will be retrieved

aid - account for which keys will be retrieved

kid - specific key to retrieve, or -1 to retrieve all keys

Returns:

the list of requested keys

saveAccessKey

@Path(value="/access_key/{uid}/{aid}/{kid}")
 @POST
public javax.ws.rs.core.Response saveAccessKey(@Context
                                                                                                   javax.servlet.http.HttpServletRequest request,
                                                                                                   @PathParam(value="uid")
                                                                                                   long uid,
                                                                                                   @PathParam(value="aid")
                                                                                                   long aid,
                                                                                                   @PathParam(value="kid")
                                                                                                   long kid,
                                                                                                   enterprises.orbital.evekit.account.SynchronizedAccountAccessKey key)

Create or update an access key.

Parameters:

request - incoming HTTP request

uid - user for which key will be created or updated

aid - account for which key will be created or updated

kid - key to modify, or -1 to create a new key

key - key containing values to store or copy to an updated key

Returns:

created or updated access key

deleteAccessKey

@Path(value="/access_key/{uid}/{aid}/{kid}")
 @DELETE
public javax.ws.rs.core.Response deleteAccessKey(@Context
                                                                                                       javax.servlet.http.HttpServletRequest request,
                                                                                                       @PathParam(value="uid")
                                                                                                       long uid,
                                                                                                       @PathParam(value="aid")
                                                                                                       long aid,
                                                                                                       @PathParam(value="kid")
                                                                                                       long kid)

Delete access key.

Parameters:

request - incoming HTTP request

uid - user owning key to be deleted

aid - account owning key to be deleted

kid - ID of key to be deleted

Returns:

OK status if delete is successful.

getUserLastSource

@Path(value="/user_last_source/{uid}")
 @GET
public javax.ws.rs.core.Response getUserLastSource(@Context
                                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                                @PathParam(value="uid")
                                                                                                long uid)

Get the last source used to login for the specified user (or currently logged in user).

Parameters:

request - incoming HTTP request

uid - user for which we're retrieving the source, or -1 for the currently authenticated user.

Returns:

the last source used to authenticate for the specified user.

getUserSources

@Path(value="/user_sources/{uid}")
 @GET
public javax.ws.rs.core.Response getUserSources(@Context
                                                                                         javax.servlet.http.HttpServletRequest request,
                                                                                         @PathParam(value="uid")
                                                                                         long uid)

Return the list of all auth sources for the specified user (or the currently logged in user).

Parameters:

request - incoming HTTP request

uid - the user for which sources will be retrieved, or -1 for the currently authenticated user

Returns:

the list of auth sources for the specified user.

getUser

@Path(value="/user")
 @GET
public javax.ws.rs.core.Response getUser(@Context
                                                                    javax.servlet.http.HttpServletRequest request)

Get the currently authenticated user.

Parameters:

request - incoming HTTP request

Returns:

the currently authenticated user, or null if no user authenticated

listUsers

@Path(value="/list_users")
 @GET
public javax.ws.rs.core.Response listUsers(@Context
                                                                            javax.servlet.http.HttpServletRequest request)

List all users who have authenticated at least once with the site. This is an admin only service.

Parameters:

request - incoming HTTP request

Returns:

the list of all authenticated users.

toggleAutoSync

@Path(value="/toggle_auto_sync/{uid}/{aid}/{autosync}")
 @GET
public javax.ws.rs.core.Response toggleAutoSync(@Context
                                                                                                              javax.servlet.http.HttpServletRequest request,
                                                                                                              @PathParam(value="uid")
                                                                                                              long uid,
                                                                                                              @PathParam(value="aid")
                                                                                                              long aid,
                                                                                                              @PathParam(value="autosync")
                                                                                                              boolean autosync)

Change auto synchronization of a synchronized account

Parameters:

request - incoming HTTP request

uid - user which owns the account to be changed

aid - account to be changed

autosync - new auto synchronization setting

Returns:

OK if the setting was changed successfully.

toggleActive

@Path(value="/toggle_user_active/{uid}/{active}")
 @GET
public javax.ws.rs.core.Response toggleActive(@Context
                                                                                                      javax.servlet.http.HttpServletRequest request,
                                                                                                      @PathParam(value="uid")
                                                                                                      long uid,
                                                                                                      @PathParam(value="active")
                                                                                                      boolean active)

Change the active state for a user.

Parameters:

request - incoming HTTP request

uid - user for which state will be changed

active - new active state for user

Returns:

OK if state changed successfully.

checkAdmin

@Path(value="/isadmin")
 @GET
public javax.ws.rs.core.Response checkAdmin(@Context
                                                                          javax.servlet.http.HttpServletRequest request)

Check whether the authenticated user is an admin.

Parameters:

request - incoming HTTP request

Returns:

an object containing an "isAdmin" field which is true if the current user is an admin.

charEndpoints

@Path(value="/list_char_endpoints")
 @GET
public javax.ws.rs.core.Response charEndpoints(@Context
                                                                                         javax.servlet.http.HttpServletRequest request)

Return list of character ESI endpoints.

Parameters:

request - incoming HTTP request

Returns:

the list of all character ESI endpoints.

corpEndpoints

@Path(value="/list_corp_endpoints")
 @GET
public javax.ws.rs.core.Response corpEndpoints(@Context
                                                                                         javax.servlet.http.HttpServletRequest request)

Return list of corporation ESI endpoints.

Parameters:

request - incoming HTTP request

Returns:

the list of all corporation ESI endpoints.