SetupResourceProvider

All Known Implementing Classes:: PatternMatchingSetupResourceProvider, SimpleSetupResourceProvider

public interface SetupResourceProvider

API for a provider of resource(s) to support SettingSpecifier clients.

Version:: 1.0
Author:: matt

Field Summary

Fields

Modifier and Type

Field

Description

static final String

WEB_CONSUMER_TYPE

A consumer type for webapp-based resources.
Method Summary

Modifier and Type

Method

Description

SetupResource

getSetupResource(String resourceUID, Locale locale)

Get a specific resource for a resource UID.

Collection<SetupResource>

getSetupResourcesForConsumer(String consumerType, Locale locale)

Get a set of resources for specific context and content type.

Field Details
- WEB_CONSUMER_TYPE
  
  static final String WEB_CONSUMER_TYPE
  
  A consumer type for webapp-based resources.
  See Also:
  
  Constant Field Values
Method Details
- getSetupResource
  
  SetupResource getSetupResource(String resourceUID, Locale locale)
  
  Get a specific resource for a resource UID.
  
  Parameters:
  
  resourceUID - the ID of the resource to get
  
  locale - the desired locale
  
  Returns:
  
  the resource, or null if not available
- getSetupResourcesForConsumer
  
  Collection<SetupResource> getSetupResourcesForConsumer(String consumerType, Locale locale)
  
  Get a set of resources for specific context and content type. A consumerType represents the type of application the consumer of the setup resources represents. The WEB_CONSUMER_TYPE represents a webapp, for example, and would be interested in resources such as JavaScript, CSS, images, etc.
  
  Parameters:
  
  consumerType - the consumer type to get all appropriate resources for.
  
  locale - the desired locale.
  
  Returns:
  
  all matching resources, never null