com.neurosys.lookup.service.jaxrs

Class UserLookupService

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.amorphous.service.jaxrs.SecurableService

com.neurosys.amorphous.service.jaxrs.AuthorizableSecurableService

com.neurosys.lookup.service.jaxrs.UserLookupService

All Implemented Interfaces:

Authorizable

@Path(value="/")
 @Consumes(value={"application/json","application/text","text/html","application/x-www-form-urlencoded"})
 @Produces(value="application/json;charset=utf-8")
 @Secured(value={"ROLE_USER","ROLE_ADMIN"})
public class UserLookupService
extends AuthorizableSecurableService

Web Service Layer to Query from a List of ConfigurationSource; namely following types of lookups applicable to the user:

• Cache Lookups
• Persisted/shared Config lookups
• Properties

Any configuration is defined by a name-space, key and its value. The user must be authorized to access the name-space & key combination to get the value. The web-service will resolve the type of Lookup based on the namespace or the sequence of the configured ConfigurationSource
Irrespective of the source by default the response is CACHED defined by AnyWebService.CACHE One can override getVal(ConfigurationSource, User, String, String) to determine how a ConfigurationSource is looked up.

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizationModule<Void>	authorizationModule

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

applicationContext, CACHE, NO_CACHE, request, response

Constructor Summary

Constructors

Constructor and Description
UserLookupService()
UserLookupService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
Boolean	getAuthorizableIdAssignable() Is the Authorizable.getAuthorizableId() of this instance to be considered in the global list of Authorizations. If true, it will appear in the List of Authorizations that can be assigned to users.
protected IAuthorizationService	getAuthorizableService() Define an AuthorizationService
AuthorizationModule<Void>	getAuthorizationModule()
List<ConfigurationSource>	getConfigurationSources() Will iteratively look for the requested configuration from the specified sources
protected User	getUser(javax.servlet.http.HttpServletRequest request) Get User for the current HttpServletRequest
protected Object	getVal(ConfigurationSource cs, User user, String namespace, String key)
javax.ws.rs.core.Response	lookup(String namespace, String key)
javax.ws.rs.core.Response	lookups(String configNamesJSONArray)
void	setAuthorizationModule(AuthorizationModule<Void> authorizationModule)
void	setConfigurationSources(List<ConfigurationSource> configurationSources) Will iteratively look for the requested configuration from the specified sources

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

Field Detail

authorizationModule

protected AuthorizationModule<Void> authorizationModule

Constructor Detail

UserLookupService

public UserLookupService()

UserLookupService

public UserLookupService(boolean checkAuthFiltered)

Method Detail

getAuthorizableIdAssignable

public Boolean getAuthorizableIdAssignable()

Description copied from interface: Authorizable

Is the Authorizable.getAuthorizableId() of this instance to be considered in the global list of Authorizations.
If true, it will appear in the List of Authorizations that can be assigned to users. Null is implementation dependent

Returns:

Boolean @Nullable

getAuthorizableService

protected IAuthorizationService getAuthorizableService()

Description copied from class: AuthorizableSecurableService

Define an AuthorizationService

Specified by:

getAuthorizableService in class AuthorizableSecurableService

getUser

protected User getUser(javax.servlet.http.HttpServletRequest request)

Description copied from class: AuthorizableSecurableService

Get User for the current HttpServletRequest

Specified by:

getUser in class AuthorizableSecurableService

Parameters:

request - as HttpServletRequest

Returns:

User

getVal

protected Object getVal(ConfigurationSource cs,
                        User user,
                        String namespace,
                        String key)

lookup

@GET
 @Path(value="lookup/{namespace}")
public javax.ws.rs.core.Response lookup(@PathParam(value="namespace")
                                                                                String namespace,
                                                                                @QueryParam(value="key")
                                                                                String key)
                                                                         throws Exception

Throws:

Exception

lookups

@POST
 @Path(value="lookups")
public javax.ws.rs.core.Response lookups(@QueryParam(value="configNamesJSONArray")
                                                                       String configNamesJSONArray)
                                                                throws Exception

Throws:

Exception

getAuthorizationModule

public AuthorizationModule<Void> getAuthorizationModule()

setAuthorizationModule

public void setAuthorizationModule(AuthorizationModule<Void> authorizationModule)

getConfigurationSources

public List<ConfigurationSource> getConfigurationSources()

Will iteratively look for the requested configuration from the specified sources

setConfigurationSources

public void setConfigurationSources(List<ConfigurationSource> configurationSources)

Will iteratively look for the requested configuration from the specified sources