enterprises.orbital.evekit.ws.account

Class CredentialWS

java.lang.Object

enterprises.orbital.evekit.ws.account.CredentialWS

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

Web service for managing synchronization credentials.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEF_APP_PATH
static String	DEF_ESI_SERVER_PATH
static String	DEF_REAUTH_SUCCESS_FRAGMENT
static String	DEF_SITE_AGENT
static long	DEF_TEMP_TOKEN_LIFETIME
static Logger	log
static String	PROP_APP_PATH
static String	PROP_ESI_SERVER_PATH
static String	PROP_EVE_VERIFY_URL
static String	PROP_REAUTH_SUCCESS_FRAGMENT
static String	PROP_SITE_AGENT
static String	PROP_TEMP_TOKEN_LIFETIME
static String	PROP_TOKEN_EVE_CLIENT_ID
static String	PROP_TOKEN_EVE_SECRET_KEY

Constructor Summary

Constructors

Constructor and Description
CredentialWS()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	clearESICredential(javax.servlet.http.HttpServletRequest request, long aid) Clear the ESI credential from a synchronized account.
javax.ws.rs.core.Response	clearXMLCredential(javax.servlet.http.HttpServletRequest request, long aid) Clear the XML credential from a synchronized account.
javax.ws.rs.core.Response	esiCredentialCallback(javax.servlet.http.HttpServletRequest req) Handle the second part of setting an ESI credential by accepting the OAuth callback.
protected static org.apache.http.client.utils.URIBuilder	makeStandardBuilder() Create a URI builder initialized with the main application URL.
protected static void	processTokenCallback(javax.servlet.http.HttpServletRequest req, String verifyURL, String eveClientID, String eveSecretKey) Process the end of an OAuth flow to set an ESI credential.
javax.ws.rs.core.Response	setESICredential(javax.servlet.http.HttpServletRequest request, long aid, String scopes) Start the process to set an ESI credential.
javax.ws.rs.core.Response	setXMLCredential(javax.servlet.http.HttpServletRequest request, long aid, int key, long charID, String vcode) Set the XML API credential associated with a Synchronized EVE account.
protected static javax.ws.rs.core.Response	startTokenFlow(javax.servlet.http.HttpServletRequest request, enterprises.orbital.evekit.account.EveKitUserAccount user, enterprises.orbital.evekit.account.SynchronizedEveAccount account, String scopes) Start new OAuth flow.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final Logger log

PROP_TOKEN_EVE_CLIENT_ID

public static final String PROP_TOKEN_EVE_CLIENT_ID

See Also:

Constant Field Values

PROP_TOKEN_EVE_SECRET_KEY

public static final String PROP_TOKEN_EVE_SECRET_KEY

See Also:

Constant Field Values

PROP_EVE_VERIFY_URL

public static final String PROP_EVE_VERIFY_URL

See Also:

Constant Field Values

PROP_ESI_SERVER_PATH

public static final String PROP_ESI_SERVER_PATH

See Also:

Constant Field Values

DEF_ESI_SERVER_PATH

public static final String DEF_ESI_SERVER_PATH

See Also:

Constant Field Values

PROP_APP_PATH

public static final String PROP_APP_PATH

See Also:

Constant Field Values

DEF_APP_PATH

public static final String DEF_APP_PATH

See Also:

Constant Field Values

PROP_TEMP_TOKEN_LIFETIME

public static final String PROP_TEMP_TOKEN_LIFETIME

See Also:

Constant Field Values

DEF_TEMP_TOKEN_LIFETIME

public static final long DEF_TEMP_TOKEN_LIFETIME

PROP_REAUTH_SUCCESS_FRAGMENT

public static final String PROP_REAUTH_SUCCESS_FRAGMENT

See Also:

Constant Field Values

DEF_REAUTH_SUCCESS_FRAGMENT

public static final String DEF_REAUTH_SUCCESS_FRAGMENT

See Also:

Constant Field Values

PROP_SITE_AGENT

public static final String PROP_SITE_AGENT

See Also:

Constant Field Values

DEF_SITE_AGENT

public static final String DEF_SITE_AGENT

See Also:

Constant Field Values

Constructor Detail

CredentialWS

public CredentialWS()

Method Detail

makeStandardBuilder

protected static org.apache.http.client.utils.URIBuilder makeStandardBuilder()

Create a URI builder initialized with the main application URL.

Returns:

initialized URI builder

startTokenFlow

protected static javax.ws.rs.core.Response startTokenFlow(javax.servlet.http.HttpServletRequest request,
                                                          enterprises.orbital.evekit.account.EveKitUserAccount user,
                                                          enterprises.orbital.evekit.account.SynchronizedEveAccount account,
                                                          String scopes)
                                                   throws IOException

Start new OAuth flow.

Parameters:

request - incoming request

user - authorizing user

account - account which will store new ESI token

scopes - requested scopes

Returns:

response containing authorization URL for client

Throws:

IOException - if an error occurs while starting the flow

processTokenCallback

protected static void processTokenCallback(javax.servlet.http.HttpServletRequest req,
                                           String verifyURL,
                                           String eveClientID,
                                           String eveSecretKey)
                                    throws enterprises.orbital.evekit.account.AccountUpdateException,
                                           IOException

Process the end of an OAuth flow to set an ESI credential.

Parameters:

req - incoming OAuth callback request

verifyURL - EVE SSO verify URL to retrieve authorized character info

eveClientID - EVE SSO client ID

eveSecretKey - EVE SSO secret key

Throws:

enterprises.orbital.evekit.account.AccountUpdateException - if an inconsistent state would result from setting the credential

IOException - on any other error

setXMLCredential

@Path(value="/cred_xml/{aid}")
 @POST
public javax.ws.rs.core.Response setXMLCredential(@Context
                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                        @PathParam(value="aid")
                                                                                        long aid,
                                                                                        @QueryParam(value="key")
                                                                                        int key,
                                                                                        @QueryParam(value="charID")
                                                                                        long charID,
                                                                                        String vcode)

Set the XML API credential associated with a Synchronized EVE account.

Parameters:

request - inbound request

aid - account ID

charID - character ID to be used with XML credentials

key - XML API access key

vcode - XML API access verificaation code

Returns:

the modified SynchronizedEveAccount if the change is successful.

setESICredential

@Path(value="/cred_esi/{aid}")
 @POST
public javax.ws.rs.core.Response setESICredential(@Context
                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                        @PathParam(value="aid")
                                                                                        long aid,
                                                                                        String scopes)

Start the process to set an ESI credential. If OAuth authorization succeeds, the actual set call is made in the callback function.

Parameters:

request - incoming HTTP request

aid - account on which credential will be set

scopes - request scopes

Returns:

an OK response containing the authorization URL which should be redirected to

esiCredentialCallback

@Path(value="/esi_callback")
 @GET
public javax.ws.rs.core.Response esiCredentialCallback(@Context
                                                                                          javax.servlet.http.HttpServletRequest req)

Handle the second part of setting an ESI credential by accepting the OAuth callback. A redirect is always returned, even on error. In the case of an error, the auth_error query string will be set for processing on the browser.

Parameters:

req - incoming HTTP request

Returns:

a redirect response or error message

clearXMLCredential

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

Clear the XML credential from a synchronized account.

Parameters:

request - incoming HTTP request

aid - account to clear

Returns:

OK if credential cleared successfully, otherwise an error.

clearESICredential

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

Clear the ESI credential from a synchronized account.

Parameters:

request - incoming HTTP request

aid - account to clear

Returns:

OK if credential cleared successfully, otherwise an error.