org.turro.elephant.context.Application Class Reference

Inheritance diagram for org.turro.elephant.context.Application:

Collaboration diagram for org.turro.elephant.context.Application:

Public Member Functions
	Application ()
ApplicationContext	getContext ()
boolean	hasAnyRoleKey (String role)
boolean	isInRole (String role)
boolean	isInRole (String role, String redirect) throws IOException
IContact	checkUser (boolean doLogin) throws IOException
Object	getPreference (String key)
void	putPreference (String key, Object value)
IConstructor	getConstructor ()
void	invalidateSession ()
HttpSession	getHttpSession (boolean create)
IImplementation	getImplementation (String name)
List	getImplementationNamesByType (String type)
abstract HttpServletRequest	getHttpServletRequest ()
abstract HttpServletResponse	getHttpServletResponse ()
abstract void	sendRedirect (String uri)
abstract void	navigateBack ()
String	getServerBase ()
String	getServerUrl ()

Static Public Member Functions
static Application	getApplication ()
static Application	getFromConstructor (IConstructor constructor)
static boolean	loadResources (String path)
static void	resetSettings ()
static void	resetSchemes ()
static IContact	getUser ()
static Cookie	getCookie (String name)
static String	getCookieValue (String name)
static void	setCookie (String name, String value, String path, int age)
static void	encryptCookie (String name, String value, String path, int age)
static String	decryptCookieValue (String name)
static void	deleteCookie (String name, String path)
static Locale	getUsedLocale ()
static Map	getStringMap ()
static Map	getStringMap (Locale locale, String configured)
static String	getString (String key)
static String	getString (String key, String locale)
static String	getString (String key, Locale locale)
static List< String >	getAllLocales (String key)
static ResourceBundle	getBundle (String bundle, Locale locale, String configured)
static HttpServletRequest	getResolverRequest ()
static HttpServletResponse	getResolverResponse ()
static HttpSession	getResolverSession (boolean create)

Static Public Attributes
static final String[]	BUNDLES
static final String	REGEXP_NO_RESOURCES = "(\\/zkau.*|\\/app.*)"

Protected Member Functions
abstract IConstructor	doConstructor ()

Protected Attributes
UserPreferences	preferences
HttpServletRequest	request
HttpServletResponse	response

Static Protected Attributes
static ThreadLocal< Application >	app = new ThreadLocal<>()

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 49 of file Application.java.

Constructor & Destructor Documentation

Application()

org.turro.elephant.context.Application.Application

(

)

Definition at line 120 of file Application.java.

                       {
    // move request and response here
    /*if(app.get() == null)*/ 
    if(!(this instanceof HeadlessApplication)) {
      app.set(this);
    }
  }

Here is the caller graph for this function:

Member Function Documentation

checkUser()

IContact org.turro.elephant.context.Application.checkUser

(

boolean

doLogin

)

throws IOException

Definition at line 168 of file Application.java.

                                                                {
    IConstructor constructor = getConstructor();
    IContact user = constructor.getUser();
    if(user == null && doLogin) {
      ElephantLogin.redirectToLogin(constructor);
    }
    return user;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

decryptCookieValue()

static String org.turro.elephant.context.Application.decryptCookieValue ( String  name )

static

Definition at line 271 of file Application.java.

                                                       {
    try {
      Cookie cookie = getCookie(name);
      if(cookie != null) {
        byte[] v = CookieUtil.decryptCookieValue(cookie);
        if(v != null) return new String(ElephantContext.decrypt(v));
      }
    } catch (Exception ex) {
      Logger.getLogger(Application.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteCookie()

static void org.turro.elephant.context.Application.deleteCookie ( String  name, String  path  )

static

Definition at line 284 of file Application.java.

                                                            {
    CookieUtil.deleteCookie(getApplication().getHttpServletResponse(), name, path);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

doConstructor()

abstract IConstructor org.turro.elephant.context.Application.doConstructor ( )

abstractprotected

Reimplemented in org.turro.elephant.context.HeadlessApplication, org.turro.elephant.context.ElephantApplication, and org.turro.elephant.zkoss.ZkossElephant.

Here is the caller graph for this function:

encryptCookie()

static void org.turro.elephant.context.Application.encryptCookie ( String  name, String  value, String  path, int  age  )

static

Definition at line 262 of file Application.java.

                                                                                    {
    try {
      byte[] b = ElephantContext.encrypt(value.getBytes());
      CookieUtil.encryptCookie(getApplication().getHttpServletResponse(), name, b, path, age);
    } catch (Exception ex) {
      Logger.getLogger(Application.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllLocales()

static List<String> org.turro.elephant.context.Application.getAllLocales ( String  key )

static

Definition at line 314 of file Application.java.

                                                       {
    return I_.compatibility().getInLocales(key);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getApplication()

static Application org.turro.elephant.context.Application.getApplication ( )

static

Definition at line 71 of file Application.java.

                                             {
    Application application = app.get();
    try {
      if(application == null) {
        HttpServletRequest request = getResolverRequest();
        if(request != null) {
          if(application == null) {
            application = (Application) request.getAttribute("el_app");
          }
          if(application == null) {
            application = new ElephantApplication(request, getResolverResponse());
            request.setAttribute("el_app", application);
          }
        }
      }
      if(application != null) {
        app.set(application);
        return application;
      } else {
        return HeadlessApplication.getInstance();
      }
    } catch(Exception ex) {
      return HeadlessApplication.getInstance();
    }    
  }

Here is the call graph for this function:

getBundle()

static ResourceBundle org.turro.elephant.context.Application.getBundle ( String  bundle, Locale  locale, String  configured  )

static

Definition at line 318 of file Application.java.

                                                                                          {
    return I_.compatibilityMap(locale).asBundle();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getConstructor()

IConstructor org.turro.elephant.context.Application.getConstructor

(

)

Reimplemented in org.turro.elephant.context.HeadlessApplication.

Definition at line 206 of file Application.java.

                                       {
    IConstructor elcons = null;
    if(getHttpServletRequest() != null) {
      elcons = (IConstructor) getHttpServletRequest().getAttribute("el_cons");
    }
    if(elcons == null) {
      elcons = doConstructor();
    }
    return elcons;
  }

Here is the call graph for this function:

getContext()

ApplicationContext org.turro.elephant.context.Application.getContext

(

)

Definition at line 128 of file Application.java.

                                         {
    return new ApplicationContext(
            getHttpServletRequest(),
            getHttpServletResponse());
  }

Here is the call graph for this function:

getCookie()

static Cookie org.turro.elephant.context.Application.getCookie ( String  name )

static

Definition at line 249 of file Application.java.

                                              {
    return CookieUtil.getCookie(getApplication().getHttpServletRequest(), name);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getCookieValue()

static String org.turro.elephant.context.Application.getCookieValue ( String  name )

static

Definition at line 253 of file Application.java.

                                                   {
    Cookie c = getCookie(name);
    return c != null ? c.getValue() : null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getFromConstructor()

static Application org.turro.elephant.context.Application.getFromConstructor ( IConstructor  constructor )

static

Definition at line 97 of file Application.java.

                                                                         {
    return (Application) constructor.getRequest().getAttribute("el_app");
  }

Here is the call graph for this function:

getHttpServletRequest()

abstract HttpServletRequest org.turro.elephant.context.Application.getHttpServletRequest ( )

abstract

Reimplemented in org.turro.elephant.context.HeadlessApplication, org.turro.elephant.context.ElephantApplication, and org.turro.elephant.zkoss.ZkossElephant.

Here is the caller graph for this function:

getHttpServletResponse()

abstract HttpServletResponse org.turro.elephant.context.Application.getHttpServletResponse ( )

abstract

Reimplemented in org.turro.elephant.context.HeadlessApplication, org.turro.elephant.context.ElephantApplication, and org.turro.elephant.zkoss.ZkossElephant.

Here is the caller graph for this function:

getHttpSession()

HttpSession org.turro.elephant.context.Application.getHttpSession

(

boolean

create

)

Reimplemented in org.turro.elephant.zkoss.ZkossElephant.

Definition at line 226 of file Application.java.

                                                    {
    if(getHttpServletRequest() != null) {
      return getHttpServletRequest().getSession(create);
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getImplementation()

IImplementation org.turro.elephant.context.Application.getImplementation

(

String

name

)

Definition at line 233 of file Application.java.

                                                        {
    return (IImplementation) ContextFactory.getImplementation(getConstructor(), name);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getImplementationNamesByType()

List org.turro.elephant.context.Application.getImplementationNamesByType

(

String

type

)

Definition at line 237 of file Application.java.

                                                        {
    return ContextFactory.getImplementationNamesByType(type);
  }

Here is the call graph for this function:

getPreference()

Object org.turro.elephant.context.Application.getPreference

(

String

key

)

Definition at line 177 of file Application.java.

                                          {
    try {
      IContact user = checkUser(false);
      if (user != null) {
        if (preferences == null || !preferences.isEqual(user.getId())) {
          preferences = UserPreferences.getInstance(user.getId());
        }
        return preferences.get(key);
      }
    } catch (IOException ex) {
      Logger.getLogger(Application.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getResolverRequest()

static HttpServletRequest org.turro.elephant.context.Application.getResolverRequest ( )

static

Definition at line 334 of file Application.java.

                                                        {
    for(ISessionResolver iSessionResolver : Instances.cached().byAnnotation(ElephantSessionResolver.class, ISessionResolver.class)) {
      HttpServletRequest request = iSessionResolver.getRequest();
      if(request != null) {
        return request;
      }
    }
    return null;
  }

Here is the caller graph for this function:

getResolverResponse()

static HttpServletResponse org.turro.elephant.context.Application.getResolverResponse ( )

static

Definition at line 344 of file Application.java.

                                                          {
    for(ISessionResolver iSessionResolver : Instances.cached().byAnnotation(ElephantSessionResolver.class, ISessionResolver.class)) {
      HttpServletResponse response = iSessionResolver.getResponse();
      if(response != null) {
        return response;
      }
    }
    return null;
  }

Here is the caller graph for this function:

getResolverSession()

static HttpSession org.turro.elephant.context.Application.getResolverSession ( boolean  create )

static

Definition at line 354 of file Application.java.

                                                               {
    for(ISessionResolver iSessionResolver : Instances.cached().byAnnotation(ElephantSessionResolver.class, ISessionResolver.class)) {
      HttpSession session = iSessionResolver.getSession(create);
      if(session != null) {
        return session;
      }
    }
    return null;
  }

Here is the caller graph for this function:

getServerBase()

String org.turro.elephant.context.Application.getServerBase

(

)

Definition at line 324 of file Application.java.

                                {
    return ElephantContext.getServerBase("http");
  }

Here is the call graph for this function:

getServerUrl()

String org.turro.elephant.context.Application.getServerUrl

(

)

Definition at line 328 of file Application.java.

                               {
    return ElephantContext.getServerUrl("http");
  }

Here is the call graph for this function:

getString() [1/3]

static String org.turro.elephant.context.Application.getString ( String  key )

static

Definition at line 302 of file Application.java.

                                             {
    return I_.compatibility().get(key);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getString() [2/3]

static String org.turro.elephant.context.Application.getString ( String  key, Locale  locale  )

static

Definition at line 310 of file Application.java.

                                                            {
    return I_.compatibility().get(locale, key);
  }

Here is the call graph for this function:

getString() [3/3]

static String org.turro.elephant.context.Application.getString ( String  key, String  locale  )

static

Definition at line 306 of file Application.java.

                                                            {
    return I_.compatibility().get(I18nLocales.createLocale(locale), key);
  }

Here is the call graph for this function:

getStringMap() [1/2]

static Map org.turro.elephant.context.Application.getStringMap ( )

static

Definition at line 294 of file Application.java.

                                   {
    return I_.compatibilityMap();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getStringMap() [2/2]

static Map org.turro.elephant.context.Application.getStringMap ( Locale  locale, String  configured  )

static

Definition at line 298 of file Application.java.

                                                                   {
    return I_.compatibilityMap(locale);
  }

Here is the call graph for this function:

getUsedLocale()

static Locale org.turro.elephant.context.Application.getUsedLocale ( )

static

Definition at line 290 of file Application.java.

                                       {
    return I_.api().used();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getUser()

static IContact org.turro.elephant.context.Application.getUser ( )

static

Definition at line 164 of file Application.java.

                                   {
    return getApplication().getConstructor().getUser();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

hasAnyRoleKey()

boolean org.turro.elephant.context.Application.hasAnyRoleKey

(

String

role

)

Definition at line 134 of file Application.java.

                                            {
    IConstructor constructor = getConstructor();
    return constructor.hasAnyRoleKey(role);
  }

Here is the call graph for this function:

invalidateSession()

void org.turro.elephant.context.Application.invalidateSession

(

)

Definition at line 217 of file Application.java.

                                  {
    // check why Application.get() request has no session
    try {
      getHttpSession(false).invalidate();
    } catch(Exception ex) {
      getResolverSession(true).invalidate();
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isInRole() [1/2]

boolean org.turro.elephant.context.Application.isInRole

(

String

role

)

Definition at line 139 of file Application.java.

                                       {
    try {
      return isInRole(role, null);
    } catch (IOException ex) {
      Logger.getLogger(Application.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    return false;
  }

Here is the call graph for this function:

isInRole() [2/2]

boolean org.turro.elephant.context.Application.isInRole	(	String	role,
		String	redirect
	)		throws IOException

Definition at line 148 of file Application.java.

                                                                           {
    IConstructor constructor = getConstructor();
    boolean result, isWebAdministering = constructor.isWebAdministering();
    if(!isWebAdministering) {
      constructor.setWebAdministering(true);
    }
    result = constructor.isInRole(role);
    if(!isWebAdministering) {
      constructor.setWebAdministering(false);
    }
    if(!result && redirect != null) {
      constructor.redirect(redirect);
    }
    return result;
  }

Here is the call graph for this function:

loadResources()

static boolean org.turro.elephant.context.Application.loadResources ( String  path )

static

Definition at line 101 of file Application.java.

                                                   {
    return !Strings.isBlank(path) && !path.matches(REGEXP_NO_RESOURCES);
  }

Here is the caller graph for this function:

navigateBack()

abstract void org.turro.elephant.context.Application.navigateBack ( )

abstract

Reimplemented in org.turro.elephant.context.HeadlessApplication, org.turro.elephant.context.ElephantApplication, and org.turro.elephant.zkoss.ZkossElephant.

Here is the caller graph for this function:

putPreference()

void org.turro.elephant.context.Application.putPreference	(	String	key,
		Object	value
	)

Definition at line 192 of file Application.java.

                                                      {
    try {
      IContact user = checkUser(false);
      if (user != null) {
        if (preferences == null || !preferences.isEqual(user.getId())) {
          preferences = UserPreferences.getInstance(user.getId());
        }
        preferences.put(key, value);
      }
    } catch (IOException ex) {
      Logger.getLogger(Application.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

resetSchemes()

static void org.turro.elephant.context.Application.resetSchemes ( )

static

Definition at line 116 of file Application.java.

                                    {
    ElephantContext.resetSchemes();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

resetSettings()

static void org.turro.elephant.context.Application.resetSettings ( )

static

Definition at line 105 of file Application.java.

                                     {
    SecurityGroups.reset();
    ContextFactory.resetImplementationsStartingWith("IMail");
    ElephantContext.resetSite();
    ElephantProperties.resetProperties();
    Labels.resetMaps();
    I_.resetMaps();
    ElContextMap.reset();
    SitemapGenerator.generateSitemap();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

sendRedirect()

abstract void org.turro.elephant.context.Application.sendRedirect ( String  uri )

abstract

Reimplemented in org.turro.elephant.context.HeadlessApplication, org.turro.elephant.context.ElephantApplication, and org.turro.elephant.zkoss.ZkossElephant.

Here is the caller graph for this function:

setCookie()

static void org.turro.elephant.context.Application.setCookie ( String  name, String  value, String  path, int  age  )

static

Definition at line 258 of file Application.java.

                                                                                {
    CookieUtil.setCookie(getApplication().getHttpServletResponse(), name, value, path, age);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

app

ThreadLocal<Application> org.turro.elephant.context.Application.app = new ThreadLocal<>()

staticprotected

Definition at line 65 of file Application.java.

BUNDLES

final String [] org.turro.elephant.context.Application.BUNDLES

static

Initial value:

= {
        "lang",
        "elephant",
        "labels",
        "documentation",
        "label-site"
  }

Definition at line 51 of file Application.java.

preferences

UserPreferences org.turro.elephant.context.Application.preferences

protected

Definition at line 67 of file Application.java.

REGEXP_NO_RESOURCES

final String org.turro.elephant.context.Application.REGEXP_NO_RESOURCES = "(\\/zkau.*|\\/app.*)"

static

Definition at line 58 of file Application.java.

request

HttpServletRequest org.turro.elephant.context.Application.request

protected

Definition at line 68 of file Application.java.

response

HttpServletResponse org.turro.elephant.context.Application.response

protected

Definition at line 69 of file Application.java.

---

The documentation for this class was generated from the following file:

• Application.java