org.apache.unomi.rest.endpoints

Class CampaignsServiceEndPoint

java.lang.Object

org.apache.unomi.rest.endpoints.CampaignsServiceEndPoint

@Produces(value="application/json")
 @Consumes(value="application/json")
 @Path(value="/campaigns")
public class CampaignsServiceEndPoint
extends Object

A JAX-RS endpoint to manage Campaigns and related information.

Constructor Summary

Constructors

Constructor and Description
CampaignsServiceEndPoint()

Method Summary

Modifier and Type	Method and Description
Campaign	getCampaignDefinition(String campaignID) Retrieves the campaign identified by the specified identifier
CampaignDetail	getCampaignDetail(String campaignID) Retrieves the CampaignDetail associated with the campaign identified with the specified identifier
PartialList<CampaignDetail>	getCampaignDetails(Query query) Retrieves campaign details for campaigns matching the specified query.
PartialList<CampaignEvent>	getCampaignEvents(Query query) Retrieves CampaignEvents matching the specified query.
Set<Metadata>	getCampaignMetadatas() Retrieves the set of Metadata associated with existing campaigns.
Set<Metadata>	getCampaignMetadatas(Query query) Retrieves the set of Metadata associated with existing campaign matching the specified Query
void	removeCampaignDefinition(String campaignID) Removes the campaign associated with the specified identifier, also removing associated rules if needed.
void	removeCampaignEventDefinition(String campaignEventID) Removes the campaign event associated with the specified identifier.
void	setCampaignDefinition(Campaign campaign) Saves the specified campaign in the context server and creates associated Rules if the campaign is enabled.
void	setCampaignEventDefinition(CampaignEvent campaignEvent) Saves the specified campaign event in the context server.
void	setGoalsService(GoalsService goalsService)

Methods inherited from class java.lang.Object

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

Constructor Detail

CampaignsServiceEndPoint

public CampaignsServiceEndPoint()

Method Detail

setGoalsService

public void setGoalsService(GoalsService goalsService)

getCampaignMetadatas

@GET
 @Path(value="/")
public Set<Metadata> getCampaignMetadatas()

Retrieves the set of Metadata associated with existing campaigns.

Returns:

the set of Metadata associated with existing campaigns

setCampaignDefinition

@POST
 @Path(value="/")
public void setCampaignDefinition(Campaign campaign)

Saves the specified campaign in the context server and creates associated Rules if the campaign is enabled.

Parameters:

campaign - the Campaign to be saved

getCampaignMetadatas

@POST
 @Path(value="/query")
public Set<Metadata> getCampaignMetadatas(Query query)

Retrieves the set of Metadata associated with existing campaign matching the specified Query

Parameters:

query - the Query used to filter the campagins which metadata we want to retrieve

Returns:

the set of Metadata associated with existing campaigns matching the specified Query

getCampaignDetails

@POST
 @Path(value="/query/detailed")
public PartialList<CampaignDetail> getCampaignDetails(Query query)

Retrieves campaign details for campaigns matching the specified query.

Parameters:

query - the query specifying which campaigns to retrieve

Returns:

a PartialList of campaign details for the campaigns matching the specified query

getCampaignDetail

@GET
 @Path(value="/{campaignID}/detailed")
public CampaignDetail getCampaignDetail(@PathParam(value="campaignID")
                                                                                    String campaignID)

Retrieves the CampaignDetail associated with the campaign identified with the specified identifier

Parameters:

campaignID - the identifier of the campaign for which we want to retrieve the details

Returns:

the CampaignDetail for the campaign identified by the specified identifier or null if no such campaign exists

getCampaignDefinition

@GET
 @Path(value="/{campaignID}")
public Campaign getCampaignDefinition(@PathParam(value="campaignID")
                                                                         String campaignID)

Retrieves the campaign identified by the specified identifier

Parameters:

campaignID - the identifier of the campaign we want to retrieve

Returns:

the campaign associated with the specified identifier or null if no such campaign exists

removeCampaignDefinition

@DELETE
 @Path(value="/{campaignID}")
public void removeCampaignDefinition(@PathParam(value="campaignID")
                                                                           String campaignID)

Removes the campaign associated with the specified identifier, also removing associated rules if needed.

Parameters:

campaignID - the identifier of the campaign to be removed

setCampaignEventDefinition

@POST
 @Path(value="/event")
public void setCampaignEventDefinition(CampaignEvent campaignEvent)

Saves the specified campaign event in the context server.

Parameters:

campaignEvent - the CampaignEvent to be saved

removeCampaignEventDefinition

@DELETE
 @Path(value="/event/{eventId}")
public void removeCampaignEventDefinition(@PathParam(value="eventId")
                                                                                   String campaignEventID)

Removes the campaign event associated with the specified identifier.

Parameters:

campaignEventID - the identifier of the campaign event to be removed

getCampaignEvents

@POST
 @Path(value="/events/query")
public PartialList<CampaignEvent> getCampaignEvents(Query query)

Retrieves CampaignEvents matching the specified query.

Parameters:

query - the Query specifying which CampaignEvents to retrieve

Returns:

a PartialList of campaign events matching the specified query