com.atlassian.analytics.client.extractor

Interface PropertyExtractor

All Known Implementing Classes:

BambooPropertyExtractor, BitbucketPropertyExtractor, ConfluencePropertyExtractor, CrowdPropertyExtractor, DefaultPropertyExtractor, FecruPropertyExtractor, JiraPropertyExtractor

public interface PropertyExtractor

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	enrichProperties(Object event) Enrich properties
String	extractName(Object event)
Map<String,Object>	extractProperty(String name, Object value)
String	extractRequestCorrelationId(RequestInfo request) get requestCorrelationId
String	extractSubProduct(Object event, String product) Determine the sub product for this event
String	extractUser(Object event, Map<String,Object> properties)
String	getApplicationAccess() Get the application access for the logged in user associated with this event.
boolean	isExcluded(String name)

Method Detail

extractProperty

Map<String,Object> extractProperty(String name,
                                   Object value)

Returns:

a mapping of all valid properties on the value, prefixed with name + '.'.

isExcluded

boolean isExcluded(String name)

extractName

String extractName(Object event)

Returns:

the name of this event

extractUser

String extractUser(Object event,
                   Map<String,Object> properties)

Returns:

the user to be associated with this event

enrichProperties

Map<String,Object> enrichProperties(Object event)

Enrich properties

Returns:

properties to be added to the event

extractSubProduct

String extractSubProduct(Object event,
                         String product)

Determine the sub product for this event

Returns:

sub product

getApplicationAccess

String getApplicationAccess()

Get the application access for the logged in user associated with this event. For un-logged in user, empty string "" is returned. At the moment,it only return the proper value for all JIRA events. Other products like Confluence, return empty string.

Returns:

comma separated string representing application access, e.g. ",business,,software,"

extractRequestCorrelationId

String extractRequestCorrelationId(RequestInfo request)

get requestCorrelationId

Returns:

requestCorrelationId