Table of Contents

Laborator 11. Transmiterea de Notificări folosind Serviciul Google Cloud Messaging

Google Cloud Messaging for Android (GCM) este un serviciu gratuit prin intermediul căruia programatorii pot transmite informații între un server de aplicații și un dispozitiv mobil (pe care rulează sistemul de operare Android), implementând toate aspectele legate de gestiunea mesajelor, asigurând livrarea acestora. Nu există nici un fel de limite în privința resurselor implicate pentru transmiterea acestor informații.

Necesitatea unui astfel de serviciu este impusă de optimizările specifice aplicațiilor pentru dispozitive mobile:

Serviciile precum Google Cloud Messaging for Android implementează cele mai bune practici în domeniu pentru tratarea acestor aspecte, astfel încât programatorul se poate concentra exclusiv asupra funcționalității aplicației.

Comunicația dintre cele două entități se poate realiza în ambele sensuri:

Google Cloud Messaging for Android nu pune la dispoziție un API pentru procesarea mesajelor, acestea fiind trimise exact în forma în care au fost primite.

Un mesaj transmis prin intermediul Google Cloud Messaging poate:

Pentru dispozitivele mobile cu o versiune a sistemului de operare Android mai mică decât 3.0 este necesară crearea unui cont de utilizator Google. Această cerință nu este obligatorie pentru versiuni mai mari decât 4.0.4.

Google Cloud Messaging for Android nu poate fi utilizat pe platforme care au instalată o versiune a sistemului de operare Android anterioară 2.2.

Arhitectura Google Cloud Messaging for Android

Un sistem informatic folosind infrastructura de comunicații Google Cloud Messaging for Android implică dezvoltarea următoarelor componente:

De regulă, procesul de proiectare și dezvoltare a sistemului informatic implică următorul flux de lucru:

1. se obține un număr de proiect prin intermediul Google Developers Console, prin care un dezvoltator este identificat în mod unic; de asemenea, se activează serviciul Google Cloud Messaging;
2. se implementează aplicația Android care va rula pe client:

Generarea unui identificator de înregistrare se realizează o singură dată, urmând ca această valoare să fie stocată pentru a fi utilizată ulteror. În situația în care nu se mai dorește ca mesajele să fie primite, se poate realiza și procesul invers, de anulare a înregistrării realizate anterior.

În situația în care prelucrarea unui mesaj implică un volum de procesare semnificativ, se recomandă ca acesta să fie realizat prin intermediul unui serviciu, după ce s-a obținut un mutex (de tip PowerManager.WakeLock) care să prevină trecerea dispozitivului mobil într-o stare latentă.

3. se obține o cheie publică pentru serverul de aplicații ce va fi utilizată în procesul de autentificare pentru a obține drepturi de accesare a serverului Google Cloud Messaging prin intermediul căruia vor fi transmise mesajele;
4. se implementează serverul de aplicații:

Un mesaj transmis de pe serverul de aplicații va fi stocat într-o coadă de așteptare pe serverul Google Cloud Messaging și livrat în momentul în care dispozitivul mobil este disponibil.

Configurare

1. Prin intermediul Consolei Google API, se obțin numărul de proiect și cheia publică ce vor fi utilizate de dispozitivul mobil, respectiv de serverul de aplicații pentru a se autentifica în cadrul Google Cloud Messaging for Android.

Trebuie să fiți autentificați folosind numele de utilizator și parola contului Google, altfel va trebui să vă creați un astfel de cont.

Configurare client

2. Se instalează SDK-ul Google Play Services, necesară autentificării / deautentificării la Google Cloud Messaging for Android din cadrul aplicației instalată pe dispozitivul mobil.

3. Se configurează emulatorul astfel încât să poată fi rulată aplicația Android ce folosește Google Cloud Messaging.

Pentru aplicațiile ce rulează pe dispozitivul fizic (având o versiune a sistemului de operare Android ulterioară 2.2) nu este necesară nici o configurare suplimentară (cu excepția asocierii unui cont Google, prin specificarea parametrilor acestuia - nume de utilizator și parolă).

4. În situația în care se va folosi un server CCS (XMPP), în prezent, nu mai este necesară o înregistrare suplimentară pentru a se obține acceptul Google de a utiliza serviciul de transmitere a mesajelor de pe dispozitivul mobil. Anterior, o astfel de solicitare trebuia transmisă la Upstream Google Cloud Messaging and User Notifications Sign-up.

Configurare server (opțional)

Pot exista mai multe variante de implementare a unui server de aplicații, în acest caz fiind aleasă o soluție care implică un efort redus de configurare și de implementare propriu-zisă.
Ca atare, se va proiecta un server de aplicații care va trimite mesaje către serverul Google Cloud Messaging, respectiv va primi mesaje de la un client Android folosind protocolul HTTP. Pentru dezvoltarea acestei funcționalități, soluția aleasă se bazează pe pagini Internet generate cu Java Servlets și utilizând un motor pentru gestiunea bazelor de date MySQL, serverul web folosit fiind Apache Tomcat.

5. Se descarcă cea mai recentă versiune stabilă a serverului web Apache Tomcat (zip|tar.gz) și se dezarhivează.

6. Se descarcă cea mai recentă versiune stabilă a mediului de dezvoltare Eclipse IDE for Java EE Developers (Windows: 32-bit|64-bit, Linux: 32-bit|64-bit) și se integrează cu serverul web Apache Tomcat.

Se oferă și posibilitatea descărcării și instalării unei instanțe a serverului web Apache Tomcat, însă de regulă aceasta nu referă cea mai recentă versiune.

7. Se descarcă și se instalează cea mai recentă versiune stabilă a motorului pentru baze de date MySQL.

Configurarea propriu-zisă nu presupune decât specificarea unei parole de administrare.

Pentru gestiunea propriu-zisă a bazelor de date, poate fi utiliza MySQL Workbench Windows|Ubuntu|Fedora Core|Red Hat, Mac OS X.

De asemenea, se poate accesa consola MySQL folosind comanda 

student@pdsd2015:~$ mysql -u root -p

Va trebui indicată parola, atunci când aceasta este solicitată.

Proiectarea și dezvoltarea clientului

Proiectul Eclipse

Există posibilitatea ca rularea proiectului Eclipse să necesite mai multă memorie ce trebuie alocată mașinii virtuale Java, aceasta realizându-se prin intermediul valorilor furnizate în cadrul fișierului de configurare eclipse.ini:

--launcher.XXMaxPermSize
1024M
--launcher.XXMaxPermSize
1024m
--launcher.appendVmargs
-vmargs
-Dosgi.requiredJavaVersion=1.7
-Xms1024m
-Xmx1024m

Se realizează o referință către biblioteca pentru accesarea Google Cloud Messaging care este localizată în <android-sdk>/extras/google/google_play_services/libproject/google-play-services_lib

Structura Proiectului

Aplicația Android care va rula pe dispozitivul mobil va consta din:

  1. o activitate (GoogleCloudMessagingActivity) care:
    1. verifică dacă pe dispozitivul mobil este instalat Google Play Services și dacă această aplicație este actualizată;
    2. permite înregistrarea dispozitivului mobil la serverul Google Cloud Messaging dacă această operație nu a fost realizată în prealabil (o astfel de informație ar trebui stocată în SharedPreferences astfel încât operația să fie realizată o singură dată);
    3. transmite identificatorul de înregistrare obținut către serverul de aplicații (împreună cu alte informații prin care să poată fi recunoscut dispozitivul mobil - de exemplu, un nume de utilizator sau o adresă de posță electronică);
  2. un ascultător pentru mesajele cu difuzare (GoogleCloudMessagingBroadcastReceiver) către care este livrat un mesaj transmis de serverul Google Cloud Messaging, prin intermediul unei intenții;
  3. (opțional) un serviciu (GoogleCloudMessagingIntentService) lansat în execuție în momentul în care este livrat mesajul (de către ascultător) în cadrul căruia acesta este procesat propriu-zis; utilizarea unui serviciu este necesară doar în situația în care prelucrarea mesajului se realizează într-un interval de timp mai mare, fiind necesar să se asigure faptul că dispozitivul mobil nu devine inactiv între timp.

Activitatea GoogleCloudMessagingActivity

Pe lângă implementarea interfeței grafice prin care se asigură interacțiunea cu utilizatorul, activitatea GoogleCloudMessagingActivity este responsabilă pentru:

1. verificarea compatibilității dispozitivului mobil pe care rulează aplicația cu Google Play Services, SDK pe care se bazează Google Cloud Messaging; această operație trebuie să se realizeze în momentul în care aplicația devine vizibilă (deci pe metoda onResume()), astfel încât și în situația în care activitatea a fost întreruptă, să se identifice situația în care aceasta a fost instalată sau actualizată: 

private boolean checkPlayServices() {
  int resultCode = GooglePlayServicesUtil.isGooglePlayServicesAvailable(this);
  if (resultCode != ConnectionResult.SUCCESS) {
    if (GooglePlayServicesUtil.isUserRecoverableError(resultCode)) {
      GooglePlayServicesUtil.getErrorDialog(resultCode, this, Configuration.PLAY_SERVICES_RESOLUTION_REQUEST).show();
    } else {
      Log.i(Constants.TAG, Constants.GOOGLE_PLAY_SERVICES_ERROR_MESSAGE2);
      finish();
    }
    return false;
  }
  return true;
}

În situația în care dispozitivul mobil este compatibil cu Google Play Services (rulează un sistem de operare Android cu o versiune mai mare decât 2.2), se lasă utilizatorului posibilitatea de a-l instala (sau actualiza, după caz) prin afișarea unei ferestre de dialog, altfel aplicația este terminată.

2. înregistrarea dispozitivului mobil la Google Cloud Messaging, în situația în care această operație nu s-a realizat în prealabil (nu există o astfel de valoare stocată ca preferință a utilizatorului): 

private void registerInBackground() {
  new AsyncTask<Object, Integer, String>() {
    @Override
    protected String doInBackground(Object... params) {
      try {
        if (googleCloudMessaging == null) {
          googleCloudMessaging = GoogleCloudMessaging.getInstance(context);
        }
        registrationId = googleCloudMessaging.register(Configuration.PROJECT_NUMBER);
        // store the registration ID into the SharedPreferences
        // the ID is not yet registered with the application server
        Utilities.setInformationIntoSharedPreferences(GoogleCloudMessagingActivity.this, registrationId, Constants.FAILURE);
      } catch (IOException ioException) {
	registrationId = "An exception has occurred: " + ioException.getMessage();
        if (Constants.DEBUG) {
          ioException.printStackTrace();
        }
      }
      return registrationId;
    }
 
    @Override
    protected void onPostExecute(String registrationId) {
      Log.i(Constants.TAG, Constants.REGISTRATION_ID_INFORMATION_MESSAGE + registrationId);
      if (unregisteredFragment != null) {
        unregisteredFragment.setRegistrationIdTextView(registrationId);
      }
    }
  }.execute(null, null, null);
}

Întrucât procesul de înregistrare la Google Cloud Messaging implică comunicație prin rețea, este necesar ca acesta să se realizeze asincron, pe un fir de execuție separat, motiv pentru care procesarea a fost realizată în cadrul metodei doInBackground() a unui obiect de tip AsyncTask.

Testarea existenței unei valori corespunzătoare identificatorului de înregistrare în preferințele utilizatorului se face foarte ușor, acesta având o structură de tip asociere între o cheie și o valoare. 

public static String getRegistrationIdFromSharedPreferences(Context context) {
  final SharedPreferences sharedPreferences = getSharedPreferences(context);
  String registrationId = sharedPreferences.getString(Constants.REGISTRATION_ID_PROPERTY, "");
  if (registrationId.isEmpty()) {
    Log.i(Constants.TAG, Constants.REGISTRATION_ID_ERROR_MESSAGE);
    return Constants.EMPTY_STRING;
  }
  // check whether the application was updated 
  // if it is the case, the registration ID previously supplied must be cleared
  // as it is not guaranteed to work with the current version
  int registeredApplicationVersion = sharedPreferences.getInt(Constants.APPLICATION_VERSION_PROPERTY, Integer.MIN_VALUE);
  int currentVersion = getApplicationVersion(context);
  if (registeredApplicationVersion != currentVersion) {
    Log.i(Constants.TAG, Constants.APPLICATION_VERSION_ERROR_MESSAGE);
    return Constants.EMPTY_STRING;
  }
  return registrationId;
}

De remarcat este faptul că în preferințele utilizatorului va fi stocată și versiunea aplicației Android pentru care a fost generat identificatorul de înregistrare, iar în situația în care aceasta este actualizată, se va realiza o nouă înregistrare la serverul Google Cloud Messaging, de vreme ce o astfel de valoare identifică în mod unic o aplicație caracterizată prin denumirea pachetului și versiunea acesteia.

3. transmiterea identificatorului de înregistrare către serverul de aplicații printr-o cerere HTTP de tip POST care va conține și alte informații prin care să poată fi referit utilizatorul respectiv (de exemplu, numele de utilizator sau adresa de poștă electronică): 

protected class SendRegistrationIdButtonClickListener implements Button.OnClickListener {
 
  @Override
  public void onClick(View view) {
    new AsyncTask<Object, Integer, Integer>() {
      @Override
      protected Integer doInBackground(Object... params) {
 
        try {
          HttpClient httpClient = new DefaultHttpClient();        
 
          HttpPost httpPost = new HttpPost(Constants.DEVICE_REGISTRATION_SERVICE_ADDRESS);
 
          // send the user name, email and registration ID as fields of the HTTP body to the application server
          List<NameValuePair> requestParameters = new ArrayList<NameValuePair>();
          requestParameters.add(new BasicNameValuePair(Constants.USERNAME, usernameEditText.getText().toString()));
          requestParameters.add(new BasicNameValuePair(Constants.EMAIL, emailEditText.getText().toString()));
          requestParameters.add(new BasicNameValuePair(Constants.REGISTRATION_ID, registrationIdTextView.getText().toString()));
 
          UrlEncodedFormEntity urlEncodedFormEntity = new UrlEncodedFormEntity(requestParameters, HTTP.UTF_8);
          httpPost.setEntity(urlEncodedFormEntity);
 
          HttpResponse httpPostResponse = httpClient.execute(httpPost); 
 
          // transmission of information to the application server was successful
          if (httpPostResponse.getStatusLine().getStatusCode() == 200) {
            return Constants.SUCCESS;
          }
	} catch (IOException ioException) {
          Log.e(Constants.TAG, "An exception has occurred: " + ioException.getMessage());
          if (Constants.DEBUG) {
            ioException.printStackTrace();
          }
        }
	// transmission of information to the application server was not successful
	return Constants.FAILURE;
      }
 
      @Override
      protected void onPostExecute(Integer result) {
        switch(result.intValue()) {
          case Constants.SUCCESS:
            // store the registration ID into the SharedPreferences
            // the ID is registered with the application server
            Utilities.setInformationIntoSharedPreferences(getActivity(), registrationIdTextView.getText().toString(), Constants.SUCCESS);
 
            // replace the existing fragment in order to forbid the user to register its ID to the registration server
            RegisteredFragment registeredFragment = new RegisteredFragment();
            FragmentManager fragmentManager = getActivity().getFragmentManager();
            FragmentTransaction fragmentTransaction = fragmentManager.beginTransaction();
            fragmentTransaction.replace(R.id.container, registeredFragment);
            fragmentTransaction.commit();
            Log.i(Constants.TAG, Constants.REGISTRATION_PROCESS_SUCCESS);
            break;
 
          case Constants.FAILURE:
            Log.i(Constants.TAG, Constants.REGISTRATION_PROCESS_FAILURE);
            break;
	}
      }
    }.execute(null, null, null);
  }
}

În cadrul serverului de aplicații va trebui procesată o astfel de cerere prin stocarea informațiilor transmise în cadrul unei baze de date și transmiterea unui răspuns corespunzător prin care se indică rezultatul operației, pentru a fi marcat și la nivelul clientului (în preferințele utilizatorului).

Transmiterea identificatorului de înregistrare către serverul de aplicații se realizează o singură dată, astfel încât să nu se înregistreze duplicate în baza de date.

Ascultătorul GoogleCloudMessagingBroadcastReceiver

Implementarea unui ascultător pentru mesaje cu difuzare poate fi realizată în două variante:

  1. în cazul în care procesarea mesajului implică operații triviale (ce pot fi realizate într-un interval de timp rezonabil), se poate defini un ascultător BroadcastReceiver, prelucrarea propriu-zisă realizându-se în cadrul metodei onReceive() (ce primește ca parametri contextul și intenția care a apelat-o, cu informațiile din corpul mesajului atașate într-un obiect de tip Bundle), apelată în mod automat în momentul în care mesajul este livrat.
  2. în situația în care procesarea mesajului presupune mai multe operații realizate într-un interval de timp semnificativ, prelucrarea se va realiza în cadrul unui serviciu dedicat (de tip IntentService), ce va rula în fundal, în timp ce se obține accesul la un tip de mutex ce împiedică dispozitivul mobil să intre într-o stare de inactivitate care ar suspenda tratarea evenimentului de livrare a unui mesaj, dacă aceasta nu este încă completată:
    GoogleCloudMessagingBroadcastReceiver.java
    public class GoogleCloudMessagingBroadcastReceiver extends WakefulBroadcastReceiver {
 
  @Override
  public void onReceive(Context context, Intent intent) {
 
    // create a component associated to the service that will handle the intent
    ComponentName component = new ComponentName(
      context.getPackageName(),
      GoogleCloudMessagingIntentService.class.getName()
    );
 
    // start the service
    // maintain the mobile device awake
    startWakefulService(context, (intent.setComponent(component)));
    setResultCode(Activity.RESULT_OK);
  }
}

Așa cum se poate observa, a fost utilizat un ascultător de tip WakefulBroadcastReceiver, delegarea procesării mesajului către serviciul dedicat făcându-se prin metoda startWakefulService ce asigură și obținerea accesului la mutexul care împiedică intrarea dispozitivului mobil într-o stare de inactivitate.

Serviciul GoogleCloudMessagingIntentService

În cadrul serviciului pentru tratarea evenimentului (de tip IntentService) are loc procesarea propriu-zisă a mesajului, aceasta fiind realizată în cadrul metodei onHandleIntent() care primește ca parametru aceeași intenție care a fost transmisă ascultătorului, și pentru care a fost obținut mutextul care împiedică intrarea dispozitivului mobil într-o stare de inactivitate.

Prelucrarea unui mesaj se face în funcție de tipul acestuia, furnizat de metoda getMessageType() a obiectului de tip GoogleCloudMessaging, pe baza informațiilor din intenție. Odată cunoscut tipul mesajului și datele asociate prin Bundle, utilizatorul poate realiza orice acțiune, de la transmiterea unei notificări la modificarea conținutului unor controale grafice din cadrul activității.

Ulterior analizei mesajului, trebuie să se asigure și eliberarea mutexului ce împiedică intrarea dispozitivului mobil într-o stare de inactivitate, prin apelul metodei completeWakefulIntent() căreia i se transmite ca parametru aceeași intenție pentru care a fost obținută această resursă.

GoogleCloudMessagingIntentService.java
public class GoogleCloudMessagingIntentService extends IntentService {
 
  public GoogleCloudMessagingIntentService() {
    super(Constants.TAG);
  }
 
  @Override
  protected void onHandleIntent(Intent intent) {
    // the intent is supplied via the BroadcastReceiver
 
    GoogleCloudMessaging googleCloudMessaging = GoogleCloudMessaging.getInstance(this);
 
    String messageType = googleCloudMessaging.getMessageType(intent);
 
    Bundle extras = intent.getExtras();
    if (!extras.isEmpty()) {
      // filter the message according to its type
      if (GoogleCloudMessaging.MESSAGE_TYPE_SEND_ERROR.equals(messageType)) {
        sendNotification(extras);
      } else if (GoogleCloudMessaging.MESSAGE_TYPE_DELETED.equals(messageType)) {
        sendNotification(extras);
      } else if (GoogleCloudMessaging.MESSAGE_TYPE_MESSAGE.equals(messageType)) {
        sendNotification(extras);
      }
    }
 
    // release the wake lock provided by the WakefulBroadcastReceiver.
    GoogleCloudMessagingBroadcastReceiver.completeWakefulIntent(intent);
  }
 
  // create a notification containing the message and post it
  private void sendNotification(Bundle bundle) {
    Intent notificationHandlerIntent = new Intent(this, NotificationHandlerActivity.class);
    notificationHandlerIntent.putExtras(bundle);
 
    TaskStackBuilder taskStackBuilder = TaskStackBuilder.create(this);
    taskStackBuilder.addParentStack(NotificationHandlerActivity.class);
    taskStackBuilder.addNextIntent(notificationHandlerIntent);
 
    PendingIntent notificationHandlerPendingIntent = taskStackBuilder.getPendingIntent(
      0,
      PendingIntent.FLAG_UPDATE_CURRENT);
 
    NotificationCompat.Builder builder = new NotificationCompat.Builder(this)
      .setSmallIcon(R.drawable.ic_launcher)
      .setContentTitle(Constants.TAG)
      .setStyle(new NotificationCompat.BigTextStyle().bigText(Constants.NOTIFICATION_MESSAGE))
      .setContentText(Constants.NOTIFICATION_MESSAGE);
 
    builder.setContentIntent(notificationHandlerPendingIntent);
 
    NotificationManager notificationManager = (NotificationManager)this.getSystemService(Context.NOTIFICATION_SERVICE);
    notificationManager.notify(Constants.NOTIFICATION_ID, builder.build());
  }
}

Permisiuni AndroidManifest.xml

Pentru a se asigura faptul că aplicația Android va rula corespunzător, ținând cont de faptul că Google Cloud Messaging nu poate fi folosit pe dispozitive mobile rulând un sistem de operare Android anterior versiunii 2.3, proprietatea android:minSdkVersion va avea o valoare egală sau mai mare cu 8.

Este necesar ca acest tip de permisiune să utilizeze această sintaxă, în caz contrar mesajele nefiind transmise aplicației Android.

Proprietatea category a ascultătorului trebuie să aibă ca valoare denumirea pachetului aplicației Android.

În cazul în care este asociat și un serviciu (șablon de proiectare frecvent utilizat, însă nu obligatoriu), ascultătorul va fi un obiect de tipul WakefulBroadcastReceiver, creând un mutex parțial pentru a se asigura faptul că dispozitivul mobil rulează.

În situația în care nu se dorește să se utilizeze un serviciu, procesarea mesajului poate fi realizată în ascultător (în acest caz, un obiect de tipul BroadcastReceiver).

Reguli Proguard

Se precizează regulile pentru obfuscatorul Proguard (în fișierul proguard-project.txt din rădăcina proiectului), astfel încât acesta să nu elimine clasele necesare:

-keep class * extends java.util.ListResourceBundle {
  protected Object[][] getContents();
}
 
-keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
  public static final *** NULL;
}
 
-keepnames @com.google.android.gms.common.annotation.KeepName class *
-keepclassmembernames class * {
  @com.google.android.gms.common.annotation.KeepName *;
}
 
-keepnames class * implements android.os.Parcelable {
  public static final ** CREATOR;
}

Proiectarea și dezvoltarea serverului (opțional)

Arhitectura Google Cloud Messaging implică existența a două servere:

1. un server de conexiune furnizat de serviciul Google Cloud Messaging, prin intermediul căruia pot fi livrate mesaje către un client Android, transmise anterior de la un server de aplicații; la rândul său, acesta este disponibil în două variante:

În alegerea uneia dintre cele două variante ale serverului de conexiune, trebuie să se țină cont de funcționalitățile puse la dispoziție de acestea:

FUNCȚIONALITATE HTTP CCS/XMPP
sens conexiune server GCM → client Android (unidirecțional) server GCM ↔ client Android (bidirecțional)
tip comunicație sincron
expeditorul se conectează la destinatar printr-o conexine HTTP nepersistentă, transmite o cerere POST și se blochează în așteptarea unui răspuns 		asincron
expeditorul se conectează la destinatar printr-o conexiune XMPP persistentă, putând trimite/primi mesaje la viteză maximă (rezultatul fiind transmis sub forma unor notificări codificate utilizând același protocol)
corp mesaj text sau JSON transmise prin intermediul unei cereri HTTP POST JSON încapsulat într-un mesaj XMPP
destinatar multiplu NU (pentru mesaje text)
DA (pentru mesaje JSON) 		NU
înregistrare anterioară NU DA

Cele două soluții pentru serverul de conexiune la serviciul Google Cloud Messaging pot fi utilizate concomitent, în funcție de specificațiile aplicației respective.

2. un server de aplicații, implementat de programator, pentru a transmite mesaje către serverul de conexiune Google Cloud Messaging ce vor fi livrate ulterior clientului Android (atunci când acesta devine disponibil); acesta trebuie să îndeplinească mai multe condiții:

În continuare, va fi prezentată structura unui mesaj folosind un server de conexiune HTTP.

Structura unui mesaj

Mesajele interschimbate între serverul de aplicații și serverul de conexiune Google Cloud Messaging de tip HTTP pot fi:

Cerere: server de aplicații → server de conexiune GCM

Un mesaj transmis de serverul de aplicații către serverul de conexiune Google Cloud Messaging de tip HTTP este o cerere de tip POST ce conține informațiile ce trebuie livrate către unul sau mai multe dispozitive mobile (în momentul în care acestea vor deveni disponibile). 

// the address of the Google Cloud Messaging HTTP connection server 
// to which the application server sends a POST request in order to be further transmitted to the mobile device
 
final public static String GCM_SERVER_ADDRESS = "https://android.googleapis.com/gcm/send";
 
// ...
 
HttpPost httpRequest = new HttpPost(GCM_SERVER_ADDRESS);

Un astfel de mesaj va trebui să conțină:

Antet

În cadrul antetului cererii de tip POST trebuie să fie incluse câmpurile:

În situația în care nu este inclus câmpul Content-Type, se așteaptă ca mesajul să aibă un corp de tip text. 

/**
 * HTTP headers
 * 
 * Authorization: key=API key provided from Google Developer Console
 * Content-Type: the format of the HTTP body (may be omitted for plain text)
 *   - application/x-www-form-urlencoded;charset=UTF-8 for plain text
 *   - application/json for JSON
 *
 */
httpRequest.setHeader("Authorization", "key=" + Constants.API_KEY);
httpRequest.setHeader("Content-Type", "application/json");
Corp

Informațiile conținute de corpul unei cereri de tip POST au forma unor perechi (cheie, valoare), fiind definită o serie de parametrii standard, în funcție de formatul în care este transmis mesajul.

PARAMETRU DESCRIERE text JSON obligativitate
registration_id un identificator de înregistrare descriind dispozitivul mobil către care se dorește să se livreze mesajul respectiv ✔ ✘ ✔
registration_ids o listă conținând 1-1000 identificatori de înregistrare indicând dispozitivele mobile către care se dorește să se livreze mesajul respectiv ✘ ✔ ✔
notification_key șir de caractere asociat mai multor dispozitive mobile (1-10) ce aparțin aceluiași utilizator ✔
collapse_key șir de caractere (aleator, definit de utilizator) folosit pentru a identifica mesajele de același tip, astfel încât, pe serverul Google Cloud Messaging să se stocheze doar cea mai recentă valoare asociată, în scopul optimizării traficului de mesaje către dispozitivul mobil (dacă acesta nu este disponibil la un moment dat și au fost transmise mai multe mesaje, va fi stocat doar cel mai recent); se permite stocarea a maximum 4 chei de acest tip pe serverul Google Cloud Messaging ✔ ✔
data obiect JSON format din perechi (atribut, valoare) reprezentând conținutul propriu-zis al mesajului, acestea fiind incluse în cadrul intenției sub forma unui obiect Bundle (ca extras), având aceeași structură;
atributul poate avea orice valoare, cu excepția unor cuvinte rezervate (from, google.*), evitându-se pe cât posibil folosirea denumirilor de parametri, întrucât aceștia vor fi suprascriși;
pentru valoare poate fi utilizat orice tip de obiect JSON, însă la nivelul serverului Google Cloud Messaging se face conversia la șiruri de caractere;

dimensiunea obiectului este limitată la 4kb;
nu există limitări în privința numărului de perechi (atribut, valoare); 		✔ data.<atribut> ✔
delay_while_idle indică faptul că mesajul nu trebuie transmis imediat dacă dispozitivul se află într-o stare de inactivitate, urmând a fi livrat în momentul în care acesta devine activ; valoarea implicită este false ✔ ✔
time_to_live durata de stocare a mesajului pe serverul Google Cloud Messaging (exprimată în secunde) în situația în care dispozitivul mobil nu este disponibil; valoarea implicită este de 4 săptămâni ✔ ✔
restricted_package_name șir de caractere referind denumirea pachetului corespunzător unei aplicații Android, astfel încât mesajul să fie livrat doar acelor identificatori de înregistrare care au fost generați pentru acesta ✔ ✔
dry_run utilizat în scop de testare, pentru a verifica funcționalitatea cererii de tip POST fără a transmite propriu-zis un mesaj către dispozitivul mobil; valoarea implicită este false ✔ ✔

Locația (dispozitivul mobil) către care va fi livrat un mesaj trebuie să fie specificată fie prin parametrul registration_id / registration_ids, fie prin parametrul notification_key.

Pentru mesajele de tip text, se va defini câte un parametru data.<atribut> pentru fiecare informație, asociindu-i-se valoarea respectivă. În această situație, se mențin restricțiile din cazul mesajelor de tip JSON. 

/**
 * HTTP body
 * 
 * -> registration_id/registration_ids indicates the recipient/recipients
 * (for each mobile device to which the message is to be transmitted the message must specify
 * the id provided by the GCM server during the registration process)
 *
 * -> data contains the payload to be transmitted; the developer may define its own keys
 * 
 * -> other fields: collapse_key, delay_while_idle, time_to_live, restricted_package_name, dry_run
 * 
 * The complete list of the message parameters can be found out at: 
 * http://developer.android.com/google/gcm/server.html#params
 */
 
JSONObject requestBody = new JSONObject();
JSONArray registrationIds = new JSONArray();
registrationIds.add(registrationId);
requestBody.put(Constants.REGISTRATION_IDS, registrationIds);
JSONObject payload = new JSONObject();
payload.put(Constants.MESSAGE, message);
requestBody.put(Constants.DATA, payload);

O astfel de cerere va avea forma: 

Authorization:key=...
Content-Type:application/json
{
 "registration_ids": ["..."],
 "data": {
   "message": "..."
 }
}

Ulterior construirii cererii, aceasta va trebui transmisă, operația fiind realizată sincron, producând blocarea metodei în așteptarea răspunsului de la server: 

CloseableHttpClient httpClient = HttpClients.custom().setSSLHostnameVerifier(new NoopHostnameVerifier()).build();
 
// ...
 
httpRequest.setEntity(new StringEntity(JSONValue.toJSONString(requestBody)));
 
// send the request
HttpResponse httpResponse = httpClient.execute(httpRequest);

În situația în care comunicația dintre serverul de aplicații și serverul Google Cloud Messaging nu poate fi realizată, ar trebui investigată posibilitatea blocării porturilor pe care se realizează transmisia de mesaje (de obicei 5228, dar și 5529, respectiv 5530).

Răspuns: server de conexiune GCM → server de aplicații

Răspunsul transmis de serverul de conexiune la Google Cloud Messaging către serverul de aplicații conține rezultatul operației solicitate, acesta putând fi investigat prin intermediul codului de stare: 

int responseCode = httpResponse.getStatusLine().getStatusCode();

Aceasta poate avea valorile:

Mesaj procesat cu succes

În situația în care mesajul a fost procesat cu succes, codul de stare returnat este 200, iar corpul răspunsului conține informații suplimentare, reprezentate sub forma unor perechi de tip (atribut, valoare) în care există un set de parametri predefiniți.

text

Există două variante de răspunsuri:

  1. mesaj care a fost procesat cu succes 
    1: id=identificatorul mesajului care a fost transmis
2(opțional): registration_id=identificator de înregistrare canonic al dispozitivului mobil stocat pe serverul Google Cloud Messaging
  2. mesaj care nu a fost procesat cu succes 
    1: Error=cod de eroare furnizat de serverul Google Cloud Messaging

Algoritmul de procesare a unui răspuns este următorul: 

if (firstLine.startsWith("id")) {
  if (secondLine.equals("registration_id")) {
    old_registration_id = get registration_id from the request field
    replace old_registration_id with new registration_id in the request / application server database
  }
} else {
  switch(Error) {
    case "NotRegistered":
      // the application was uninstalled from the device
      // or it does not have a broadcast receiver in order to process com.google.android.c2dm.intent.RECEIVE intents
      remove the registration ID from the application server database
      break;
    default:
      // non-recoverable error regarding the registration ID
      remove the registration ID from the application server database
      break;
  }
}

JSON

PARAMETRU DESCRIERE
multicast_id identificator unic ce reprezintă un mesaj transmis către mai multe dispozitive mobile
success numărul de mesaje care au fost procesate cu succes
failure numărul de mesaje care nu au fost procesate cu succes
canonical_ids număr de rezultate care conțin un identificator de înregistrare canonic
results listă de obiecte conținând starea mesajelor procesate, în ordinea în care au fost incluse în cadrul solicitării (pe baza identificatorului de înregistrare):
♦ message_id: șir de caractere reprezentând mesajul respectiv, în situația în care a fost procesat cu succes
♦ registration_id: în situația în care este inclus, specifică faptul că mesajul a fost procesat, dar serverul Google Cloud Messaging deține un alt identificator de înregistrare canonic pentru dispozitivul mobil, astfel încât solicitările ulterioare ar trebui să îl utilizeze pentru a nu fi respinse; nu este inclus dacă s-a produs o eroare
♦ error: șir de caractere indicând eroarea ce s-a produs în timpul procesării mesajului; valoarea Unavailable indică faptul că serverul Google Cloud Messaging nu era disponibil la momentul transmiterii solicitării, astfel încât aceasta trebuie retransmisă

Algoritmul de procesare a unui răspuns este următorul: 

if (failure != 0 && canonical_ids != 0) {
  for-each (result ∈ results) {
    if (result.registration_id) {
      // the old registration ID is not included within the response
      old_registration_id = get registration_id from the request field registration_ids, having the same index
            
      replace old_registration_id with new result.registration_id in the request
    } else {
      switch(error) {
        case "Unavailable":
          retry sending the request
          break;
        case "NotRegistered":
          // the application was uninstalled from the device
          // or it does not have a broadcast receiver in order to process com.google.android.c2dm.intent.RECEIVE intents
          remove the registration ID from the application server database
          break;
        default:
          // non-recoverable error regarding the registration ID
          remove the registration ID from the application server database
          break;
      }
    }
  }
}
Mesaj respins de serverul Google Cloud Messaging

În situația în care mesajul a fost respins de serverul Google Cloud Messaging, pot fi returnate mai multe coduri de stare:

COD DE STARE DESCRIERE
400 (doar pentru mesaje JSON) eroare ce indică faptul că mesajul nu a putut fi parsat ca JSON sau conține câmpuri invalide (fie atribute - denumire, fie valoare), detalii suplimentare fiind incluse în corpul mesajului pentru a remedia problema înainte de retransmisie
401 eroare privind procesul de autentificare a serverului de aplicații în cadrul serverului Google Cloud Messaging
5xx eroare în cadrul serverului Google Cloud Messaging (în timpul procesării mesajului) sau indisponibilitate temporară a acestuia; mesajul trebuie transmis potrivit informațiilor furnizate de antetul Retry-After

Cele mai frecvente tipuri de erori sunt:

Tratarea cererilor de înregistrare

Un server de aplicații trebuie să trateze și mesajele provenite de la clientul Android (cereri de înregistrare), stocând informațiile referitoare la identificatorii de înregistrare în baza de date locală, pentru a fi utilizate ulterior, când se dorește precizarea unei locații către care să fie livrat un mesaj.

Comunicația dintre clientul Android și serverul de aplicații poate folosi un protocol de comunicație definit de utilizator, folosind propriile reguli pentru definirea mesajelor schimbate între aceste entități. 

@Override
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
  Enumeration<String> parameters = request.getParameterNames();
 
  String registrationId = null;
  String username = null;
  String email = null;
 
  while (parameters.hasMoreElements()) {
    String parameter = (String)parameters.nextElement();
    if (parameter.equals(Constants.REGISTRATION_ID)) {
      registrationId = request.getParameter(parameter);
     }
     if (parameter.equals(Constants.USERNAME)) {
       username = request.getParameter(parameter);
     }
     if (parameter.equals(Constants.EMAIL)) {
       email = request.getParameter(parameter);
     }
   }
 
   if (registrationId != null && !registrationId.isEmpty() &&
       username != null && !username.isEmpty() &&
       email != null && !email.isEmpty()) {
     ArrayList<String> columnNames = new ArrayList<String>();
     columnNames.add(Constants.REGISTRATION_ID);
     columnNames.add(Constants.USERNAME);
     columnNames.add(Constants.EMAIL);
     ArrayList<String> values = new ArrayList<String>();
     values.add(registrationId);
     values.add(username);
     values.add(email);
 
     try {
       dataBaseWrapper.insertValuesIntoTable(Constants.TABLE_NAME, columnNames, values, false);
     } catch (SQLException | DataBaseException exception) {
       System.out.println("An exception has occurred: "+exception.getMessage());
       if (Constants.DEBUG) {
         exception.printStackTrace();
       }
     } 
     response.setStatus(HttpServletResponse.SC_OK); 
   } else {
     response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
   }
}

Se observă faptul că se prelucrează cererea de tip POST, iterându-se pe toți parametrii incluși în scopul identificării valorilor asociate atributelor denumite nume de utilizator, adresă de poștă electronică și identificator de înregistrare (conform protocolului de comunicație definit de utilizator), aceștia fiind stocați în baza de date locală pentru a fi utilizați în transmiterea ulterioară a unui mesaj.

Este foarte important să fie specificată o stare în cadrul răspunsului (prin apelul metodei setStatus() a obiectului HttpServletResponse) desemnând rezultatul procesării mesajului, în caz contrar clientul Android blocându-se până la expirarea perioadei de timp pentru așteptare (eng. timeout).

Activitate de Laborator

1. Să se acceseze Google Developer's Console, după ce a fost realizată autentificarea cu datele contului Google (nume de utilizator, parolă):

Mai multe detalii pot fi obținute în secțiunea Configurare.

În cazul în care nu dispuneți de un cont Google, acesta va trebui creat înainte de a implementa aceste cerințe.

Aceste valori nu vor fi utilizate decât împreună, altfel se vor genera erori de tipul MismatchSenderId.

Clientul Android

2. În contul Github personal, să se creeze un depozit denumit 'Laborator08-Client'. Inițial, acesta trebuie să fie gol (nu trebuie să bifați nici adăugarea unui fișier README.md, nici a fișierului .gitignore sau a a fișierului LICENSE).

3. Să se cloneze în directorul de pe discul local conținutul depozitului la distanță de la https://www.github.com/pdsd2015/Laborator08-Client.

În urma acestei operații, directorul Laborator08-Client va trebui să se conțină directoarele labtasks și solutions. 

student@pdsd2015:~$ git clone https://www.github.com/pdsd2015/Laborator08-Client

4. Să se încarce conținutul descărcat în cadrul depozitului 'Laborator08-Client' de pe contul Github personal. 

student@pdsd2015:~$ cd Laborator08-Client
student@pdsd2015:~/Laborator08-Client$ git remote add Laborator08-Client_perfectstudent https://github.com/perfectstudent/Laborator08-Client
student@pdsd2015:~/Laborator08-Client$ git push Laborator08-Client_perfectstudent master

5. Să se importe în mediul integrat de dezvoltare Eclipse Luna SR1a (4.4.1) proiectele google-play-service_lib și GoogleCloudMessagingClient din directorul labtasks (în această ordine).

Să se configureaze mașina pe care va rula aplicația:

În situația în care nu se reușește configurarea unui dispozitiv virtual, se poate folosi o imagine Nexus S (API 16) care trebuie plasată în directorul $HOME.

Mai multe detalii pot fi obținute în secțiunea Configurare client

6. În interfața ro.pub.cs.systems.pdsd.lab08.googlecloudmessaging.general.Constants, trebuie modificate următoarele valori, numai în situația în care se folosește un server web Apache Tomcat:

Portul pe care rulează serverul web Apache Tomcat este de regulă 8080 (dacă nu s-au realizat alte modificări în fișierul de configurare server.xml). În situația în care, în momentul în care se încearcă să se realizeze conexiunea la serverul de aplicații, se obține o excepție de tip Timeout / Connection Refused, investigați dacă este permisă comunicația pe portul respectiv.

7. Să se ruleze aplicația Android și să se genereze identificatorul de înregistrare, care va fi transmis către serverul de aplicații prin accesarea butonului Send Registration ID.

În fragmentul UnregisteredFragment din pachetul ro.pub.cs.systems.pdsd.lab08.googlecloudmessaging.view, pe clasa ascultător asociată butonului, să se transmită o cerere HTTP de tip POST către componenta din serverul de aplicații, responsbilă cu înregistrarea dispozitivelor mobile (disponibilă la Constants.DEVICE_REGISTRATION_SERVICE_ADDRESS).

Aceasta va conține următorii parametrii:

Codificarea utilizată pentru această comunicație este UTF-8.

În situația în care codul întors pe linia de stare în răspuns este 200, se va întoarce rezultatul Constants.SUCCESS.

8. În situația în care înregistrarea a fost realizată cu succes, interfața grafică a aplicației este modificată în sensul în care se dorește afișarea unei liste cu utilizatorii care au fost înregistrați deja, către care se dorește transmiterea unui mesaj de notificare.

a) Pe firul de execuție RegisteredDevicesFetcher din fragmentul RegisteredFragment, să se transmită o cerere HTTP de tip GET către către componenta din serverul de aplicații, responsbilă cu furnizarea listei dispozitivelor mobile înregistrate, în format JSON (disponibilă la Constants.REGISTERED_DEVICES_SERVICE_ADDRESS).

Să se prelucreze documentul JSON obținut, astfel încât prin intermediul acestuia să se populeze un tablou de obiecte RegisteredDevice, transmis ca parametru adaptorului obiectului de tip Spinner în care pot fi vizualizate astfel de informații. 

final ArrayList<RegisteredDevice> registeredDevices = new ArrayList<RegisteredDevice>();
// ...
registeredDevicesSpinner.post(new Runnable() {
  @Override
  public void run() {
    RegisteredDevicesAdapter registeredDevicesAdapter = new RegisteredDevicesAdapter(getActivity(), registeredDevices);
    registeredDevicesSpinner.setAdapter(registeredDevicesAdapter);
  }
});

Documentul JSON conține informații despre identificatorul din baza de date, identificatorul de înregistrare furnizat de serverul GoogleCloudMessaging, numele de utilizator, adresa de poștă electronică și momentul de timp la care a fost realizată înregistratrea. 

[
  {
    "id": ...,
    "registration_id": "...",
    "username": "...",
    "email": "...",
    "timestamp": "...",
  },
  ...
]
atribut JSON tip de date detaliu
Constants.ID int identificator în baza de date
Constants.REGISTRATION_ID String identificator de înregistrare furnizat de serverul Google Cloud Messaging
Constants.USERNAME String numele de utilizator
Constants.EMAIL String adresa de poștă electonică
Constants.TIMESTAMP String momentul de timp la care a fost realizată înregistrarea

b) Pe firul de execuție MessagePushExecutor din fragmentul RegisteredFragment, să se transmită o cerere HTTP de tip POST către către componenta din serverul de aplicații, responsbilă cu transmiterea unui mesaj sub forma unei notificări (disponibilă la Constants.MESSAGE_PUSH_SERVICE_ADDRESS).

Aceasta va conține următorii parametrii (instanțiați ca membrii ai clasei):

Codificarea utilizată pentru această comunicație este UTF-8.

În această situație, nu este necesară prelucrarea rezultatului obținut.

9. În momentul în care este transmis un mesaj de către expeditor, să se observe notificarea destinatarului și activitatea în care pot fi vizualizați parametrii pachetului furnizat de serverul Google Cloud Messaging.

10. Să se încarce modificările realizate în cadrul depozitului 'Laborator08-Client' de pe contul Github personal, folosind un mesaj sugestiv. 

student@pdsd2015:~/Laborator08-Client$ git add *
student@pdsd2015:~/Laborator08-Client$ git commit -m "implemented taks for laboratory 08-Client"
student@pdsd2015:~/Laborator08-Client$ git push Laborator08-Client_perfectstudent master

Serverul de Aplicații (Opțional)

Informații referitoare la configurarea serverului de aplicații pot fi obținute la Configurare Server.

Funcționalitatea corespunzătoare serverului de aplicații este disponibilă în două variante:

Pe serverul de aplicații sunt disponibile următoarele funcționalități, în cadrul unor componente diferite:

11. În contul Github personal, să se creeze un depozit denumit 'Laborator08-Server'. Inițial, acesta trebuie să fie gol (nu trebuie să bifați nici adăugarea unui fișier README.md, nici a fișierului .gitignore sau a a fișierului LICENSE).

12. Să se cloneze în directorul de pe discul local conținutul depozitului la distanță de la https://www.github.com/pdsd2015/Laborator08-Server.

În urma acestei operații, directorul Laborator08-Server va trebui să se conțină directoarele PHP și ServletsJSP. 

student@pdsd2015:~$ git clone https://www.github.com/pdsd2015/Laborator08-Server

13. Să se încarce conținutul descărcat în cadrul depozitului 'Laborator08-Server' de pe contul Github personal. 

student@pdsd2015:~$ cd Laborator08-Server
student@pdsd2015:~/Laborator08-Server$ git remote add Laborator08-Server_perfectstudent https://github.com/perfectstudent/Laborator08-Server
student@pdsd2015:~/Laborator08-Server$ git push Laborator08-Server_perfectstudent master

14. Să se descarce cea mai recentă versiune stabilă a mediului de dezvoltare Eclipse IDE for Java EE Developers, integrându-se cu serverul web Apache Tomcat.

15. Să se instaleze motorul pentru gestiunea bazelor de date MySQL și să se ruleze script-ul googlecloudmessaging.sql din cadrul directorului ServletsJSP care creează o bază de date cu o tabelă în care vor fi stocate informațiile referitoare la identificatorii de înregistrare transmiși de clienții Android. 

CREATE DATABASE googlecloudmessaging;

USE googlecloudmessaging;

CREATE TABLE registered_devices (
  id              INT(10) UNSIGNED AUTO_INCREMENT PRIMARY KEY NOT NULL,
  registration_id TEXT NOT NULL,
  username        VARCHAR(255),			
  email           VARCHAR(255),
  timestamp       TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
);

Rularea acestuia se poate realiza folosind una dintre următoarele variante, presupunând că vă aflați în directorul în care se găsește acest fișier: 

  1. student@pdsd2015:~/Laborator08-Server/JSPServlets$ mysql -u root -p <googlecloudmessaging.sql
  2. student@pdsd2015:~/Laborator08-Server/JSPServlets$ mysql -u root -p
Enter password:
    1. mysql> source googlecloudmessaging.sql;

      sau 

    2. mysql> \. googlecloudmessaging.sql;

16. Să se importe proiectul GoogleCloudMessagingServer în mediul de dezvoltare Eclipse IDE for Java EE Developers.

17. În interfața Constants din pachetul ro.pub.cs.systems.pdsd.lab08.googlecloudmessaging.general, trebuie modificate următoarele valori:

18. În acest moment, se poate realiza comunicația client Android ↔ server de aplicații prin intermediul serviciului Google Cloud Messaging:

Resurse Utile

Apache Tomcat 7 Downloads
Eclipse IDE for Java EE Developers
MySQL Downloads

Android Push Notifications using Google Cloud Messaging
Google Cloud Messaging for Android
Google Cloud Messaging API
How to install Google Play Services in a Genymotion VM (with no drag and drop support)?
Installing ARM Translation and GApps
Android Notifications