コミュニティコンポーネントの OSGi イベント osgi-events-for-communities-components

概要 overview

メンバーが Communities の機能を操作すると、通知やゲーミフィケーション(スコアおよびバッジ)などの非同期リスナーをトリガーにできる OSGi イベントが送信されます。

コンポーネント SocialEvent インスタンスは、イベントを次のように記録 actions ~に起こる topic. SocialEvent には、 verb アクションに関連付けられます。 次のものがあります n-1 ~間の関係 actions および verbs.

このリリースで提供される Communities コンポーネントについて、次の表で説明します verbs それぞれに定義済み topic 使用可能です。

トピックと動詞 topics-and-verbs

カレンダーコンポーネント
SocialEvent topic= com/adobe/cq/social/calendar

動詞
説明
POST
メンバーがカレンダーイベントを作成する
追加
カレンダーイベントに対するメンバーコメント
更新
メンバーのカレンダーイベントまたはコメントが編集されたとき
削除
メンバーのカレンダーイベントまたはコメントが削除されました

コメントコンポーネント
SocialEvent topic= com/adobe/cq/social/comment

動詞
説明
POST
メンバーがコメントを作成
追加
メンバーのコメントへの返信
更新
メンバーのコメントが編集されました
削除
メンバーのコメントが削除されました

ファイルライブラリコンポーネント
SocialEvent topic= com/adobe/cq/social/fileLibrary

動詞
説明
POST
メンバーがフォルダーを作成します
添付
メンバーがファイルをアップロードする
更新
メンバーがフォルダーまたはファイルを更新する
削除
メンバーがフォルダーまたはファイルを削除します

フォーラムコンポーネント
SocialEvent topic= com/adobe/cq/social/forum

動詞
説明
POST
メンバーがフォーラムトピックを作成
追加
フォーラムトピックに対するメンバーの返信
更新
メンバーのフォーラムトピックまたは返信が編集された
削除
メンバーのフォーラムトピックまたは返信が削除されました

ジャーナルコンポーネント
SocialEvent topic= com/adobe/cq/social/journal

動詞
説明
POST
メンバーがブログ記事を作成します
追加
ブログ記事に対するメンバーコメント
更新
メンバーのブログ記事またはコメントが編集されました
削除
メンバーのブログ記事またはコメントが削除されました

QnA コンポーネント
SocialEvent topic = com/adobe/cq/social/qna

動詞
説明
POST
メンバーが QnA 質問を作成します
追加
メンバーが QnA 回答を作成
更新
メンバーの QnA 質問または回答が編集されました
を選択
メンバーの回答が選択されました
選択解除
メンバーの回答は選択解除されています。
削除
メンバーの QnA 質問または回答が削除されました

レビューコンポーネント
SocialEvent topic= com/adobe/cq/social/review

動詞
説明
POST
メンバーがレビューを作成
更新
メンバーのレビューが編集されました
削除
メンバーのレビューが削除されました

評価コンポーネント
SocialEvent topic= com/adobe/cq/social/tally

動詞
説明
評価を追加
メンバーのコンテンツが評価されました
評価を削除
メンバーのコンテンツが評価されていません

投票コンポーネント
SocialEvent topic= com/adobe/cq/social/tally

動詞
説明
投票を追加
メンバーのコンテンツが投票でアップしました
投票を削除
メンバーのコンテンツが投票で落選しました

モデレートが有効なコンポーネント
SocialEvent topic= com/adobe/cq/social/moderation

動詞
説明
拒否
メンバーのコンテンツが拒否されました
不相応な旗
メンバーのコンテンツにフラグが付けられる
不適切なものとして旗を振らない
メンバーのコンテンツのフラグが解除されました
承諾
メンバーのコンテンツはモデレーターによって承認されます
閉じる
メンバーがコメントを閉じて編集と返信を行う
を開く
メンバーがコメントを再度開く

カスタムコンポーネントのイベント events-for-custom-components

カスタムコンポーネントの場合、 SocialEvent 抽象クラス コンポーネントのイベントを次のように記録するには、を拡張する必要があります actions~に起こる topic.

カスタムイベントは、メソッドを上書きします getVerb() 適切なように verbは、それぞれの action. この verb アクションに対して返されるものには、一般的に使用されるもの(例えば POST)またはコンポーネントに特化したもの(例: ADD RATING)に設定します。 次のものがあります n-1 ~間の関係 actionsおよび verbs.

NOTE
カスタム拡張機能が、製品の既存の実装よりも低いランキングで登録されていることを確認します。

カスタムコンポーネントイベントの疑似コード 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");
            }
        }
    }

}

アクティビティストリームデータをフィルタリングする EventListener のサンプル sample-eventlistener-to-filter-activity-stream-data

アクティビティストリームに表示される内容を変更する目的で、イベントをリッスンすることができます。

次の疑似コードのサンプルを使用すると、アクティビティストリームからコメントコンポーネントのDELETEイベントを削除できます。

EventListener の疑似コード pseudo-code-for-eventlistener

が必要 最新の機能パック.

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