Category: magico mondo de Java

RESTEasy: le chiamate rest in Java

In questo piccolo tutorial vedremo come realizzare una piccola chiamata REST verso un servizio remoto, il tutto realizzato in Java. Ricordiamo che le chiamate REST consentono di invocare servizi remoti tramite il protocollo HTTP.
La libreria che ho utilizzato per il supporto alle chiamate REST è RESTEasy la quale oltre al supporto HTTP fornisce il supporto alle annotation JAX-RS. Vediamo subito come procedere. Intanto, utilizzando il vostro IDE preferito (Eclipse ad esempio) create un nuovo progetto e aggiungete le seguente librerie nel build path: 

libraries

Alcune di queste non sono essenziali per la creazione del servizio, ma vi consiglio comunque di lasciarle in modo tale da avere supporto a future implementazioni. Il progetto che sono andato a creare è J2EE installato all’interno di tomcat. Ogni servizio verrà testato da una unit test presente all’interno del progetto stesso, così da verificare la correttezza del servizio. Quindi si parte con la configurazione del nostro web descriptor in modo da configurare il nostro contesto: 

<?xml version="1.0" encoding="UTF-8"?>
 
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 
    <display-name>resteasy</display-name>
 
    <listener>
        <listener-class>
            org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap
        </listener-class>
    </listener>
 
    <servlet>
        <servlet-name>drest</servlet-name>
        <servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</servlet-class>
    </servlet>
 
    <servlet-mapping>
        <servlet-name>drest</servlet-name>
        <url-pattern>/restful-services/*</url-pattern>
    </servlet-mapping>
 
    <context-param>
         <param-name>resteasy.scan</param-name>
        <param-value>true</param-value>    
    </context-param>
 
 
    <context-param>
        <param-name>resteasy.servlet.mapping.prefix</param-name>
        <param-value>/restful-services</param-value>
    </context-param>
 
</web-app>

Fatto questo procediamo con la definizione del servizio. Una premessa fondamentale da fare è la seguente: la creazione di un servizio REST richiede una fase di progettazione attenta e puntuale, in cui molti aspetti devono essere tenuti in considerazione e risolti nel migliore dei modi. L’accesso al servizio, l’autenticazione, l’invio dei dati in input e la restituzione del risultato sono tutti aspetti che fanno parte della progettazione di un servizio. Ciò detto, nel nostro esempio, non considereremo la fase di progettazione in tutti i suoi punti, ma procederemo con la creazione di un servizio a scopo di esempio. Definiamo quindi la classe contenitore del nostro servizio attraverso l’utilizzo delle annotation:

@Path("/devmeservice")
public class DevMeService {
 
	@GET
    @Path("/v1/passes/{pass_type_id}/{device_id}")
    @Produces("text/plain")
    public Response getPassLatestVersion(@HeaderParam("Authorization") String authorization,
					   @PathParam("pass_type_id")String pass_type_id,
					   @PathParam("serial_number")String serial_number){
 
		String auth_token = null;
		if (!authorization.matches("^ApplePass.*")) {
			return Response.status(HttpStatus.SC_FORBIDDEN).build();
		}
		String [] items = authorization.split(" ");
		if (items.length!=2) {
			return Response.status(HttpStatus.SC_FORBIDDEN).build();
		}
 
		auth_token = items[1];
 
		String sql = "SELECT * " +
			 "FROM passes " +
			 "WHERE serial_number = ? AND authentication_token = ? LIMIT 1";
		DBHandle dbhandle = DBHandle.getInstance();
		try {
			PreparedStatement ps = dbhandle.getPreparedStatement(sql);
			ps.setString(1, serial_number);
			ps.setString(2, pass_type_id);
			ResultSet rs = ps.executeQuery();
			if (rs.next()) {
				String pass = readFile(/* PASSES ROOT PATH */"/data/passes/"+serial_number+"/pass.json");
 
			}else {
				return Response.status(HttpStatus.SC_UNAUTHORIZED).build();
			}
		} catch (SQLException e) {
			log.error("Error while registering new device.", e);
			return Response.status(HttpStatus.SC_SERVICE_UNAVAILABLE).build();
		} finally {
			dbhandle.close();
		}
		return null;
    }
 
}

Il metodo di sopra restituisce l’ultima versione di un pass (Passbook) associato ad un particolare dispositivo, sulla base di un codice di autorizzazione concesso al client e dei dati associato al pass stesso. Il metodo verifica prima se il client è autorizzato all’accesso al servizio e successivamente tenta di recuperare le informazioni associate al pass e quindi di restituirlo in output.
Si noti l’utilizzo delle annotation in testa alla classe e in testa al nostro metodo, la prima definizione il nome del servizio che dovrà essere invocato, una sorta di base url. Le seconde annotation definiscono il metodo HTTP che viene utilizzato per l’invocazione del metodo, il percorso del servizio ed infine il mime type della risposta fornita dal metodo. Invocando il servizio con un client HTTP saremo in grado di ottenere la risposta da elaborare localmente.

Nei prossimi articoli tratteremo altri contesti in cui utilizzare le chiamate REST, come i Passbook recentemente introdotti dalla Apple come prossima release in iOS6.

Stay tuned!

Autenticazione facebook: la guida definitiva

logo_facebookSalve a tutti, negli ultimi tempi mi sto divertendo con diverse tecnologie, tra cui le app facebook. In realtà, il progetto ha richiesto lo sviluppo di un’applicazione facebook relativamente semplice, in cui il punto centrale è costituito dalla app request, ovvero le notifiche inviate all’utente dall’applicazione in uso dall’utente, una sorta di notifiche Push iOS style.
Al netto di questa cosa, ho trovato difficoltà nell’implementare il meccanismo di autenticazione richiesto da facebook, ma non perché lo stesso sia difficile, ma semplicemente perché sul sito ufficiale è molto confusa la spiegazione delle API open graph 2, e poi non ho trovato nessuna guida o tutorial che ne descrivesse l’utilizzo. Per questo motivo voglio condividere l’implementazione del meccanismo di autenticazione che ho realizzato all’interno della mia applicazione.

Cominciamo col dire che il back-end dell’applicazione è Java (strano eh!), nello specifico ho utilizzato delle API restFB, che consentono l’interazione con i servizi REST messi a disposizione da facebook. L’applicazione Java utilizza le servlet per interagire con l’utente, quindi in sostanza è un’applicazione web. Per poter utilizzare i servizi REST di facebook è necessario avere a disposizione un access-token, una chiave che consente di identificare l’entità che sta effettuando la richiesta e se la stessa possiede i privilegi per poterla invocare.

Di seguito la procedura per ottenere un access token:

1. https://graph.facebook.com/oauth/authorize?client_id=FACEBOOK_APP_ID&redirect_uri=REDIRECT_URL

2. https://graph.facebook.com/oauth/access_token?client_id=FACEBOOK_APP_ID&redirect_uri=REDIRECT_URL&code=CODE&
client_secret=APP_SECRET

3. Risposta con access token. 

Si parte con una richiesta HTTP all’indirizzo di cui al punto 1, fornendo come parametro la FACEBOOK_APP_ID, ovvero l’id dell’applicazione facebook creata ed un REDIRECT_URL, ovvero un indirizzo di rimando a cui verrà restituita una response contenente un codice, CODE. Lo stesso CODE, dovrà essere fornito come parametro all’indirizzo di cui al punto 2, assieme al FACEBOOK_APP_ID e di nuovo un REDIRECT_URL. Infine, a quest’ultimo verrà restituito una response contenente l’access token, come valore del primo parametro presente nell’URL.

Il punto centrale dell’applicazione Java web è costituito da una servlet filter, la quale viene invocata ogni qual volta si tenta di accedere ad una risorsa dall’applicazione facebook. La filter verifica che sia presente in sessione l’access token, il quale viene messo lì per ovvi motivi di comodità, non appena viene recuperato dalla procedura di autenticazione. Di seguito il codice della servlet filter:

 

void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    HttpServletRequest httpRequest = (HttpServletRequest) request;
    HttpServletResponse httpResponse = (HttpServletResponse) response;
    HttpSession session = httpRequest.getSession();
 
    if (session.getAttribute(FacebookAuthConfig.OAUTH_TOKEN)==null) {
            FacebookAuthConfig facebookConfig = session.getFacebookConfiguration();
 
            String redirectURL = httpRequest.getRequestURL().toString();
            String code = StringUtils.noNullAndTrim(request.getParameter("code"));
            if (code.length()==0) {
                String tokenReqUrl = "https://graph.facebook.com/oauth/authorize?client_id="+facebookConfig.getAppID()+
                                     "&redirect_uri="+redirectURL;
                httpResponse.sendRedirect(tokenReqUrl);
                return;
            }
 
            String tokenUrl = "https://graph.facebook.com/oauth/access_token?client_id="+facebookConfig.getAppID()+
                             "&redirect_uri="+redirectURL+"&code="+code+"&client_secret="+facebookConfig.getAppSecret();
 
            DefaultWebRequestor webRequestor = new DefaultWebRequestor();
            Response fbresponse = webRequestor.executeGet(tokenUrl);
            String rawAccessToken = new String(fbresponse.getBody());
 
            String accessToken;
            if (rawAccessToken.indexOf("&") > -1) {
                rawAccessToken = rawAccessToken.split("&")[0];
            }
            accessToken = rawAccessToken.split("=")[1];
            session.setAttribute(FacebookAuthConfig.OAUTH_TOKEN, accessToken);
            User user = null;
 
            FacebookClient facebookClient = new DefaultFacebookClient(accessToken);
            int attempt = 0;
            do {
                attempt++;
                log.info("* Fetching single objects *");
                try {
                    user = facebookClient.fetchObject("me", User.class);
                    logger.info("User name: " + user.getName());
                } catch (Exception e) {
                     if (attempt==1) {
                        log.warn("Error while quering data to Facebook service. Try again..");
                        continue;
                     } else {
                        log.info("Request error. Can't retrieve data from facebook service.");
                        httpResponse.sendRedirect(errorPage);
                        return;	
                    }
                }
                break;
            } while (true);
 
            session.setAttribute(FACEBOOK_USER_OBJ, user);
            session.setAttribute(OAUTH_TOKEN, accessToken);                    
    }
}

 La prima richiesta HTTP viene invocata per ottenere il CODE da rimandare come parametro nella seconda richiesta HTTP, si noti che nella prima richiesta, il REDIRECT_URL coincide con la stessa risorsa invocata. In questo modo, alla risposta in cui è presente il parametro CODE, è possibile procedere e quindi invocare la seconda richiesta. Quest’ultima viene invocata utilizzando le restFB API, ottenendo quindi la risposta raw direttamente nel body della response. Da lì viene estratta e resa disponibile in sessione. Successivamente viene eseguita una chiamata al servizio REST di facebook per ottenere informazioni riguardo l’utente che ha invocato la risorsa, e se la chiamata va a buon fine, viene aggiunto in sessione l’oggetto User messo a disposizione dalle restFB API. 

That’s all. Stay connected !

WordPress Themes