com.adobe.cq.social.activitystreams.listener.api

Interface ActivityStreamProviderExtension

public interface ActivityStreamProviderExtension

Stream provider extension. An stream provider extension can add custom properties to an activity, or veto an event so that no activity is generated for that event.

Method Summary

Modifier and Type	Method and Description
boolean	evaluate(SocialEvent<?> event, Resource resource) Determine if the specified SocialEvent would generating an activity com.adobe.granite.activitystreams.Activity stream
java.util.Map<java.lang.String,? extends java.lang.Object>	getActivityProperties(SocialEvent<?> event, Resource resource) Get additional properties for the specified SocialEvent.
java.util.Map<java.lang.String,? extends java.lang.Object>	getActorProperties(SocialEvent<?> event, Resource resource) Get additional actor properties for the specified SocialEvent.
java.lang.String	getName() Get the name of this extension
java.util.Map<java.lang.String,? extends java.lang.Object>	getObjectProperties(SocialEvent<?> event, Resource resource) Get additional object properties for the specified SocialEvent.
int	getRanking() Get the ranking index for this extension.
java.lang.String[]	getStreamProviderPid() Get the stream provider class name
java.util.Map<java.lang.String,? extends java.lang.Object>	getTargetProperties(SocialEvent<?> event, Resource resource) Get the target properties for the specified SocialEvent.

Method Detail

getName

java.lang.String getName()

Get the name of this extension

Returns:

String

getStreamProviderPid

java.lang.String[] getStreamProviderPid()

Get the stream provider class name

Returns:

String[]

evaluate

boolean evaluate(SocialEvent<?> event,
                 Resource resource)

Determine if the specified SocialEvent would generating an activity com.adobe.granite.activitystreams.Activity stream

Parameters:

event - the Social event

resource - the resource, the activity object. This value can be null.

Returns:

boolean true if the system should generate an activity stream for the specified event.

getRanking

int getRanking()

Get the ranking index for this extension.

Returns:

int

getActivityProperties

java.util.Map<java.lang.String,? extends java.lang.Object> getActivityProperties(SocialEvent<?> event,
                                                                                 Resource resource)

Get additional properties for the specified SocialEvent. The keys of the returned map could be one of the properties declared in JsonConstants

Parameters:

event - SocialEvent

resource - Resource

Returns:

Map map of additional properties

getObjectProperties

java.util.Map<java.lang.String,? extends java.lang.Object> getObjectProperties(SocialEvent<?> event,
                                                                               Resource resource)

Get additional object properties for the specified SocialEvent. The keys of the returned map could be one of the properties declared in JsonConstants

Parameters:

event - SocialEvent

resource - Resource

Returns:

Map map of object properties

getActorProperties

java.util.Map<java.lang.String,? extends java.lang.Object> getActorProperties(SocialEvent<?> event,
                                                                              Resource resource)

Get additional actor properties for the specified SocialEvent. The keys of the returned map could be one of the properties declared in JsonConstants

Parameters:

event - SocialEvent

resource - Resource

Returns:

Map map of actor properties

getTargetProperties

java.util.Map<java.lang.String,? extends java.lang.Object> getTargetProperties(SocialEvent<?> event,
                                                                               Resource resource)

Get the target properties for the specified SocialEvent. The keys of the returned map could be one of the properties declared in JsonConstants

Parameters:

event - SocialEvent

resource - Resource

Returns:

Map map of target properties