com.sdl.context.api.resolution

Class EvidenceBuilder

java.lang.Object

com.sdl.context.api.resolution.EvidenceBuilder

public class EvidenceBuilder
extends Object

Evidence builder to create evidence that can be used via the ContextEngine resolve method to resolve context.

This class has some static help methods, e.g.

 
 // Create evidence based on a given user agent
 EvidenceBuilder.withUserAgent("my-user-agent");
 
 

You can also interact with the builder object directly, e.g.

 
 // Create evidence based on a various pieces of evidence
 new EvidenceBuilder()
     // call with 1 argument sets the user agent argument
     .with("my-user-agent")
     // call with 2 arguments allows you control which evidence item you are adding
     .with("cookie", "my-cookie")
     // call with 3 arguments allows you to set the origin, e.g. define preset context property
     .with("device.displayWidth", "400", "context")
     // ... and finally build the evidence
     .build()
 
 

Constructor Summary

Constructors

Constructor and Description
EvidenceBuilder() Create new EvidenceBuilder.

Method Summary

Modifier and Type	Method and Description
Evidence	build() Build the evidence.
protected EvidenceItem	get(String key) Get the evidence value for the given key.
EvidenceBuilder	with(Evidence evidence) State evidence that the evidence that you are building inherits from.
EvidenceBuilder	with(Map<String,Object> evidenceMap) Create evidence based on a map of evidence key / value pairs.
EvidenceBuilder	with(Object value) Add evidence item for given user-agent HTTP header.
EvidenceBuilder	with(String key, Object value) Add evidence for the given key / value pair, e.g.
EvidenceBuilder	with(String key, Object value, String origin) Add evidence for the given key / value pair and origin, e.g.
static Evidence	withEvidence(Map<String,Object> evidenceMap) Create evidence based on a map of evidence key / value pairs.
EvidenceBuilder	withPublicationId(Integer publicationId) Add evidence item for given publication id related to target group.
static Evidence	withUserAgent(String userAgent) Create evidence based on just a single user agent HTTP header.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EvidenceBuilder

public EvidenceBuilder()

Create new EvidenceBuilder.

Method Detail

withUserAgent

public static Evidence withUserAgent(String userAgent)

Create evidence based on just a single user agent HTTP header.

Parameters:

userAgent - user agent HTTP header

Returns:

evidence

withEvidence

public static Evidence withEvidence(Map<String,Object> evidenceMap)

Create evidence based on a map of evidence key / value pairs.

Parameters:

evidenceMap - map of evidence key / value pairs

Returns:

evidence

with

public EvidenceBuilder with(Object value)

Add evidence item for given user-agent HTTP header.

Parameters:

value - user agent HTTP header value

Returns:

evidence builder

withPublicationId

public EvidenceBuilder withPublicationId(Integer publicationId)

Add evidence item for given publication id related to target group.

Parameters:

publicationId - publication id

Returns:

evidence with 'publication-id' key and 'target-group' origin

with

public EvidenceBuilder with(String key,
                            Object value)

Add evidence for the given key / value pair, e.g. setting the cookie evidence.

Parameters:

key - evidence key

value - evidence value

Returns:

evidence builder

with

public EvidenceBuilder with(String key,
                            Object value,
                            String origin)

Add evidence for the given key / value pair and origin, e.g. use origin "context" to define preset context property.

Parameters:

key - evidence key

value - evidence value

origin - evidence origin

Returns:

evidence builder

with

public EvidenceBuilder with(Map<String,Object> evidenceMap)

Create evidence based on a map of evidence key / value pairs.

Parameters:

evidenceMap - evidence map of key / value pairs

Returns:

evidence builder

with

public EvidenceBuilder with(Evidence evidence)

State evidence that the evidence that you are building inherits from. This allows you to define a default evidence that you can reuse as a base and create further evidence objects that are slight tweaks from this base.

Parameters:

evidence - evidence the evidence you are building on should inherit from

Returns:

evidence builder

get

protected EvidenceItem get(String key)

Get the evidence value for the given key.

Parameters:

key - evidence key name

Returns:

evidence

build

public Evidence build()

Build the evidence.

Returns:

evidence.