Componenti OSGi Events for Communities

Panoramica

Quando i membri interagiscono con le funzioni Community, vengono inviati eventi OSGi che possono attivare listener asincroni, come notifiche o gamificazioni (punteggio e contrassegno).

L'istanza di un componente SocialEvent registra gli eventi come actions che si verificano per un topic. SocialEvent include un metodo per restituire un elemento verb associato all'azione. Esiste una relazione n-1 tra actions e verbs.

Per i componenti Community forniti nella release, le tabelle seguenti descrivono la verbs definita per ogni topic disponibile per l'uso.

Argomenti e verbi

Calendar
ComponentSocialEvent topic= com/adobe/cq/social/Calendar

Verbo Descrizione
POST Il membro crea un evento del calendario
AGGIUNGI Commenti dei membri su un evento del calendario
AGGIORNA Evento calendario del membro o commento modificato
ELIMINA L'evento o il commento del calendario del membro viene eliminato

Commenti
ComponentSocialEvent topic= com/adobe/cq/social/comment

Verbo Descrizione
POST Il membro crea un commento
AGGIUNGI Risposte del membro al commento
AGGIORNA Il commento del membro è modificato
ELIMINA Il commento del membro è eliminato

Libreria file
ComponentSocialEvent topic= com/adobe/cq/social/fileLibrary

Verbo Descrizione
POST Il membro crea una cartella
ATTACCO Il membro carica un file
AGGIORNA Il membro aggiorna una cartella o un file
ELIMINA Member elimina una cartella o un file

Forum
ComponentSocialEvent topic= com/adobe/cq/social/forum

Verbo Descrizione
POST Membro crea argomento forum
AGGIUNGI Risposte dei membri all'argomento del forum
AGGIORNA Argomento forum o risposta del membro è modificato
ELIMINA L'argomento o la risposta del forum del membro viene eliminata

Journal
ComponentSocialEvent topic= com/adobe/cq/social/journal

Verbo Descrizione
POST Il membro crea un articolo di blog
AGGIUNGI Commenti su un articolo di blog
AGGIORNA L'articolo o il commento del blog del membro viene modificato
ELIMINA L'articolo o il commento del blog del membro viene eliminato

QnA
ComponentSocialEvent topic = com/adobe/cq/social/qna

Verbo Descrizione
POST Il membro crea una domanda QnA
AGGIUNGI Il membro crea una risposta QnA
AGGIORNA La domanda o la risposta QnA del membro viene modificata
SELECT La risposta del membro è selezionata
ANNULLA La risposta del membro è deselezionata
ELIMINA La domanda o la risposta QnA del membro viene eliminata

Recensioni
ComponentSocialEvent topic= com/adobe/cq/social/review

Verbo Descrizione
POST Il membro crea la revisione
AGGIORNA Revisione del membro
ELIMINA La revisione del membro è soppressa

Valutazione
ComponentSocialEvent topic= com/adobe/cq/social/tally

Verbo Descrizione
AGGIUNGI VALUTAZIONE Il contenuto del membro è stato valutato
RIMUOVI VALUTAZIONE Il contenuto del membro è stato ridotto

Voto
ComponentSocialEvent topic= com/adobe/cq/social/tally

Verbo Descrizione
AGGIUNGI VOTO Il contenuto del membro è stato votato
RIMUOVI VOTO Il contenuto dei membri è stato respinto

Moderation enabled
ComponentsSocialEvent topic= com/adobe/cq/social/moderation

Verbo Descrizione
NEGA Il contenuto del membro è rifiutato
FLAG-AS-INAPPROPRIATE Il contenuto del membro è contrassegnato
INAPPROPRIATO Il contenuto del membro non è contrassegnato
ACCETTARE Il contenuto del membro è approvato dal moderatore
CHIUDI Il membro chiude il commento alle modifiche e alle risposte
APRI Il membro riapre il commento

Eventi per componenti personalizzati

Per un componente personalizzato, è necessario estendere la classe astratta SocialEvent per registrare gli eventi del componente come actionsche si verificano per un topic.

L'evento personalizzato sostituisce il metodo getVerb() in modo che venga restituito un verbappropriato per ogni action. La verb restituita per un'azione può essere utilizzata comunemente (come POST) o una specifica per il componente (come ADD RATING). Esiste una relazione n-1 tra actionse verbs.

NOTA

Verifica che un'estensione personalizzata sia registrata con una classificazione inferiore a qualsiasi implementazione esistente nel prodotto.

Pseudo-Code per evento componente personalizzato

org.osgi.service.event.Event;
com.adobe.cq.social.scf.core.SocialEvent;
com.adobe.granite.activitystreams.ObjectTypes;
com.adobe.granite.activitystreams.Verbs;

package com.mycompany.recipe;

import org.osgi.service.event.Event;
import com.adobe.cq.social.scf.core.SocialEvent;
import com.adobe.granite.activitystreams.ObjectTypes;
import com.adobe.granite.activitystreams.Verbs;

/*
 * The Recipe type, passed to RecipeEvent(), would be a custom Recipe class
 * that extends either
 * com.adobe.cq.social.scf.SocialComponent
 * or
 * com.adobe.cq.social.scf.SocialCollectionComponent
 * See https://docs.adobe.com/docs/en/aem/6-2/develop/communities/scf/server-customize.html
 */

/**
 * Defines events that are triggered on a custom component, "Recipe".
 */
public class RecipeEvent extends SocialEvent<RecipeEvent.RecipeActions> {

    private static final long serialVersionUID = 1L;
    protected static final String PARENT_PATH = "PARENT_PATH";

    /**
     * The event topic suffix for Recipe events
     */
    public static final String RECIPE_TOPIC = "recipe";

    /**
     * @param recipe - the recipe resource on which the event was triggered
     * @param userId - the user id of the user who triggered the action
     * @param action - the recipe action that triggered this event
     */
    public RecipeEvent(final Recipe recipe, final String userId, final RecipeEvent.RecipeActions action) {
        String recipePath = recipe.getResource().getPath();
        String parentPath = (recipe.getParentComponent() != null) ?
                             recipe.getParentComponent().getResource().getPath() :
                             recipe.getSourceComponentId();
        this(recipePath, userId, parentPath, action);
    }

    /**
     * @param recipePath - the path to the recipe resource (jcr node) on which the event was triggered
     * @param userId - the user id of the user who triggered the action
     * @param parentPath - the path to the parent node of the recipe resource
     * @param action - the recipe action that triggered this event
     */
    public RecipeEvent(final String recipePath, final String userId, final String parentPath) {
        super(RECIPE_TOPIC, recipePath, userId, action,
              new BaseEventObject(recipePath, ObjectTypes.ARTICLE),
              new BaseEventObject(parentPath, ObjectTypes.COLLECTION),
              new HashMap<String, Object>(1) {
            private static final long serialVersionUID = 1L;
            {
                if (parentPath != null) {
                    this.put(PARENT_PATH, parentPath);
                }

            }
        });
    }

    private RecipeEvent (final Event event) {
      super(event);
    }

    /**
     * List of available recipe actions that can trigger a recipe event.
     */
    public static enum RecipeActions implements SocialEvent.SocialActions {
        RecipeAdded,
        RecipeModified,
        RecipeDeleted;

        @Override
        public String getVerb() {
            switch (this) {
                case RecipeAdded:
                    return Verbs.POST;
                case RecipeModified:
                    return Verbs.UPDATE;
                case RecipeDeleted:
                    return Verbs.DELETE;
                default:
                    throw new IllegalArgumentException("Unsupported action");
            }
        }
    }

}

Esempio di EventListener per filtrare i dati del flusso di attività

È possibile ascoltare gli eventi allo scopo di modificare ciò che appare nel flusso di attività.

Il seguente esempio di pseudo-codice rimuove gli eventi DELETE per il componente Commenti dal flusso di attività.

Pseudo-codice per EventListener

Richiede l'ultimo pacchetto di funzioni.

package my.company.comments;

import java.util.Collections;
import java.util.Map;

import org.apache.commons.lang.StringUtils;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Modified;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.osgi.PropertiesUtil;
import org.osgi.service.component.ComponentContext;

import com.adobe.cq.social.activitystreams.listener.api.ActivityStreamProviderExtension;
import com.adobe.cq.social.commons.events.CommentEvent.CommentActions;
import com.adobe.cq.social.scf.core.SocialEvent;

@Service
@Component(metatype = true, label = "My Comment Delete Event Filter",
        description = "Prevents comment DELETE events from showing up in activity streams")
public class CommentDeleteEventActivityFilter implements ActivityStreamProviderExtension {

    @Property(name = "ranking", intValue = 10)
    protected int ranking;

    @Activate
    public void activate(final ComponentContext ctx) {
        ranking = PropertiesUtil.toInteger(ctx.getProperties().get("ranking"), 10);
    }

    @Modified
    public void update(final Map<String, Object> props) {
        ranking = PropertiesUtil.toInteger(props.get("ranking"), 10);
    }

    @Override
    public boolean evaluate(final SocialEvent<?> evt, final Resource resource) {
        if (evt.getAction() != null && evt.getAction() instanceof SocialEvent.SocialActions) {
            final SocialEvent.SocialActions action = evt.getAction();
            if (StringUtils.equals(action.getVerb(), CommentActions.DELETED.getVerb())) {
                return false;
            }
        }
        return true;
    }

    @Override
    public Map<String, ? extends Object> getActivityProperties(final SocialEvent<?> arg0, final Resource arg1) {
        return Collections.<String, Object>emptyMap();
    }

    @Override
    public Map<String, ? extends Object> getActorProperties(final SocialEvent<?> arg0, final Resource arg1) {
        return Collections.<String, Object>emptyMap();
    }

    @Override
    public String getName() {
        return "My Comment Delete Event Filter";
    }

    @Override
    public Map<String, ? extends Object> getObjectProperties(final SocialEvent<?> arg0, final Resource arg1) {
        return Collections.<String, Object>emptyMap();
    }

    /* Ensure a custom extension is registered with a ranking lower than any existing implementation in the product. */
    @Override
    public int getRanking() {
        return this.ranking;
    }

    @Override
    public Map<String, ? extends Object> getTargetProperties(final SocialEvent<?> arg0, final Resource arg1) {
        return Collections.<String, Object>emptyMap();
    }

    @Override
    public String[] getStreamProviderPid() {
        return new String[]{"*"};
    }

}

In questa pagina