org.turro.elephant.context.ElephantContext Class Reference

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

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

Public Member Functions
	ElephantContext ()
void	contextDestroyed (ServletContextEvent event)
void	contextInitialized (ServletContextEvent event)

Static Public Member Functions
static Jsons	siteInfo ()
static ServletContext	getCurrent ()
static IConstructor	createConstructor ()
static List< String >	getMetas ()
static String	removeWebContext (String path)
static String	getRealPath (String path)
static String	getRelativePath (String path)
static String	getContextVariable (IConstructor constructor)
static String	getRootWebPath ()
static String	getRootResourcePath ()
static Object	getAttribute (String key)
static void	setAttribute (String key, Object value)
static void	removeAttribute (String key)
static String	getSiteName ()
static String	getSiteForcedDomain ()
static String	getSiteDescription ()
static String	getSiteKeywords ()
static String	getSiteFonts ()
static String	getSiteIcon ()
static String	getSiteWelcome ()
static String	getSiteInternalFiles ()
static String	getEncoding ()
static String	getContextLoad ()
static String	getSiteLocales ()
static boolean	isValidLocale (Locale locale)
static String	getSiteSignin ()
static String	getSiteSyndicate ()
static String	getDirectoryQualification ()
static String	getTemplatesRoot ()
static boolean	getUseSSL ()
static boolean	getUseSSO ()
static boolean	getLiveLinks ()
static Locale	getContactLocale ()
static Currency	getContactCurrency ()
static boolean	hasSignup ()
static String	getServerBase (String scheme)
static String	getServerUrl (String scheme)
static URI	toUri (String localPath) throws URISyntaxException
static byte[]	encrypt (byte[] value)
static byte[]	decrypt (byte[] value)
static String	encrypt (String value)
static String	decrypt (String value)
static File	file (String path)
static String	logMsg (String msg)
static void	resetSite ()
static void	resetSchemes ()
static void	initServerSchemas (HttpServletRequest request)
static String	getEntityWebContext (String path)
static String	getEntityWebContext (Path path)
static IConstructor	getConstructor (HttpServletRequest request, HttpServletResponse response)

Detailed Description

Author

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

Definition at line 59 of file ElephantContext.java.

Constructor & Destructor Documentation

ElephantContext()

org.turro.elephant.context.ElephantContext.ElephantContext

(

)

Definition at line 67 of file ElephantContext.java.

                           {
  }

Member Function Documentation

contextDestroyed()

void org.turro.elephant.context.ElephantContext.contextDestroyed

(

ServletContextEvent

event

)

Definition at line 71 of file ElephantContext.java.

                                                            {
        _context = null;
    }

contextInitialized()

void org.turro.elephant.context.ElephantContext.contextInitialized

(

ServletContextEvent

event

)

Definition at line 76 of file ElephantContext.java.

                                                              {
        _context = event.getServletContext();
    loadSiteConfiguration();
    Configurator.init(ElephantContext.getRealPath("/WEB-INF/elephant/conf/configurator/context.json"));
    }

Here is the call graph for this function:

createConstructor()

static IConstructor org.turro.elephant.context.ElephantContext.createConstructor ( )

static

Definition at line 99 of file ElephantContext.java.

                                                 {
    return ElephantContext.getConstructor(null, null);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

decrypt() [1/2]

static byte [] org.turro.elephant.context.ElephantContext.decrypt ( byte[]  value )

static

Definition at line 269 of file ElephantContext.java.

                                             {
    return (value != null && ((value.length % 8) == 0)) ? 
            Cipher.symetricDecrypt(value) : null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

decrypt() [2/2]

static String org.turro.elephant.context.ElephantContext.decrypt ( String  value )

static

Definition at line 279 of file ElephantContext.java.

                                             {
    if(!Strings.isBlank(value)) {
      byte[] bytes = decrypt(new Base64().decode(value.getBytes()));
      return bytes != null ? new String(bytes) : "";
    }
    return null;
  }

Here is the call graph for this function:

encrypt() [1/2]

static byte [] org.turro.elephant.context.ElephantContext.encrypt ( byte[]  value )

static

Definition at line 265 of file ElephantContext.java.

                                             {
    return Cipher.symetricEncrypt(value);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

encrypt() [2/2]

static String org.turro.elephant.context.ElephantContext.encrypt ( String  value )

static

Definition at line 274 of file ElephantContext.java.

                                             {
    return !Strings.isBlank(value) ? new String(
            new Base64().encode(encrypt(value.getBytes()))) : "";
  }

Here is the call graph for this function:

file()

static File org.turro.elephant.context.ElephantContext.file ( String  path )

static

Definition at line 287 of file ElephantContext.java.

                                       {
    return new File(getRealPath(path));
  }

Here is the call graph for this function:

getAttribute()

static Object org.turro.elephant.context.ElephantContext.getAttribute ( String  key )

static

Definition at line 145 of file ElephantContext.java.

                                                {
    return _context.getAttribute(key);
  }

Here is the caller graph for this function:

getConstructor()

static IConstructor org.turro.elephant.context.ElephantContext.getConstructor ( HttpServletRequest  request, HttpServletResponse  response  )

static

Definition at line 563 of file ElephantContext.java.

                                                                                                      {
    IConstructor impl = CollectionUtil.from(Instances.fresh().byAnnotation(ElephantConstructor.class, IConstructor.class)).first();
    if(impl != null) {
      impl.setRequest(request);
      impl.setResponse(response);
    }
    return impl;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getContactCurrency()

static Currency org.turro.elephant.context.ElephantContext.getContactCurrency ( )

static

Definition at line 237 of file ElephantContext.java.

                                              {
    return Currency.getInstance((String) getAttribute("contact_currency"));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getContactLocale()

static Locale org.turro.elephant.context.ElephantContext.getContactLocale ( )

static

Definition at line 233 of file ElephantContext.java.

                                          {
    return new Locale((String) getAttribute("contact_language"), (String) getAttribute("contact_country"));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getContextLoad()

static String org.turro.elephant.context.ElephantContext.getContextLoad ( )

static

Definition at line 193 of file ElephantContext.java.

                                        {
    return (String) getAttribute("site_context-load");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getContextVariable()

static String org.turro.elephant.context.ElephantContext.getContextVariable ( IConstructor  constructor )

static

Definition at line 133 of file ElephantContext.java.

                                                                    {
    return constructor.getCurrentContext().getPath();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrent()

static ServletContext org.turro.elephant.context.ElephantContext.getCurrent ( )

static

Definition at line 95 of file ElephantContext.java.

                                            {
    return _context;
  }

Here is the caller graph for this function:

getDirectoryQualification()

static String org.turro.elephant.context.ElephantContext.getDirectoryQualification ( )

static

Definition at line 213 of file ElephantContext.java.

                                                   {
    return (String) getAttribute("site_directory-qualification");
  }

Here is the call graph for this function:

getEncoding()

static String org.turro.elephant.context.ElephantContext.getEncoding ( )

static

Definition at line 189 of file ElephantContext.java.

                                     {
    return (String) getAttribute("site_encoding");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getEntityWebContext() [1/2]

static String org.turro.elephant.context.ElephantContext.getEntityWebContext ( Path  path )

static

Definition at line 412 of file ElephantContext.java.

                                                      {
    return ElephantProperties.getContextProperty(ENTITY_WEB_CONTEXT, path.getRoot());
  }

Here is the call graph for this function:

getEntityWebContext() [2/2]

static String org.turro.elephant.context.ElephantContext.getEntityWebContext ( String  path )

static

Parameters

path	Entity path. Allows multiple path separated by comma. The first path have preference, and so on. The method returns when a web path value is encountered on null if none.

Returns

The web path for the entity, by input priority.

Definition at line 401 of file ElephantContext.java.

                                                        {
    String[] paths = path.split(",");
    for(String p : paths) {
      String ep = getEntityWebContext(new Path(p));
      if(!Strings.isBlank(ep)) {
        return ep;
      }
    }
    return null;
  }

Here is the caller graph for this function:

getLiveLinks()

static boolean org.turro.elephant.context.ElephantContext.getLiveLinks ( )

static

Definition at line 229 of file ElephantContext.java.

                                       {
    return "true".equals((String) getAttribute("site_live-links"));
  }

Here is the call graph for this function:

getMetas()

static List<String> org.turro.elephant.context.ElephantContext.getMetas ( )

static

Definition at line 103 of file ElephantContext.java.

                                        {
    return _metas;
  }

Here is the caller graph for this function:

getRealPath()

static String org.turro.elephant.context.ElephantContext.getRealPath ( String  path )

static

Definition at line 115 of file ElephantContext.java.

                                                {
    String real = getCurrent().getRealPath(path);
    if(real != null) {
      real = real.replaceAll("\\\\", "/");
      if(real.endsWith("/"))
        real = real.substring(0, real.length() - 1);
    }
    return real;
  }

Here is the call graph for this function:

getRelativePath()

static String org.turro.elephant.context.ElephantContext.getRelativePath ( String  path )

static

Definition at line 125 of file ElephantContext.java.

                                                    {
    String remove = getRealPath("/");
    if(path.startsWith(remove)) {
      return path.substring(remove.length());
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getRootResourcePath()

static String org.turro.elephant.context.ElephantContext.getRootResourcePath ( )

static

Definition at line 141 of file ElephantContext.java.

                                             {
    return getRootWebPath();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getRootWebPath()

static String org.turro.elephant.context.ElephantContext.getRootWebPath ( )

static

Definition at line 137 of file ElephantContext.java.

                                        {
    return _context.getContextPath();
  }

getServerBase()

static String org.turro.elephant.context.ElephantContext.getServerBase ( String  scheme )

static

Definition at line 246 of file ElephantContext.java.

                                                    {
    if(scheme.equals("http") && getUseSSL()) {
      scheme = "https";
    }
    String server = schemes.get(scheme);
    if(server == null) {
      server = scheme + "://" + getSiteForcedDomain();
    }
    return server;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getServerUrl()

static String org.turro.elephant.context.ElephantContext.getServerUrl ( String  scheme )

static

Definition at line 257 of file ElephantContext.java.

                                                   {
    return getServerBase(scheme) + getRootWebPath();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteDescription()

static String org.turro.elephant.context.ElephantContext.getSiteDescription ( )

static

Definition at line 165 of file ElephantContext.java.

                                            {
    return (String) getAttribute("site_description");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteFonts()

static String org.turro.elephant.context.ElephantContext.getSiteFonts ( )

static

Definition at line 173 of file ElephantContext.java.

                                      {
    return (String) getAttribute("site_fonts");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteForcedDomain()

static String org.turro.elephant.context.ElephantContext.getSiteForcedDomain ( )

static

Definition at line 161 of file ElephantContext.java.

                                             {
    return (String) getAttribute("site_forced-domain");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteIcon()

static String org.turro.elephant.context.ElephantContext.getSiteIcon ( )

static

Definition at line 177 of file ElephantContext.java.

                                     {
    return (String) getAttribute("site_icon");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteInternalFiles()

static String org.turro.elephant.context.ElephantContext.getSiteInternalFiles ( )

static

Definition at line 185 of file ElephantContext.java.

                                              {
    return (String) getAttribute("site-files");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteKeywords()

static String org.turro.elephant.context.ElephantContext.getSiteKeywords ( )

static

Definition at line 169 of file ElephantContext.java.

                                         {
    return (String) getAttribute("site_keywords");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteLocales()

static String org.turro.elephant.context.ElephantContext.getSiteLocales ( )

static

Definition at line 197 of file ElephantContext.java.

                                        {
    return (String) getAttribute("site_locales");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteName()

static String org.turro.elephant.context.ElephantContext.getSiteName ( )

static

Definition at line 157 of file ElephantContext.java.

                                     {
    return (String) getAttribute("site_name");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteSignin()

static String org.turro.elephant.context.ElephantContext.getSiteSignin ( )

static

Definition at line 205 of file ElephantContext.java.

                                       {
    return (String) getAttribute("site_signin");
  }

Here is the call graph for this function:

getSiteSyndicate()

static String org.turro.elephant.context.ElephantContext.getSiteSyndicate ( )

static

Definition at line 209 of file ElephantContext.java.

                                          {
    return (String) getAttribute("site_syndicate");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSiteWelcome()

static String org.turro.elephant.context.ElephantContext.getSiteWelcome ( )

static

Definition at line 181 of file ElephantContext.java.

                                        {
    return (String) getAttribute("site_welcome");
  }

Here is the call graph for this function:

getTemplatesRoot()

static String org.turro.elephant.context.ElephantContext.getTemplatesRoot ( )

static

Definition at line 217 of file ElephantContext.java.

                                          {
    return (String) getAttribute("site_templatesRoot");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getUseSSL()

static boolean org.turro.elephant.context.ElephantContext.getUseSSL ( )

static

Definition at line 221 of file ElephantContext.java.

                                    {
    return "true".equals((String) getAttribute("site_use-ssl"));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getUseSSO()

static boolean org.turro.elephant.context.ElephantContext.getUseSSO ( )

static

Definition at line 225 of file ElephantContext.java.

                                    {
    return "true".equals((String) getAttribute("site_use-sso"));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

hasSignup()

static boolean org.turro.elephant.context.ElephantContext.hasSignup ( )

static

Definition at line 241 of file ElephantContext.java.

                                    {
    return Folder.from(ElephantContext.getRealPath("/user/signup")).exists() &&
           "true".equals((String) getAttribute("site_has_signup"));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

initServerSchemas()

static void org.turro.elephant.context.ElephantContext.initServerSchemas ( HttpServletRequest  request )

static

Definition at line 370 of file ElephantContext.java.

                                                                   {
    if(!schemes.containsKey(request.getScheme())) {
      schemes.put(request.getScheme(), request.getScheme() + "://" +
              request.getServerName() + getServerPort(request));
    }
  }

Here is the caller graph for this function:

isValidLocale()

static boolean org.turro.elephant.context.ElephantContext.isValidLocale ( Locale  locale )

static

Definition at line 201 of file ElephantContext.java.

                                                     {
    return getSiteLocales().contains(locale.getLanguage());
  }

Here is the call graph for this function:

logMsg()

static String org.turro.elephant.context.ElephantContext.logMsg ( String  msg )

static

Definition at line 291 of file ElephantContext.java.

                                          {
    return "[" + getSiteName() + "]" + (Strings.isBlank(msg) ? "" : ": " + msg); 
  }

Here is the call graph for this function:

removeAttribute()

static void org.turro.elephant.context.ElephantContext.removeAttribute ( String  key )

static

Definition at line 153 of file ElephantContext.java.

                                                 {
    _context.removeAttribute(key);
  }

Here is the caller graph for this function:

removeWebContext()

static String org.turro.elephant.context.ElephantContext.removeWebContext ( String  path )

static

Definition at line 107 of file ElephantContext.java.

                                                     {
    String remove = getRootWebPath();
    if(!Strings.isBlank(remove) && path.startsWith(remove)) {
      return path.substring(remove.length());
    }
    return path;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

resetSchemes()

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

static

Definition at line 299 of file ElephantContext.java.

                                    {
    schemes.clear();
  }

Here is the caller graph for this function:

resetSite()

static void org.turro.elephant.context.ElephantContext.resetSite ( )

static

Definition at line 295 of file ElephantContext.java.

                                 {
    loadSiteConfiguration();
  }

Here is the caller graph for this function:

setAttribute()

static void org.turro.elephant.context.ElephantContext.setAttribute ( String  key, Object  value  )

static

Definition at line 149 of file ElephantContext.java.

                                                            {
    _context.setAttribute(key, value);
  }

Here is the caller graph for this function:

siteInfo()

static Jsons org.turro.elephant.context.ElephantContext.siteInfo ( )

static

Definition at line 84 of file ElephantContext.java.

                                 {
    return Jsons.object()
            .add("name", ElephantContext.getSiteName())
            .add("description", ElephantContext.getSiteDescription())
            .add("icon", ElephantContext.getServerBase("http") + ElephantContext.getSiteIcon())
            .add("url", ElephantContext.getServerUrl("http"))
            .add("locales", ElephantContext.getSiteLocales());
  }

Here is the call graph for this function:

toUri()

static URI org.turro.elephant.context.ElephantContext.toUri ( String  localPath ) throws URISyntaxException

static

Definition at line 261 of file ElephantContext.java.

                                                                      {
    return new URI(getServerBase("http") + getRootWebPath() + localPath);
  }

Here is the call graph for this function:

---

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

• ElephantContext.java