org.jbei.ice.services.rest

Class ConfigResource

java.lang.Object

org.jbei.ice.services.rest.RestResource

org.jbei.ice.services.rest.ConfigResource

@Path(value="/config")
public class ConfigResource
extends RestResource

Author:

Hector Plahar

Field Summary

Fields inherited from class org.jbei.ice.services.rest.RestResource

API_KEY_CLIENT_ID, API_KEY_TOKEN, API_KEY_USER, apiClientId, apiToken, apiUser, AUTHENTICATION_PARAM_NAME, hmacHeader, querySessionId, REMOTE_USER_ID, REMOTE_USER_TOKEN, remoteUserId, remoteUserToken, request, sessionId, WOR_PARTNER_TOKEN, worPartnerToken

Constructor Summary

Constructors

Constructor and Description
ConfigResource()

Method Summary

Modifier and Type	Method and Description
ArrayList<Setting>	get() Retrieves list of system settings available
javax.ws.rs.core.Response	getConfig(String key) Retrieves the value for the specified config key
javax.ws.rs.core.Response	getSiteSettings()
Setting	getVersion(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	update(Setting setting)
javax.ws.rs.core.Response	updateConfigValue(Setting setting)

Methods inherited from class org.jbei.ice.services.rest.RestResource

addHeaders, getThisServer, getUserId, getUserId, getWebPartner, log, requireUserId, requireUserIdOrWebPartner, requireWebPartner, respond, respond, respond, respond

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigResource

public ConfigResource()

Method Detail

get

@GET
 @Produces(value="application/json")
public ArrayList<Setting> get()

Retrieves list of system settings available

Returns:

list of retrieved system settings that can be changed (including those with no values)

getSiteSettings

@GET
 @Path(value="/site")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getSiteSettings()

getVersion

@GET
 @Path(value="/version")
 @Produces(value="application/json")
public Setting getVersion(@Context
                                                                                             javax.ws.rs.core.UriInfo uriInfo)

Returns:

the version setting of this ICE instance

getConfig

@GET
 @Path(value="/{key}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getConfig(@PathParam(value="key")
                                                                                                            String key)

Retrieves the value for the specified config key

Parameters:

key - config key

Returns:

setting containing the passed key and associated value if found

update

@PUT
 @Produces(value="application/json")
public javax.ws.rs.core.Response update(Setting setting)

Parameters:

setting - a config value to update

Returns:

the updated config key:value

updateConfigValue

@PUT
 @Path(value="/value")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateConfigValue(Setting setting)