org.apache.shindig.gadgets.admin

Interface GadgetAdminStore

All Known Implementing Classes:

BasicGadgetAdminStore

public interface GadgetAdminStore

Interface for working with the store of gadget administration data.

Since:

2.5.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkFeatureAdminInfo(Gadget gadget) Checks the feature administration data for a gadget.
Set<String>	getAdditionalRpcServiceIds(Gadget gadget) Gets additional RPC service IDs to allow for the gadget.
ContainerAdminData	getContainerAdminData(String container) Gets container administration data.
GadgetAdminData	getGadgetAdminData(String container, String gadgetUrl) Gets the administration data for a gadget in a container.
ServerAdminData	getServerAdminData() Gets the administration data for the server.
boolean	isAllowedFeature(Feature feature, Gadget gadget) If feature administration is enabled for the given container then check to see if the feature is allowed.
boolean	isWhitelisted(String container, String gadgetUrl) Determines whether a gadget is on the whitelist of trusted gadgets set by the admin.
void	setContainerAdminData(String container, ContainerAdminData containerAdminData) Sets the container administration data..
void	setGadgetAdminData(String container, String gadgetUrl, GadgetAdminData adminData) Sets gadget administration data for a gadget in a container.

Method Detail

getGadgetAdminData

GadgetAdminData getGadgetAdminData(String container,
                                 String gadgetUrl)

Gets the administration data for a gadget in a container.

Parameters:

container - the container id.

gadgetUrl - the gadget URL.

Returns:

the administration data for a gadget in a container

setGadgetAdminData

void setGadgetAdminData(String container,
                      String gadgetUrl,
                      GadgetAdminData adminData)

Sets gadget administration data for a gadget in a container.

Parameters:

container - the container id.

gadgetUrl - the gadget URL.

adminData - administration data.

getContainerAdminData

ContainerAdminData getContainerAdminData(String container)

Gets container administration data.

Parameters:

container - the container to get the administration data for.

Returns:

container administration data.

setContainerAdminData

void setContainerAdminData(String container,
                         ContainerAdminData containerAdminData)

Sets the container administration data..

Parameters:

container - the container to set the administration data for.

containerAdminData - the container administration data.

getServerAdminData

ServerAdminData getServerAdminData()

Gets the administration data for the server.

Returns:

the administration data for the server.

checkFeatureAdminInfo

boolean checkFeatureAdminInfo(Gadget gadget)

Checks the feature administration data for a gadget.

Parameters:

gadget - The gadget to check.

Returns:

true if the gadget is allowed to use all the features it requires false otherwise.

isAllowedFeature

boolean isAllowedFeature(Feature feature,
                       Gadget gadget)

If feature administration is enabled for the given container then check to see if the feature is allowed. If it is not allowed the feature code will not be loaded in the container so we should not put it in the config.

Parameters:

feature - The feature to check.

gadget - The gadget to check.

Returns:

true if the feature is allowed to be used by the gadget in the given container.

isWhitelisted

boolean isWhitelisted(String container,
                    String gadgetUrl)

Determines whether a gadget is on the whitelist of trusted gadgets set by the admin.

Parameters:

container - The container id.

gadgetUrl - The gadget URL.

Returns:

true if the gadget is on the whitelist, false otherwise.

getAdditionalRpcServiceIds

Set<String> getAdditionalRpcServiceIds(Gadget gadget)

Gets additional RPC service IDs to allow for the gadget.

Parameters:

gadget - The gadget to get the IDs for.

Returns:

The set of additional RPC service IDs to allow for the gadget.