커뮤니티 구성 요소에 대한 OSGi 이벤트 osgi-events-for-communities-components
개요 overview
구성원이 커뮤니티 기능과 상호 작용할 때 알림 또는 게임화(점수 및 배지)와 같은 비동기 리스너를 트리거할 수 있는 OSGi 이벤트가 전송됩니다.
구성 요소의 SocialEvent 인스턴스가 topic
에 대해 발생하는 이벤트를 actions
(으)로 기록합니다. SocialEvent에는 작업과 연결된 verb
을(를) 반환하는 메서드가 포함되어 있습니다. actions
과(와) verbs
사이에 n-1 관계가 있습니다.
릴리스에 제공된 Communities 구성 요소의 경우 다음 표에서는 사용할 수 있는 각 topic
에 대해 정의된 verbs
을(를) 설명합니다.
주제 및 동사 topics-and-verbs
달력 구성 요소
SocialEvent topic
= com/adobe/cq/social/calendar
댓글 구성 요소
SocialEvent topic
= com/adobe/cq/social/comment
파일 라이브러리 구성 요소
SocialEvent topic
= com/adobe/cq/social/fileLibrary
포럼 구성 요소
SocialEvent topic
= com/adobe/cq/social/forum
저널 구성 요소
SocialEvent topic
= com/adobe/cq/social/journal
QnA 구성 요소
SocialEvent topic
= com/adobe/cq/social/q
구성 요소 검토
SocialEvent topic
= com/adobe/cq/social/review
구성 요소 평가
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 추상 클래스을(를) 확장하여 구성 요소의 이벤트를 topic
에 대해 발생하는 actions
로 기록해야 합니다.
사용자 지정 이벤트는 각 action
에 대해 적절한 verb
이(가) 반환되도록 getVerb()
메서드를 재정의합니다. 작업에 대해 반환된 verb
은(는) 일반적으로 사용되는 것(예: POST
) 또는 구성 요소에 특화된 것(예: ADD RATING
)일 수 있습니다. actions
과(와) verbs
사이에 n-1 관계가 있습니다.
사용자 지정 구성 요소 이벤트에 대한 의사 코드 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
활동 스트림에 나타나는 것을 수정하기 위한 목적으로 이벤트를 들을 수 있다.
다음 의사 코드 샘플은 활동 스트림에서 Comments 구성 요소에 대한 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[]{"*"};
}
}