com.neurosys.configs.service.jaxrs

Class DynamicConfigService<C extends AbstractConfiguration>

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.amorphous.service.jaxrs.SecurableService

com.neurosys.amorphous.service.jaxrs.AuthorizableSecurableService

com.neurosys.common.service.jaxrs.SiteAuthorizableSecurableService

com.neurosys.configs.service.jaxrs.DynamicConfigService<C>

Type Parameters:

C - as AbstractConfiguration type

All Implemented Interfaces:

Authorizable

@Path(value="/")
 @Consumes(value={"application/json","application/text","text/html"})
 @Produces(value="application/json;charset=utf-8")
 @Secured(value={"ROLE_USER","ROLE_ADMIN"})
public class DynamicConfigService<C extends AbstractConfiguration>
extends SiteAuthorizableSecurableService

A WebService to extract static properties, dynamic configurations which are backed by ConfigurationService - getService().
It also supports an optional context based namespace. Context is derived from the request using a custom Adapter deriveContextNameSpacePrefix.

Note: Context based namespace automation ONLY applies to get not to set or edit methods. In set and edit, one has to be specific.

Author:

Arjun Dhar

Field Summary

Fields inherited from class com.neurosys.common.service.jaxrs.SiteAuthorizableSecurableService

audit, authorizationModule

Fields inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

applicationContext, CACHE, NO_CACHE, request, response

Constructor Summary

Constructors

Constructor and Description
DynamicConfigService()
DynamicConfigService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
void	addEdit(String namespace, String name, String value)
void	clearCache(String namespace)
boolean	delete(String namespace, String name)
boolean	edit(String namespace, String name, String value, Integer status)
Map	get(String namespace)
javax.ws.rs.core.Response	get(String namespace, String name)
protected String	getContextNameSpace(String contextNameSpacePrefix, String namespace)
protected <T> T	getContextNameSpaceConfig(Function<String,Object> f) Override, to override all Context based namespace derived config behavior.
Function<javax.servlet.http.HttpServletRequest,String>	getDeriveContextNameSpacePrefix() An optional Function that converts super.request HttpServletRequest into a default context namespace, and prefixes it to any namespace specified.
String	getDynamic(String namespace, String name)
Function<String,C>	getInstanceFactory() For a namespace or null return an AbstractConfiguration type
protected String	getModuleName() If Service uses SiteAuthorizableSecurableService.getUserAuths(User) or SiteAuthorizableSecurableService.getCurrentUserAuths() then a module name is required to be supplied.
javax.ws.rs.core.Response	getProperty(String springId, String name)
ConfigurationService<String,String,C>	getService()
void	init()
protected javax.ws.rs.core.Response	searchProperty(String propertyName) Search all properties files for property
protected boolean	set(String namespace, String name, String value, Integer status)
void	setDeriveContextNameSpacePrefix(Function<javax.servlet.http.HttpServletRequest,String> deriveContextNameSpacePrefix) An optional Function that converts super.request HttpServletRequest into a default context namespace, and prefixes it to any namespace specified.
void	setInstanceFactory(Function<String,C> instanceFactory) For a namespace or null return an AbstractConfiguration type
void	setService(ConfigurationService<String,String,C> service)

Methods inherited from class com.neurosys.common.service.jaxrs.SiteAuthorizableSecurableService

adminCheck, getAuthorizableIdAssignable, getAuthorizableService, getAuthorizationModule, getCurrentUserAuths, getUser, getUserAuths, isAdmin, isUser, setAuthorizationModule

Methods inherited from class com.neurosys.amorphous.service.jaxrs.AuthorizableSecurableService

filter, getAuthorizableId, getAuthorizations, setAuthorizableId, setAuthorizations

Methods inherited from class com.neurosys.amorphous.service.jaxrs.SecurableService

checkAuthFilterInvoked, query

Methods inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

filter, getCacheDef, getTestString, query

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicConfigService

public DynamicConfigService()

DynamicConfigService

public DynamicConfigService(boolean checkAuthFiltered)

Method Detail

getContextNameSpaceConfig

protected <T> T getContextNameSpaceConfig(Function<String,Object> f)

Override, to override all Context based namespace derived config behavior.

Note: Context based namespace automation ONLY applies to get not to set or edit methods. In set and edit, one has to be specific.

Default Behavior
Re-Usable code across all methods for getting Config using deriveContextNameSpacePrefix.
The exact mechanism of deriving the Config is supplied via the param Function f, that accepts the contextNameSpace and returns the final config value for the context. (String or Response)>

Parameters:

f - as Function takes in String (context namsespace) and returns the same output as this function.

Returns:

T as String, Exception or Response. Nullable true, which means no context related config exists.

See Also:

adapter (For default behavior), (For default behavior)

getContextNameSpace

protected String getContextNameSpace(String contextNameSpacePrefix,
                                     String namespace)

get

@GET
 @Path(value="get/{namespace}/{name}")
 @Consumes(value="text/plain")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response get(@PathParam(value="namespace")
                                                                                                                                               String namespace,
                                                                                                                                               @PathParam(value="name")
                                                                                                                                               String name)
                                                                                                                                        throws Exception

Throws:

Exception

searchProperty

protected javax.ws.rs.core.Response searchProperty(String propertyName)
                                            throws Exception

Search all properties files for property

Parameters:

propertyName - as String

Returns:

String value

Throws:

Exception

Default value:

Searches through appConfiguration and then adminConfiguration

getDynamic

@GET
 @Path(value="get-dynamic/{namespace}/{name}")
 @Consumes(value="text/plain")
 @Produces(value="text/plain")
public String getDynamic(@PathParam(value="namespace")
                                                                                                                                           String namespace,
                                                                                                                                           @PathParam(value="name")
                                                                                                                                           String name)
                                                                                                                                    throws Exception

Throws:

Exception

getProperty

@GET
 @Path(value="get-property/{springId}/{name}")
 @Consumes(value="text/plain")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response getProperty(@PathParam(value="springId")
                                                                                                                                                               String springId,
                                                                                                                                                               @PathParam(value="name")
                                                                                                                                                               String name)
                                                                                                                                                        throws Exception

Throws:

Exception

get

@GET
 @Path(value="get/{namespace}")
 @Consumes(value="text/plain")
 @Produces(value="application/json")
public Map get(@PathParam(value="namespace")
                                                                                                                        String namespace)
                                                                                                                 throws Exception

Throws:

Exception

init

@PostConstruct
public void init()

set

protected boolean set(String namespace,
                      String name,
                      String value,
                      Integer status)
               throws Exception

Throws:

Exception

edit

@PUT
 @Path(value="admin/edit/{namespace}/{name}")
 @Consumes(value="text/plain")
 @Produces(value="text/plain")
public boolean edit(@PathParam(value="namespace")
                                                                                                                                     String namespace,
                                                                                                                                     @PathParam(value="name")
                                                                                                                                     String name,
                                                                                                                                     @QueryParam(value="value")
                                                                                                                                     String value,
                                                                                                                                     @QueryParam(value="status")
                                                                                                                                     Integer status)
                                                                                                                              throws Exception

Throws:

Exception

addEdit

@PUT
 @Path(value="admin/addEdit/{namespace}/{name}")
 @Consumes(value="text/plain")
public void addEdit(@PathParam(value="namespace")
                                                                                                         String namespace,
                                                                                                         @PathParam(value="name")
                                                                                                         String name,
                                                                                                         @QueryParam(value="value")
                                                                                                         String value)
                                                                                                  throws Exception

Throws:

Exception

delete

@DELETE
 @Path(value="admin/delete/{namespace}/{name}")
 @Consumes(value="text/plain")
 @Produces(value="text/plain")
public boolean delete(@PathParam(value="namespace")
                                                                                                                                            String namespace,
                                                                                                                                            @PathParam(value="name")
                                                                                                                                            String name)
                                                                                                                                     throws Exception

Throws:

Exception

clearCache

@PUT
 @Path(value="admin/clearcache/{namespace}")
 @Consumes(value="text/plain")
public void clearCache(@PathParam(value="namespace")
                                                                                                        String namespace)
                                                                                                 throws Exception

Throws:

Exception

getModuleName

protected String getModuleName()

If Service uses SiteAuthorizableSecurableService.getUserAuths(User) or SiteAuthorizableSecurableService.getCurrentUserAuths() then a module name is required to be supplied.

Overrides:

getModuleName in class SiteAuthorizableSecurableService

Returns:

String

getInstanceFactory

public Function<String,C> getInstanceFactory()

For a namespace or null return an AbstractConfiguration type

setInstanceFactory

public void setInstanceFactory(Function<String,C> instanceFactory)

For a namespace or null return an AbstractConfiguration type

getService

public ConfigurationService<String,String,C> getService()

setService

public void setService(ConfigurationService<String,String,C> service)

getDeriveContextNameSpacePrefix

public Function<javax.servlet.http.HttpServletRequest,String> getDeriveContextNameSpacePrefix()

An optional Function that converts super.request HttpServletRequest into a default context namespace, and prefixes it to any namespace specified. Effective namespace = <context_namespace>.<supplied_namespace>.
If the config exists for it (not null), it will fetch that or else it will default to the supplied one without the context namespace.

If the Function returns null; then it will skip and rely on the supplied default name.

Can be null:

true

setDeriveContextNameSpacePrefix

public void setDeriveContextNameSpacePrefix(Function<javax.servlet.http.HttpServletRequest,String> deriveContextNameSpacePrefix)

An optional Function that converts super.request HttpServletRequest into a default context namespace, and prefixes it to any namespace specified. Effective namespace = <context_namespace>.<supplied_namespace>.
If the config exists for it (not null), it will fetch that or else it will default to the supplied one without the context namespace.

If the Function returns null; then it will skip and rely on the supplied default name.

Can be null:

true