org.apache.shindig.gadgets.admin

Class BasicGadgetAdminStore

java.lang.Object

org.apache.shindig.gadgets.admin.BasicGadgetAdminStore

All Implemented Interfaces:

GadgetAdminStore

public class BasicGadgetAdminStore
extends Object
implements GadgetAdminStore

A simple implementation of a gadget administration store.

Since:

2.5.0

Constructor Summary

Constructors

Constructor and Description
BasicGadgetAdminStore(FeatureRegistryProvider featureRegistryProvider, ContainerConfig config, ServerAdminData serverAdminData) Constructor.

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.
void	init(String store) Inits the store from a JSON String representing the gadget administration information.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicGadgetAdminStore

@Inject
public BasicGadgetAdminStore(FeatureRegistryProvider featureRegistryProvider,
                            ContainerConfig config,
                            ServerAdminData serverAdminData)

Constructor.

Method Detail

init

public void init(String store)
          throws GadgetException

Inits the store from a JSON String representing the gadget administration information.

Parameters:

store - a JSON String representing the gadget administration information.

Throws:

GadgetException - thrown when the store cannot be initiated.

getGadgetAdminData

public GadgetAdminData getGadgetAdminData(String container,
                                 String gadgetUrl)

Description copied from interface: GadgetAdminStore

Gets the administration data for a gadget in a container.

Specified by:

getGadgetAdminData in interface GadgetAdminStore

Parameters:

container - the container id.

gadgetUrl - the gadget URL.

Returns:

the administration data for a gadget in a container

setGadgetAdminData

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

Description copied from interface: GadgetAdminStore

Sets gadget administration data for a gadget in a container.

Specified by:

setGadgetAdminData in interface GadgetAdminStore

Parameters:

container - the container id.

gadgetUrl - the gadget URL.

adminData - administration data.

getContainerAdminData

public ContainerAdminData getContainerAdminData(String container)

Description copied from interface: GadgetAdminStore

Gets container administration data.

Specified by:

getContainerAdminData in interface GadgetAdminStore

Parameters:

container - the container to get the administration data for.

Returns:

container administration data.

setContainerAdminData

public void setContainerAdminData(String container,
                         ContainerAdminData containerAdminData)

Description copied from interface: GadgetAdminStore

Sets the container administration data..

Specified by:

setContainerAdminData in interface GadgetAdminStore

Parameters:

container - the container to set the administration data for.

containerAdminData - the container administration data.

getServerAdminData

public ServerAdminData getServerAdminData()

Description copied from interface: GadgetAdminStore

Gets the administration data for the server.

Specified by:

getServerAdminData in interface GadgetAdminStore

Returns:

the administration data for the server.

checkFeatureAdminInfo

public boolean checkFeatureAdminInfo(Gadget gadget)

Description copied from interface: GadgetAdminStore

Checks the feature administration data for a gadget.

Specified by:

checkFeatureAdminInfo in interface GadgetAdminStore

Parameters:

gadget - The gadget to check.

Returns:

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

isAllowedFeature

public boolean isAllowedFeature(Feature feature,
                       Gadget gadget)

Description copied from interface: GadgetAdminStore

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.

Specified by:

isAllowedFeature in interface GadgetAdminStore

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

public boolean isWhitelisted(String container,
                    String gadgetUrl)

Description copied from interface: GadgetAdminStore

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

Specified by:

isWhitelisted in interface GadgetAdminStore

Parameters:

container - The container id.

gadgetUrl - The gadget URL.

Returns:

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

getAdditionalRpcServiceIds

public Set<String> getAdditionalRpcServiceIds(Gadget gadget)

Description copied from interface: GadgetAdminStore

Gets additional RPC service IDs to allow for the gadget.

Specified by:

getAdditionalRpcServiceIds in interface GadgetAdminStore

Parameters:

gadget - The gadget to get the IDs for.

Returns:

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