Eventos OSGi para componentes das comunidades osgi-events-for-communities-components

Visão geral overview

Quando os membros interagem com os recursos do Communities, são enviados eventos OSGi que podem acionar ouvintes assíncronos, como notificações ou gamificação (pontuação e marcação).

A instância SocialEvent de um componente registra os eventos como actions que ocorrem para um topic. O SocialEvent inclui um método para retornar um verb associado à ação. Há uma relação n-1 entre actions e verbs.

Para os componentes das Comunidades entregues na versão, as tabelas a seguir descrevem a verbs definida para cada topic disponível para uso.

Tópicos e verbos topics-and-verbs

Componente de calendário
SocialEvent topic= com/adobe/cq/social/calendar

Verbo
Descrição
POST
O membro cria um evento de calendário
ADICIONAR
Comentários do membro em um evento de calendário
ATUALIZAR
O evento ou comentário do calendário do membro foi editado
EXCLUIR
O evento ou comentário do calendário do membro foi excluído

Componente de comentários
SocialEvent topic= com/adobe/cq/social/comment

Verbo
Descrição
POST
Membro cria um comentário
ADICIONAR
Respostas dos membros aos comentários
ATUALIZAR
Comentário do membro editado
EXCLUIR
O comentário do membro foi excluído

Componente de Biblioteca de Arquivos
SocialEvent topic= com/adobe/cq/social/fileLibrary

Verbo
Descrição
POST
Membro cria uma pasta
ANEXE
O membro carrega um arquivo
ATUALIZAR
Membro atualiza uma pasta ou arquivo
EXCLUIR
O membro exclui uma pasta ou arquivo

Componente do fórum
SocialEvent topic= com/adobe/cq/social/forum

Verbo
Descrição
POST
Membro cria tópico de fórum
ADICIONAR
Respostas dos membros ao tópico do fórum
ATUALIZAR
O tópico ou a resposta do fórum do membro é editado
EXCLUIR
O tópico ou a resposta do fórum do membro é excluído

Componente do diário
SocialEvent topic= com/adobe/cq/social/journal

Verbo
Descrição
POST
Membro cria um artigo de blog
ADICIONAR
Comentários do membro em um artigo do blog
ATUALIZAR
Artigo ou comentário do blog do membro editado
EXCLUIR
O artigo ou comentário do blog do membro foi excluído

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

Verbo
Descrição
POST
O membro cria uma pergunta QnA
ADICIONAR
Membro cria uma resposta QnA
ATUALIZAR
A pergunta ou resposta QnA do membro é editada
SELECIONE
A resposta do membro está selecionada
DESMARCAR
A resposta do membro foi desmarcada
EXCLUIR
A pergunta ou resposta QnA do membro foi excluída

Componente de análises
SocialEvent topic= com/adobe/cq/social/review

Verbo
Descrição
POST
Membro cria revisão
ATUALIZAR
Revisão do membro editada
EXCLUIR
Revisão do membro excluída

Componente de classificação
SocialEvent topic= com/adobe/cq/social/tally

Verbo
Descrição
ADICIONAR CLASSIFICAÇÃO
O conteúdo do membro foi avaliado em alta
REMOVER CLASSIFICAÇÃO
O conteúdo do membro foi classificado como inativo

Componente de votação
SocialEvent topic= com/adobe/cq/social/tally

Verbo
Descrição
ADICIONAR VOTAÇÃO
O conteúdo do membro foi aprovado
REMOVER VOTAÇÃO
O conteúdo do membro foi rejeitado

Componentes habilitados para moderação
SocialEvent topic= com/adobe/cq/social/moderation

Verbo
Descrição
NEGAR
Conteúdo do membro negado
SINALIZAR COMO INADEQUADO
O conteúdo do membro está sinalizado
NÃO SINALIZAR COMO INAPROPRIADO
O conteúdo do membro não está sinalizado
ACCEPT
O conteúdo do membro é aprovado pelo moderador
FECHAR
Membro fecha comentário para edições e respostas
ABRIR
Membro reabre comentário

Eventos para Componentes personalizados events-for-custom-components

Para um componente personalizado, a classe abstrata de SocialEvent deve ser estendida para registrar os eventos do componente como actions que ocorrem para um topic.

O evento personalizado substituiria o método getVerb() para que um verb apropriado fosse retornado para cada action. O verb retornado para uma ação pode ser um usado com frequência (como POST) ou um especializado para o componente (como ADD RATING). Há uma relação n-1 entre actionse verbs.

NOTE
Verifique se uma extensão personalizada está registrada com uma classificação inferior a qualquer implementação existente no produto.

Pseudo-código para evento de componente personalizado 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");
            }
        }
    }

}

Exemplo de EventListener para filtrar dados de fluxo de atividade sample-eventlistener-to-filter-activity-stream-data

É possível ouvir eventos com a finalidade de modificar o que aparece no fluxo de atividade.

A amostra de pseudo-código a seguir removerá os eventos de DELETE para o componente Comentários do fluxo de atividade.

Pseudo-código para EventListener pseudo-code-for-eventlistener

Requer o último pacote de recursos.

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
81e2cd9d-0789-409d-b87c-2a8ce4f28791