railo.runtime.type.scope
Class CGIImpl

java.lang.Object
  extended by railo.runtime.type.util.StructSupport
      extended by railo.runtime.type.StructImpl
          extended by railo.runtime.type.ReadOnlyStruct
              extended by railo.runtime.type.scope.CGIImpl
All Implemented Interfaces:
Serializable, Cloneable, Map, Dumpable, Castable, Collection, Iteratorable, Scope, CGI, ScriptProtected, Sizeable, Struct

public final class CGIImpl
extends ReadOnlyStruct
implements CGI, ScriptProtected

To change the template for this generated type comment go to Window - Preferences - Java - Code Generation - Code and Comments

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
static Collection.Key AUTH_TYPE
           
static Collection.Key CF_TEMPLATE_PATH
           
static Collection.Key CONTEXT_PATH
           
static Collection.Key HTTP_IF_MODIFIED_SINCE
           
static Collection.Key LAST_MODIFIED
           
static Collection.Key LOCAL_ADDR
           
static Collection.Key LOCAL_HOST
           
static Collection.Key PATH_INFO
           
static Collection.Key PATH_TRANSLATED
           
static Collection.Key QUERY_STRING
           
static Collection.Key REDIRECT_QUERY_STRING
           
static Collection.Key REDIRECT_URL
           
static Collection.Key REMOTE_ADDR
           
static Collection.Key REMOTE_HOST
           
static Collection.Key REMOTE_USER
           
static Collection.Key REQUEST_METHOD
           
static Collection.Key REQUEST_URI
           
static Collection.Key SCRIPT_NAME
           
static Collection.Key SERVER_NAME
           
static Collection.Key SERVER_PORT
           
static Collection.Key SERVER_PORT_SECURE
           
static Collection.Key SERVER_PROTOCOL
           
 
Fields inherited from class railo.runtime.type.StructImpl
TYPE_SOFT
 
Fields inherited from interface railo.runtime.type.Scope
SCOPE_APPLICATION, SCOPE_ARGUMENTS, SCOPE_CALLER, SCOPE_CGI, SCOPE_CLIENT, SCOPE_CLUSTER, SCOPE_COOKIE, SCOPE_COUNT, SCOPE_FORM, SCOPE_LOCAL, SCOPE_REQUEST, SCOPE_SERVER, SCOPE_SESSION, SCOPE_UNDEFINED, SCOPE_URL, SCOPE_VARIABLES
 
Fields inherited from interface railo.runtime.type.Struct
TYPE_LINKED, TYPE_REGULAR, TYPE_SYNC, TYPE_WEAKED
 
Fields inherited from interface railo.runtime.type.scope.ScriptProtected
NO, UNDEFINED, YES
 
Constructor Summary
CGIImpl()
           
 
Method Summary
 boolean containsKey(Collection.Key key)
          contains this key
 boolean containsValue(Object value)
           
 Collection duplicate(boolean deepCopy)
           
 Object get(Collection.Key key)
          return a value from the collection
 Object get(Collection.Key key, Object defaultValue)
          return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null
static String getCurrentURL(javax.servlet.http.HttpServletRequest req)
           
static String getDomain(javax.servlet.http.HttpServletRequest req)
           
 int getType()
           
 String getTypeAsString()
           
 void initialize(PageContext pc)
          Initalize Scope
 boolean isInitalized()
          return if the scope is Initialiesd
 boolean isScriptProtected()
           
 Iterator keyIterator()
           
 Collection.Key[] keys()
           
 String[] keysAsString()
           
 void release()
          release scope for reuse
 void setScriptProtecting(boolean scriptProtecting)
          transform the string values of the scope do a script protecting way
 int size()
           
 DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
          method to print out information to a object as HTML
 
Methods inherited from class railo.runtime.type.ReadOnlyStruct
clear, remove, remove, removeAll, removeEL, set, setEL, setReadOnly
 
Methods inherited from class railo.runtime.type.StructImpl
copy, valueIterator, values
 
Methods inherited from class railo.runtime.type.util.StructSupport
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, clone, compareTo, compareTo, compareTo, compareTo, containsKey, containsKey, entrySet, equals, get, get, get, invalidKey, isEmpty, iterator, keySet, put, putAll, remove, set, setEL, sizeOf, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface railo.runtime.type.Collection
clear, clone, containsKey, get, get, remove, removeEL, set, set, setEL, setEL
 
Methods inherited from interface railo.runtime.type.Iteratorable
iterator, valueIterator
 
Methods inherited from interface railo.runtime.op.Castable
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo
 
Methods inherited from interface java.util.Map
clear, containsKey, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, values
 

Field Detail

SCRIPT_NAME

public static final Collection.Key SCRIPT_NAME

PATH_INFO

public static final Collection.Key PATH_INFO

HTTP_IF_MODIFIED_SINCE

public static final Collection.Key HTTP_IF_MODIFIED_SINCE

AUTH_TYPE

public static final Collection.Key AUTH_TYPE

CF_TEMPLATE_PATH

public static final Collection.Key CF_TEMPLATE_PATH

REMOTE_USER

public static final Collection.Key REMOTE_USER

REMOTE_ADDR

public static final Collection.Key REMOTE_ADDR

REMOTE_HOST

public static final Collection.Key REMOTE_HOST

REQUEST_METHOD

public static final Collection.Key REQUEST_METHOD

REQUEST_URI

public static final Collection.Key REQUEST_URI

REDIRECT_URL

public static final Collection.Key REDIRECT_URL

REDIRECT_QUERY_STRING

public static final Collection.Key REDIRECT_QUERY_STRING

LOCAL_ADDR

public static final Collection.Key LOCAL_ADDR

LOCAL_HOST

public static final Collection.Key LOCAL_HOST

SERVER_NAME

public static final Collection.Key SERVER_NAME

SERVER_PROTOCOL

public static final Collection.Key SERVER_PROTOCOL

SERVER_PORT

public static final Collection.Key SERVER_PORT

SERVER_PORT_SECURE

public static final Collection.Key SERVER_PORT_SECURE

PATH_TRANSLATED

public static final Collection.Key PATH_TRANSLATED

QUERY_STRING

public static final Collection.Key QUERY_STRING

CONTEXT_PATH

public static final Collection.Key CONTEXT_PATH

LAST_MODIFIED

public static final Collection.Key LAST_MODIFIED
Constructor Detail

CGIImpl

public CGIImpl()
Method Detail

containsKey

public boolean containsKey(Collection.Key key)
Description copied from interface: Collection
contains this key

Specified by:
containsKey in interface Collection
Overrides:
containsKey in class StructImpl
Returns:
returns if collection has a key with given name
See Also:
StructImpl.containsKey(railo.runtime.type.Collection.Key)

containsValue

public boolean containsValue(Object value)
Specified by:
containsValue in interface Map
Overrides:
containsValue in class StructImpl
See Also:
StructImpl.containsValue(java.lang.Object)

duplicate

public Collection duplicate(boolean deepCopy)
Specified by:
duplicate in interface Collection
Overrides:
duplicate in class ReadOnlyStruct
See Also:
StructImpl.duplicate(boolean)

size

public int size()
Specified by:
size in interface Map
Specified by:
size in interface Collection
Overrides:
size in class StructImpl
Returns:
the size of the collection
See Also:
Collection.size()

keysAsString

public String[] keysAsString()
Specified by:
keysAsString in interface Collection
Overrides:
keysAsString in class StructImpl
Returns:
returns a string array of all keys in the collection
See Also:
Collection.keysAsString()

keys

public Collection.Key[] keys()
Specified by:
keys in interface Collection
Overrides:
keys in class StructImpl
Returns:
returns a string array of all keys in the collection

get

public Object get(Collection.Key key,
                  Object defaultValue)
Description copied from interface: Collection
return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null

Specified by:
get in interface Collection
Overrides:
get in class StructImpl
Parameters:
key - key of the value to get
Returns:
value on key position or null
See Also:
StructImpl.get(railo.runtime.type.Collection.Key, java.lang.Object)

get

public Object get(Collection.Key key)
Description copied from interface: Collection
return a value from the collection

Specified by:
get in interface Collection
Overrides:
get in class StructImpl
Parameters:
key - key of the value to get must be lower case
Returns:
value on key position
See Also:
StructImpl.get(railo.runtime.type.Collection.Key)

keyIterator

public Iterator keyIterator()
Specified by:
keyIterator in interface Iteratorable
Overrides:
keyIterator in class StructImpl
Returns:
return a Iterator for Keys as String
See Also:
Iteratorable.keyIterator()

isInitalized

public boolean isInitalized()
Description copied from interface: Scope
return if the scope is Initialiesd

Specified by:
isInitalized in interface Scope
Returns:
scope is init
See Also:
Scope.isInitalized()

initialize

public void initialize(PageContext pc)
Description copied from interface: Scope
Initalize Scope

Specified by:
initialize in interface Scope
Parameters:
pc - Page Context
See Also:
Scope.initialize(railo.runtime.PageContext)

release

public void release()
Description copied from interface: Scope
release scope for reuse

Specified by:
release in interface Scope
See Also:
Scope.release()

toDumpData

public DumpData toDumpData(PageContext pageContext,
                           int maxlevel,
                           DumpProperties dp)
Description copied from interface: Dumpable
method to print out information to a object as HTML

Specified by:
toDumpData in interface Dumpable
Overrides:
toDumpData in class StructSupport
Returns:
HTML print out
See Also:
railo.runtime.dump.Dumpable#toDumpData(railo.runtime.PageContext, int)

getType

public int getType()
Specified by:
getType in interface Scope
Returns:
return the scope type (SCOPE_SERVER, SCOPE_SESSION usw.)
See Also:
Scope.getType()

getTypeAsString

public String getTypeAsString()
Specified by:
getTypeAsString in interface Scope
Returns:
return the scope type as a String (server,session usw.)
See Also:
Scope.getTypeAsString()

isScriptProtected

public boolean isScriptProtected()
Specified by:
isScriptProtected in interface ScriptProtected
Returns:
returns if the values of the scope are already protected against cross site scripting

setScriptProtecting

public void setScriptProtecting(boolean scriptProtecting)
Description copied from interface: ScriptProtected
transform the string values of the scope do a script protecting way

Specified by:
setScriptProtecting in interface ScriptProtected

getCurrentURL

public static String getCurrentURL(javax.servlet.http.HttpServletRequest req)

getDomain

public static String getDomain(javax.servlet.http.HttpServletRequest req)


Copyright © 2012 Railo