Événements OSGi pour les composants de Communities osgi-events-for-communities-components

Vue d’ensemble overview

Lorsque les membres interagissent avec les fonctionnalités de Communities, des événements OSGi sont envoyés pour déclencher des écouteurs asynchrones, tels que des notifications ou des gamification (notation et badge).

L’instance SocialEvent d’un composant enregistre les événements en tant que actions qui se produisent pour un topic. SocialEvent inclut une méthode pour renvoyer un verb associé à l’action. Il existe une relation n-1 entre actions et verbs.

Pour les composants de communautés fournis dans cette version, les tableaux suivants décrivent les verbs définis pour chaque topic disponible.

Sujets et verbes topics-and-verbs

Composant Calendrier
SocialEvent topic= com/adobe/cq/social/calendar

Verbe
Description
POST
Le membre crée un événement de calendrier
AJOUTER
Commentaires de membre sur un événement de calendrier
MISE À JOUR
L’événement ou le commentaire de calendrier du membre est modifié
SUPPRIMER
L’événement ou le commentaire de calendrier du membre est supprimé

Composant Comments
SocialEvent topic= com/adobe/cq/social/comment

Verbe
Description
POST
Le membre crée un commentaire
AJOUTER
Réponses du membre au commentaire
MISE À JOUR
Le commentaire du membre est modifié
SUPPRIMER
Le commentaire du membre est supprimé.

composant Bibliothèque de fichiers
SocialEvent topic= com/adobe/cq/social/fileLibrary

Verbe
Description
POST
Le membre crée un dossier.
JOINDRE
Le membre télécharge un fichier
MISE À JOUR
Le membre met à jour un dossier ou un fichier
SUPPRIMER
Le membre supprime un dossier ou un fichier

Composant Forum
SocialEvent topic= com/adobe/cq/social/forum

Verbe
Description
POST
Le membre crée une rubrique de forum
AJOUTER
Réponses des membres au sujet du forum
MISE À JOUR
Le sujet ou la réponse du forum du membre est modifié
SUPPRIMER
Le sujet du forum du membre ou la réponse est supprimée

Composant ​ Journal
SocialEvent topic= com/adobe/cq/social/journal

Verbe
Description
POST
Le membre crée un article de blog
AJOUTER
Commentaires des membres sur un article de blog
MISE À JOUR
L’article de blog ou le commentaire du membre est modifié
SUPPRIMER
L’article de blog ou le commentaire du membre est supprimé.

Composant QnA
SocialEvent topic = com/adobe/cq/social/qna

Verbe
Description
POST
Le membre crée une question QnA.
AJOUTER
Le membre crée une réponse QnA.
MISE À JOUR
La question ou la réponse QnA du membre est modifiée
SÉLECTIONNER
La réponse du membre est sélectionnée
DÉSÉLECTIONNER
La réponse du membre est désélectionnée
SUPPRIMER
La question ou la réponse QnA du membre est supprimée

Composant Révisions
SocialEvent topic= com/adobe/cq/social/review

Verbe
Description
POST
Le membre crée la révision.
MISE À JOUR
La révision du membre est modifiée
SUPPRIMER
L’évaluation du membre est supprimée

Composant Évaluation
SocialEvent topic= com/adobe/cq/social/tally

Verbe
Description
AJOUTER UNE ÉVALUATION
Le contenu du membre a été amélioré
SUPPRIMER LA NOTE
Le contenu du membre a été rétrogradé

Composante de vote
SocialEvent topic= com/adobe/cq/social/tally

Verbe
Description
AJOUTER UN VOTE
Le contenu du membre a été voté
SUPPRIMER LE VOTE
Le contenu du membre a été rejeté

Composants activés pour la modération
SocialEvent topic= com/adobe/cq/social/modation

Verbe
Description
DENY
Le contenu du membre est refusé
SIGNALER COMME INAPPROPRIÉ
Le contenu du membre est marqué
SIGNALER-COMME-INAPPROPRIÉ
Le contenu du membre n’est pas marqué
ACCEPTER
Le contenu du membre est approuvé par le modérateur
FERMER
Le membre ferme le commentaire aux modifications et aux réponses
OUVRIR
Le membre ouvre à nouveau le commentaire

Événements pour les composants personnalisés events-for-custom-components

Pour un composant personnalisé, la classe abstraite SocialEvent doit être étendue d pour enregistrer les événements du composant tels actions qui se produisent pour un topic.

L’événement personnalisé remplace l’getVerb() de méthode afin qu’un verb approprié soit renvoyé pour chaque action. Les verb renvoyées pour une action peuvent être celles qui sont couramment utilisées (par exemple, POST) ou celles qui sont spécialisées pour le composant (par exemple, ADD RATING). Il existe une relation n-1 entre actions et verbs.

NOTE
Assurez-vous qu’une extension personnalisée est enregistrée avec un classement inférieur à toute implémentation existante dans le produit.

Pseudo-code pour événement de composant personnalisé pseudo-code-for-custom-component-event

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");
            }
        }
    }

}

Exemple d’écouteur d’événement pour filtrer les données de flux d’activités sample-eventlistener-to-filter-activity-stream-data

Il est possible d’écouter les événements dans le but de modifier ce qui apparaît dans le flux d’activités.

L’exemple de pseudo-code suivant supprime du flux d’activités les événements DELETE pour le composant Commentaires .

Pseudo-code pour EventListener pseudo-code-for-eventlistener

Nécessite dernier pack de fonctionnalités.

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[]{"*"};
    }

}
recommendation-more-help
experience-manager-65-help-communities