org.apache.unomi.rest.endpoints

Class DefinitionsServiceEndPoint

java.lang.Object

org.apache.unomi.rest.endpoints.DefinitionsServiceEndPoint

@Produces(value="application/json;charset=UTF-8")
 @Path(value="/definitions")
public class DefinitionsServiceEndPoint
extends Object

A JAX-RS endpoint to retrieve definition information about core context server entities such as conditions, actions and values.

Constructor Summary

Constructors

Constructor and Description
DefinitionsServiceEndPoint()

Method Summary

Modifier and Type	Method and Description
RESTActionType	getActionType(String id, String language) Retrieves the action type associated with the specified identifier localized using the specified language.
Collection<RESTActionType>	getActionTypeBySystemTag(String tags, String language) Retrieves the set of action types with the specified system tags.
Collection<RESTActionType>	getActionTypeByTag(String tags, String language) Retrieves the set of action types with the specified tags.
Collection<RESTActionType>	getAllActionTypes(String language) Retrieves all known action types localized using the specified language.
Collection<RESTConditionType>	getAllConditionTypes(String language) Retrieves all condition types localized using the specified language.
Collection<RESTValueType>	getAllValueTypes(String language) Retrieves all known value types localized using the specified language.
RESTConditionType	getConditionType(String id, String language) Retrieves the condition type associated with the specified identifier localized using the specified language.
Collection<RESTConditionType>	getConditionTypesBySystemTag(String tags, String language) Retrieves the set of condition types with the specified system tags.
Collection<RESTConditionType>	getConditionTypesByTag(String tags, String language) Retrieves the set of condition types with the specified tags.
PropertyMergeStrategyType	getPropertyMergeStrategyType(String id)
Map<Long,List<PluginType>>	getTypesByPlugin() Retrieves a Map of plugin identifier to a list of plugin types defined by that particular plugin.
RESTValueType	getValueType(String id, String language) Retrieves the value type associated with the specified identifier localized using the specified language.
Collection<RESTValueType>	getValueTypeByTag(String tags, String language) Retrieves the set of value types with the specified tags.
void	removeActionType(String actionTypeId) Removes the action type
void	removeConditionType(String conditionTypeId) Removes the condition type
void	setActionType(ActionType actionType) Stores the action type
void	setConditionType(ConditionType conditionType) Stores the condition type
void	setDefinitionsService(DefinitionsService definitionsService)
void	setLocalizationHelper(LocalizationHelper localizationHelper)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefinitionsServiceEndPoint

public DefinitionsServiceEndPoint()

Method Detail

setDefinitionsService

public void setDefinitionsService(DefinitionsService definitionsService)

setLocalizationHelper

public void setLocalizationHelper(LocalizationHelper localizationHelper)

getAllConditionTypes

@GET
 @Path(value="/conditions")
public Collection<RESTConditionType> getAllConditionTypes(@HeaderParam(value="Accept-Language")
                                                                                           String language)

Retrieves all condition types localized using the specified language.

Parameters:

language - the language to use to localize.

Returns:

a Collection of all collection types

getConditionTypesByTag

@GET
 @Path(value="/conditions/tags/{tags}")
public Collection<RESTConditionType> getConditionTypesByTag(@PathParam(value="tags")
                                                                                                         String tags,
                                                                                                         @HeaderParam(value="Accept-Language")
                                                                                                         String language)

Retrieves the set of condition types with the specified tags.

Parameters:

language - the language to use to localize.

tags - a comma-separated list of tag identifiers

Returns:

the set of condition types with the specified tag

getConditionTypesBySystemTag

@GET
 @Path(value="/conditions/systemTags/{tags}")
public Collection<RESTConditionType> getConditionTypesBySystemTag(@PathParam(value="tags")
                                                                                                                     String tags,
                                                                                                                     @HeaderParam(value="Accept-Language")
                                                                                                                     String language)

Retrieves the set of condition types with the specified system tags.

Parameters:

language - the language to use to localize.

tags - a comma-separated list of tag identifiers

Returns:

the set of condition types with the specified tag

getConditionType

@GET
 @Path(value="/conditions/{conditionId}")
public RESTConditionType getConditionType(@PathParam(value="conditionId")
                                                                                         String id,
                                                                                         @HeaderParam(value="Accept-Language")
                                                                                         String language)

Retrieves the condition type associated with the specified identifier localized using the specified language.

Parameters:

language - the language to use to localize.

id - the identifier of the condition type to retrieve

Returns:

the condition type associated with the specified identifier or null if no such condition type exists

setConditionType

@POST
 @Path(value="/conditions")
public void setConditionType(ConditionType conditionType)

Stores the condition type

Parameters:

conditionType - the condition type to store

removeConditionType

@DELETE
 @Path(value="/conditions/{conditionTypeId}")
public void removeConditionType(@PathParam(value="conditionTypeId")
                                                                                      String conditionTypeId)

Removes the condition type

Parameters:

conditionTypeId - the identifier of the action type to delete

getAllActionTypes

@GET
 @Path(value="/actions")
public Collection<RESTActionType> getAllActionTypes(@HeaderParam(value="Accept-Language")
                                                                                  String language)

Retrieves all known action types localized using the specified language.

Parameters:

language - the language to use to localize.

Returns:

all known action types

getActionTypeByTag

@GET
 @Path(value="/actions/tags/{tags}")
public Collection<RESTActionType> getActionTypeByTag(@PathParam(value="tags")
                                                                                               String tags,
                                                                                               @HeaderParam(value="Accept-Language")
                                                                                               String language)

Retrieves the set of action types with the specified tags.

Parameters:

language - the language to use to localize.

tags - the tag marking the action types we want to retrieve

Returns:

the set of action types with the specified tag

getActionTypeBySystemTag

@GET
 @Path(value="/actions/systemTags/{tags}")
public Collection<RESTActionType> getActionTypeBySystemTag(@PathParam(value="tags")
                                                                                                           String tags,
                                                                                                           @HeaderParam(value="Accept-Language")
                                                                                                           String language)

Retrieves the set of action types with the specified system tags.

Parameters:

language - the language to use to localize.

tags - the tag marking the action types we want to retrieve

Returns:

the set of action types with the specified tag

getActionType

@GET
 @Path(value="/actions/{actionId}")
public RESTActionType getActionType(@PathParam(value="actionId")
                                                                             String id,
                                                                             @HeaderParam(value="Accept-Language")
                                                                             String language)

Retrieves the action type associated with the specified identifier localized using the specified language.

Parameters:

language - the language to use to localize.

id - the identifier of the action type to retrieve

Returns:

the action type associated with the specified identifier or null if no such action type exists

setActionType

@POST
 @Path(value="/actions")
public void setActionType(ActionType actionType)

Stores the action type

Parameters:

actionType - the action type to store

removeActionType

@DELETE
 @Path(value="/actions/{actionTypeId}")
public void removeActionType(@PathParam(value="actionTypeId")
                                                                             String actionTypeId)

Removes the action type

Parameters:

actionTypeId - the identifier of the action type to delete

getAllValueTypes

@GET
 @Path(value="/values")
public Collection<RESTValueType> getAllValueTypes(@HeaderParam(value="Accept-Language")
                                                                               String language)

Retrieves all known value types localized using the specified language.

Parameters:

language - the language to use to localize.

Returns:

all known value types

getValueTypeByTag

@GET
 @Path(value="/values/tags/{tags}")
public Collection<RESTValueType> getValueTypeByTag(@PathParam(value="tags")
                                                                                            String tags,
                                                                                            @HeaderParam(value="Accept-Language")
                                                                                            String language)

Retrieves the set of value types with the specified tags.

Parameters:

language - the language to use to localize.

tags - the tag marking the value types we want to retrieve

Returns:

the set of value types with the specified tag

getValueType

@GET
 @Path(value="/values/{valueTypeId}")
public RESTValueType getValueType(@PathParam(value="valueTypeId")
                                                                             String id,
                                                                             @HeaderParam(value="Accept-Language")
                                                                             String language)

Retrieves the value type associated with the specified identifier localized using the specified language.

Parameters:

language - the language to use to localize.

id - the identifier of the value type to retrieve

Returns:

the value type associated with the specified identifier or null if no such value type exists

getTypesByPlugin

@GET
 @Path(value="/typesByPlugin")
public Map<Long,List<PluginType>> getTypesByPlugin()

Retrieves a Map of plugin identifier to a list of plugin types defined by that particular plugin.

Returns:

a Map of plugin identifier to a list of plugin types defined by that particular plugin

getPropertyMergeStrategyType

public PropertyMergeStrategyType getPropertyMergeStrategyType(String id)