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

CAUTION
AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

Présentation overview

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

Un composant SocialEvent l’instance enregistre les événements comme actionsqui se produit pour un topic. SocialEvent comprend une méthode pour renvoyer une verbassociée à l’action. Il existe une n-1 relation entre actionset verbs.

Pour les composants Communities fournis dans la version, les tableaux suivants décrivent la variable verbsdéfinie pour chaque topicdisponibles.

Rubriques et verbes topics-and-verbs

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

Verbe
Description
POST
Un membre crée un événement de calendrier
AJOUTER
commentaires d’un 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 Commentaires
SocialEvent topic= com/adobe/cq/social/comment

Verbe
Description
POST
Un 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
crée un dossier
ATTACH
Le membre charge un fichier
MISE À JOUR
met à jour un dossier ou un fichier
SUPPRIMER
supprime un dossier ou un fichier

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

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

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

Verbe
Description
POST
Un membre crée un article de blog.
AJOUTER
commentaires d'un membre sur un article de blog
MISE À JOUR
article ou commentaire de blog du membre modifié
SUPPRIMER
article ou commentaire de blog du membre supprimé

Composant Q&R
SocialEvent topic = com/adobe/cq/social/qna

Verbe
Description
POST
crée une question Q&R
AJOUTER
crée une réponse Q&R
MISE À JOUR
Q&R du membre : une question ou une réponse est modifiée
SELECT
la réponse du membre est sélectionnée.
UNSELECT
la réponse du membre est désélectionnée.
SUPPRIMER
Q&R du membre : une question ou une réponse est supprimée

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

Verbe
Description
POST
création de la révision par le membre
MISE À JOUR
la révision du membre est modifiée.
SUPPRIMER
la révision du membre est supprimée.

Composant d’évaluation
SocialEvent topic= com/adobe/cq/social/tally

Verbe
Description
AJOUTER UNE NOTE
le contenu du membre a été mis au point
SUPPRESSION DE LA NOTE
le contenu du membre a été abaissé.

Composant 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/modération

Verbe
Description
DENY
le contenu du membre est refusé ;
INDICATEUR INAPPROPRIÉ
le contenu du membre est marqué
INAPPROPRIÉ
le contenu du membre n’est pas marqué
ACCEPT
le contenu du membre est approuvé par le modérateur ;
CLOSE
le membre ferme le commentaire aux modifications et aux réponses
OUVRIR
commentaire de réouverture du membre

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

Pour un composant personnalisé, la variable Classe abstraite SocialEvent doit être étendu d pour enregistrer les événements du composant comme actionsqui se produit pour un topic.

L’événement personnalisé remplace la méthode . getVerb() afin qu’une verbest renvoyé pour chaque action. Le verb renvoyé pour une action peut être une méthode couramment utilisée (telle que POST) ou spécialisé pour le composant (par exemple ADD RATING). Il existe une n-1 relation entre actionset 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 un é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 du 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é.

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

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

Nécessite dernier Feature Pack.

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
5d37d7b0-a330-461b-814d-068612705ff6