box.system.plugins.concurrent.Callable interface"> Callable
Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES  

coldbox.system.plugins
Class CookieStorage

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by coldbox.system.plugins.CookieStorage

public class CookieStorage

extends Plugin

Cookie Storage plugin. It provides the user with a mechanism for permanent data storage using the cookie scope.

Constructor Summary
init(any controller)
          Constructor
 
Method Summary
private Any DecryptIt(string decValue)
          Return decrypted value
private Any EncryptIt(string encValue)
          Return encypted value
 boolean deleteVar(string name)
          Tries to delete a permanent cookie var
 boolean exists(string name)
          Checks wether the permanent variable exists
 boolean getEncryption()
          Get Encryption
 string getEncryptionAlgorithm()
          Get EncryptionAlgorithm
 string getEncryptionEncoding()
          Get EncryptionEncoding
 string getEncryptionKey()
          Get EncryptionKey
 any getVar(string name, [any default=''])
          Get a new permanent variable
 void setEncryption(boolean Encryption)
          Set Encryption
 void setEncryptionAlgorithm(string EncryptionAlgorithm)
          Set EncryptionAlgorithm
 void setEncryptionEncoding(string EncryptionEncoding)
          Set EncryptionEncoding
 void setEncryptionKey(string EncryptionKey)
          Set EncryptionKey
 void setVar(string name, any value, [numeric expires='0'], [boolean secure='false'], [string path=''], [string domain=''])
          Set a new permanent variable
 
Methods inherited from class coldbox.system.Plugin
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
 
Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)
Constructor.

Parameters:
controller - coldbox.system.web.Controller
Method Detail

DecryptIt

private Any DecryptIt(string decValue)
Return decrypted value

Parameters:
decValue - string to be decrypted

EncryptIt

private Any EncryptIt(string encValue)
Return encypted value

Parameters:
encValue - string to be encrypted

deleteVar

public boolean deleteVar(string name)
Tries to delete a permanent cookie var.

Parameters:
name - The variable name to retrieve.

exists

public boolean exists(string name)
Checks wether the permanent variable exists.

Parameters:
name - The variable name to retrieve.

getEncryption

public boolean getEncryption()
Get Encryption

getEncryptionAlgorithm

public string getEncryptionAlgorithm()
Get EncryptionAlgorithm

getEncryptionEncoding

public string getEncryptionEncoding()
Get EncryptionEncoding

getEncryptionKey

public string getEncryptionKey()
Get EncryptionKey

getVar

public any getVar(string name, [any default=''])
Get a new permanent variable. If the cookie does not exist. The method returns blank.

Parameters:
name - The variable name to retrieve.
default - The default value to set. If not used, a blank is returned.

setEncryption

public void setEncryption(boolean Encryption)
Set Encryption

Parameters:
Encryption

setEncryptionAlgorithm

public void setEncryptionAlgorithm(string EncryptionAlgorithm)
Set EncryptionAlgorithm

Parameters:
EncryptionAlgorithm

setEncryptionEncoding

public void setEncryptionEncoding(string EncryptionEncoding)
Set EncryptionEncoding

Parameters:
EncryptionEncoding

setEncryptionKey

public void setEncryptionKey(string EncryptionKey)
Set EncryptionKey

Parameters:
EncryptionKey

setVar

public void setVar(string name, any value, [numeric expires='0'], [boolean secure='false'], [string path=''], [string domain=''])
Set a new permanent variable.

Parameters:
name - The name of the variable.
value - The value to set in the variable, simple, array, query or structure.
expires - Cookie Expire in number of days. [default cookie is session only = 0 days]
secure - If browser does not support Secure Sockets Layer (SSL) security, the cookie is not sent. To use the cookie, the page must be accessed using the https protocol.
path - URL, within a domain, to which the cookie applies; typically a directory. Only pages in this path can use the cookie. By default, all pages on the server that set the cookie can access the cookie.
domain - Domain in which cookie is valid and to which cookie content can be sent from the user's system.
Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES