org.sakaiproject.entitybroker.providers
Class ServerConfigEntityProvider

java.lang.Object
  org.sakaiproject.entitybroker.util.AbstractEntityProvider
      org.sakaiproject.entitybroker.providers.ServerConfigEntityProvider

All Implemented Interfaces:

ActionsExecutable, CollectionResolvable, Describeable, Outputable, Resolvable, CoreEntityProvider, EntityProvider, Formats, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class ServerConfigEntityProvider
extends AbstractEntityProvider
implements CoreEntityProvider, Outputable, Resolvable, CollectionResolvable, ActionsExecutable, Describeable

This provides access to the server configuration as entities, output access only though, no setting of configuration

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Nested Class Summary

static class

ServerConfigEntityProvider.ESCComparator

Field Summary

String[]	includedBooleanSettings
String[]	includedStringSettings
static String	PREFIX

Fields inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

developerHelperService

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

SEARCH_LOCATION_REFERENCE, SEARCH_TAGS, SEARCH_USER_REFERENCE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable

ACTION_METHOD_SUFFIX

Constructor Summary

ServerConfigEntityProvider()

Method Summary

boolean	entityExists(String id)
Object	getAllNames(EntityReference ref)
Object	getAllValues()
Object	getClusterServers(EntityReference ref)
Object	getConfig(String name)
List<?>	getEntities(EntityReference ref, Search search)
Object	getEntity(EntityReference ref)
String	getEntityPrefix()
String[]	getHandledOutputFormats()
Map<String,Object>	getKnownSettings() Retrieves the known values in SCS which are not actually strings and properties
void	setClusterService(org.sakaiproject.cluster.api.ClusterService clusterService)
void	setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)

Methods inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

afterPropertiesSet, destroy, setDeveloperHelperService, setEntityProviderManager

Methods inherited from class java.lang.Object

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

Field Detail

includedStringSettings

public String[] includedStringSettings

includedBooleanSettings

public String[] includedBooleanSettings

PREFIX

public static String PREFIX

Constructor Detail

ServerConfigEntityProvider

public ServerConfigEntityProvider()

Method Detail

setServerConfigurationService

public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)

setClusterService

public void setClusterService(org.sakaiproject.cluster.api.ClusterService clusterService)

getEntityPrefix

public String getEntityPrefix()

Specified by:

getEntityPrefix in interface EntityProvider

getClusterServers

public Object getClusterServers(EntityReference ref)

getAllValues

public Object getAllValues()

getAllNames

public Object getAllNames(EntityReference ref)

entityExists

public boolean entityExists(String id)

Specified by:

entityExists in interface CoreEntityProvider

getEntity

public Object getEntity(EntityReference ref)

Specified by:

getEntity in interface Resolvable

getEntities

public List<?> getEntities(EntityReference ref,
                           Search search)

Specified by:

getEntities in interface CollectionResolvable

getHandledOutputFormats

public String[] getHandledOutputFormats()

Specified by:

getHandledOutputFormats in interface Outputable

getConfig

public Object getConfig(String name)

getKnownSettings

public Map<String,Object> getKnownSettings()

Retrieves the known values in SCS which are not actually strings and properties

Returns:

a map of name -> value