| /config/accessLogging |
boolean |
Enables/Disables access logging. When enabled, an access log similar to Apache's access log will be written
to the logs directory. |
Read/write |
| /config/accessLoggingCustomClass |
String |
Enables/Disables custom access logger if accesslogging is enabled. Should implement
zero.core.cfadapter.AccessLogger interface |
Read-Only |
| /config/accessLoggingCustomClassFormatString |
String |
Format string that is custom class specific. Not all custom classes need / support format String. |
Read-Only |
| /config/apacheRouteID |
String |
This routeID is appended to the zsessionid to make it compatible with apache/mod_proxy, enabling session
affinity with the Apache webserver. |
Read-only |
| /config/appLogDir |
|
location of the logs directory for both the app and the instance.
These maybe have the same value if there is no instance id |
|
| /config/compressResponse |
|
Indicates if the response should be compressed if accept-encoding is compress or gzip default is enabled |
|
| /config/connection/defaults |
Object |
Default protocol configuration parameter values for the Connection API. |
Read-only |
| /config/connection/destinations |
List<Map<String, Object>> |
Configured destinations for the Connection API. |
Read-only |
| /config/connection/https |
Map<String, Object> |
Outbound HTTPS configurations for the Connection API. |
Read-only |
| /config/connection/protocols |
Map<String, Object> |
Explicitly registered protocol definition for use with the Connection API. For use by connection
protocol implementations. |
Read-only |
| /config/connection/smtps |
Map<String, Object> |
SMTPS configurations for the Connection API. |
Read-only |
| /config/contextRoot |
String |
The optional application context root uniquely identifies the application. An empty string indicates no
context root; otherwise, it starts with a slash. The context root must only contain legal URI characters.
If the context root (from the client perspective) is to contain nonlegal URI characters, then they should be
encoded in the configuration of the application.
For example, for the application to have a context root of "my app", and the user to enter
"http://localhost:8080/my app/index.html in a browser, than the value in stored in config should be
"my%20app" |
Read-only |
| /config/createDumpOnErrantRequest |
Boolean |
Forces a JVM dump to be created if there are any errant requests during a recycle or stop. If a request does
not complete within the alloted stop time, it is considered errant. This allows those requests to be
corrected, as an errant request can cause significant issues with the application recycle pattern. |
Read-only |
| /config/defaultContentType |
String |
The default response content type. The default is "text/html;charset=UTF-8". |
Read-only |
| /config/dependencies |
List |
List of the dependencies by name, with the dependency's
root directories as the value.
For example, /config/dependencies/foo contains the root
directory for dependency "foo". |
Read-only |
| /config/exitCode |
Integer |
Optional The termination status code set by config event handlers.
If set, then the application exits. |
Read/write for "config" handlers. |
| /config/externalUriPrefix |
String |
The optional external URI prefix. If defined, it replaces the scheme, host and port when calculating absolute
URIs. |
Read-only |
| /config/fileserver/contentNegotiation |
boolean |
Indicates whether static file serving should attempt content negotiation when handling requests for
static resources. The default value is false. If enabled and the request does not match to a
resource in the virtualized path, the file serving runtime will leverage the Accept-Language header and
search for the best match resource in the format of <resource>.<extension>.<language>.
For instance, index.html.en would be a valid resource for content negotiation if the client contained an
Accept-Language value of en and the requested resource was index.html. |
Read/write |
| /config/fileserver/defaultExtensions |
List<String> |
The list of file extensions for default file serving, in search order. The default is
[.groovy, .gt, .html]. |
Read/write |
| /config/fileserver/defaultLanguage |
String |
Default language used during content negotiation for static resources. The default language to be added
as the file extension when the language (i.e. en, ja, de, etc.) included in the Accept-Language header is
not available. The default value is the language property of the default locale of the server. |
Read/write |
| /config/fileserver/directoryBrowsing |
Boolean |
Indicates whether directory browsing is enabled. The default is false. |
Read/write |
| /config/fileserver/directoryView |
String |
Reference to view template/script file used for displaying directories when directory browsing is
enabled. (relative to app/views) |
Read/write |
| /config/fileserver/expires |
Long |
The time, in seconds, that a client should cache static files. It is set in a Cache-Control header. By
default, static files are sent with a max-age of 300 seconds. The caching time can be overridden for
individual extensions by setting:
/config/fileserver/expires/.extension
|
Read/write |
| /config/fileserver/setEtag |
Boolean |
Indicates whether the Etag header is set on outgoing static file headers. The default is
true. |
Read/write |
| /config/http/ipAddress |
String |
The ip address to which HTTP should bind. |
Read-only |
| /config/http/keepAliveTimeout |
Integer |
The TCP/IP keep alive timeout that should be used with new incoming connections. The default is 4
seconds. |
Read-only |
| /config/http/port |
Long |
The HTTP port associated with this application. |
Read-only |
| /config/http/readTimeout |
Integer |
The timeout for reads that should be used for incoming connections be for considering the request in
error. The default is 300 seconds. |
Read-only |
| /config/https/ipAddress |
String |
The ip address to which HTTPS should bind. |
Read-only |
| /config/https/port |
Long |
The HTTPS port associated with this application. |
Read-only |
| /config/https/sslconfig#clientAuthentication |
boolean |
Whether the client's SSL certificate should be validated against trust authorities for access.
Defaults to false . |
Read-only |
| /config/https/sslconfig#keyStore |
String |
The location of the keystore file. |
Read-only |
| /config/https/sslconfig#keyStorePassword |
String |
The password to access the keystore file. |
Read-only |
| /config/https/sslconfig#keyStoreType |
String |
The encryption type of the keystore file. Allowed types are dependent on the JSSE implementation of
the runtime. |
Read-only |
| /config/https/sslconfig#trustStore |
String |
The location of the truststore file. If a truststore is not defined, the keystore file will be used
for both. |
Read-only |
| /config/https/sslconfig#trustStorePassword |
String |
The password to access the truststore file. |
Read-only |
| /config/https/sslconfig#trustStoreType |
String |
The encryption type of the truststore file. Allowed types are dependent on the JSSE implementation of
the runtime. |
Read-only |
| /config/id |
String |
The current process id. |
Read-only |
| /config/instanceLogDir |
|
|
|
| /config/instanceNumber |
|
|
|
| /config/json/converters |
Map <String, String> |
Map of class name/converter pairs that are invoked when serializing
from/parsing to an instance of the specified class. Key=class name; value=converter implementation class. |
Read-only |
| /config/json/prettyPrint |
Boolean |
Displays the JSON in a more human readable format. |
Read-only |
| /config/json/stringFilters |
String |
The implementation class name which handles special filtering of content that may be
embedded in the JSON string. |
Read-only |
| /config/maxLockWait |
Integer |
The maximum time in seconds that Filelocks should wait
before aborting operation. |
Read-only |
| /config/maxStopTime |
Integer |
The maximum time that any single request is allowed after a stop or recycle
request is issued. After this timeout is reached, the request will be
forcibly stopped. Value is in seconds. |
Read-only |
| /config/maxThreads |
Integer |
The maximum size of the thread pool used to serve HTTP and HTTPS requests. The default value is 50. |
Read-only |
| /config/mimeTypes |
Map <String, String> |
Map that maps extensions -> content-Type headers
This map overrides the default map |
Read-only |
| /config/minThreads |
Integer |
The minimum size of the thread pool used to serve HTTP and HTTPS requests. The default value is 1. |
Read-only |
| /config/name |
String |
The name of this application. |
Read-only |
| /config/properties |
|
|
|
| /config/requestLogging |
boolean |
Enables/Disables request logging. Request logging creates files for each request containing the exact request
and response. This should only be enabled in development systems. |
Read/write |
| /config/requestLoggingLimit |
Integer |
The per request logging limit for the input/output streams. If the limits are reached the request log is
truncated. Value in bytes. |
Read/write |
| /config/resources/defaultExtensions |
List<String> |
A list of file extensions for resource handlers, in search order. The default is [.groovy]. |
Read/write |
| /config/root |
String |
The root directory of the application. |
Read-only |
| /config/runtime/bootstrapClasspath |
String |
The bootstrap classpath used by the application as determined during the resolve process |
Read-only |
| /config/runtime/classpath |
String |
The classpath used by the application as determined during the resolve process |
Read-only |
| /config/runtime/mode |
String |
Adjusts the behavior of the runtime depending on the current deployment environment. Valid values are
production and development. |
Read-only |
| /config/runtime/natives |
String |
The path for native dependencies as determined during the resolve process. |
Read-only |
| /config/security/cacheControl |
List |
The default Cache-Control header for all secured resources and their associated login forms (OpenID,
Form-based Login, Single Sign-On) that are provided as part of WebSphere sMash The default Cache-Control
header value is ["must-revalidate","max-age=0","private"] |
Read-only |
| /config/security/formLoginPage |
String |
The uri location of the form login page for form based authentication |
Read-only |
| /config/security/jaas/callbackHandler |
String |
The JAAS callback handler implementation class used for verifying the credentials of the user. |
Read-only |
| /config/security/jaas/configName |
String |
The name of the list of maps representing JAAS login modules to be used by the security runtime |
Read-only |
| /config/security/jaas/loginModules |
List<Map> |
The List containing a map of login modules associated with a specified config name.
/config/security/jaas/loginModules/configName
|
Read-only |
| /config/security/realm |
String |
The realm value returned when a WWW-Authenticate response header is sent to the client. Default value is
based upon the authType specified for the security rule |
Read-only |
| /config/security/roles |
List |
A list of users and/or groups associated with a particular role.
/config/security/roles/role/USERS or /config/security/roles/role/GROUPS |
Read-only |
| /config/security/secretKey |
String |
The secret key used to generate encrypted values related to security. Currently leveraged by SimpleToken
and CrossSiteRequestForgery (CSRF) tokens |
Read-only |
| /config/security/ssoURL |
String |
The uri location of the sso login page for Single Sign-On based authentication |
Read-only |
| /config/security/token/csrfGlobalPostLoginFallback |
String |
Fallback URI when CSRF protection is enabled. After successful login, user will be redirected to this
uri. Default is "/" |
Read-only |
| /config/security/token/enableCsrfProtection |
String |
Key to determine whether cross site request forgery protection should be enabled and at what level.
Default value is "", which means that this protection is disabled. Valid values are
"" (disabled), "REQUEST" (token generation is automatic, but requires using CSRF
API), and "REQUEST_RESPONSE" (transparent rewriting of responses to include CSRF token,
requires zero.acf dependency) |
Read-only |
| /config/security/token/enableStrongCsrfProtection |
Boolean |
Enables stronger support for CSRF protection than what is provided by default. Note requires some
additional configuration by the application developer so please read the Developer's Guide for more
information.
Default is false. |
Read-only |
| /config/security/token/ltpa2#cookieName |
String |
The name of the cookie to use for the token
The default value is LtpaToken2 |
Read-only |
| /config/security/token/ltpa2#keyImportFile |
String |
The relative path of the LTPA key import file from the configuration folder of the application.
The file is exported by WebSphere Application Server. |
Read-only |
| /config/security/token/ltpa2#keyPassword |
String |
The password to extract the LTPA keys from the LTPA key import file. (See Leveraging XOREncoding
in Developer's Guide) |
Read-only |
| /config/security/token/ltpa2#ssoDomains |
List |
List of possible values for the ltpa token cookie domain. Each element in the list will be
matched against the server name obtained the request (GlobalContext.zget(Request.serverName)). If
the serverName, obtained from the GlobalContext, ends with a value from the list of ssoDomains,
the cookie will be created with that domain (first match wins). |
Read-only |
| /config/security/token/ltpa2#tokenExpiration |
Long |
The expiration limit of the LTPAToken2 in minutes.
The default value is 120. |
Read-only |
| /config/security/token/securedCookie |
Boolean |
Boolean flag to determine whether security cookie should be marked as secured (HTTPs only) or not
Default false |
Read-only |
| /config/security/token/simple#cookieName |
String |
The name of the cookie to use for the token
The default value is SimpleToken |
Read-only |
| /config/security/token/simple#ssoDomains |
List |
List of possible values for the simple token cookie domain. Each element in the list will be
matched against the server name obtained the request (GlobalContext.zget(Request.serverName)). If
the serverName, obtained from the GlobalContext, ends with a value from the list of ssoDomains,
the cookie will be created with that domain (first match wins). |
Read-only |
| /config/security/token/simple#tokenExpiration |
Long |
The expiration limit of the simple token expiration in minutes.
The default value is 120 |
Read-only |
| /config/security/token/tokenType |
String |
The token type generated and validated by the runtime for secured resources.
Default is Simple. |
Read-only |
| /config/security/userservice/file/pathToUserfile |
String |
The path to the user registry file for file based user registry The default value is
${config.root}/zero.users |
Read-only |
| /config/security/userservice/ldap#fullBaseDNFilterPattern |
String |
The filter to search for a user based upon the fully qualified domain name. The default value is
"(objectclass=*)" |
Read-only |
| /config/security/userservice/ldap#ignoreBaseDN |
String |
Boolean flag supports fully qualified domain name (FQDN) lookups. If false, FQDN lookups will be
disabled. The default value is true |
Read-only |
| /config/security/userservice/ldap#jndiInitialContextFactory |
String |
Initial context factory name. The default value is "com.sun.jndi.ldap.LdapCtxFactory" |
Read-only |
| /config/security/userservice/ldap#jndiProviderUrl |
String |
JNDI provider URL |
Read-only |
| /config/security/userservice/ldap#jndiSecurityAuthentication |
String |
The level of authentication used by JNDI. The default value is "simple". |
Read-only |
| /config/security/userservice/ldap#jndiSecurityCredentials |
String |
Administrator's credential, in XOREncoding format. |
Read-only |
| /config/security/userservice/ldap#jndiSecurityPrincipal |
String |
Administrator's principal. |
Read-only |
| /config/security/userservice/ldap#ldapGroupAttributeType |
String |
The attribute type of the group name. The default value is "cn" |
Read-only |
| /config/security/userservice/ldap#ldapGroupBaseDn |
String |
The base DN of groups. |
Read-only |
| /config/security/userservice/ldap#ldapGroupSearchFilterPattern |
String |
The filter to search groups to which a user ID belongs. A user ID is embedded in the place holder
"{0}" . The default value is "(&(uniqueMember={0})
(objectclass=groupOfUniqueNames))" |
Read-only |
| /config/security/userservice/ldap#ldapSearchScope |
Integer |
The search scope set to javax.naming.directory.SearchControls: 0(SearchControls.OBJECT_SCOPE)
1(SearchControls.ONELEVEL_SCOPE) 2(SearchControls.SUBTREE_SCOPE) The default value is 2
(SearchControls.SUBTREE_SCOPE) |
Read-only |
| /config/security/userservice/ldap#ldapSearchTimeLimit |
Integer |
The search time limit, in milliseconds, set to javax.naming.directory.SearchControls. The default
value is 3000 |
Read-only |
| /config/security/userservice/ldap#ldapSocketFactory |
String |
The classname for a custom socket factory implementation used by the LDAP service provider. |
Read-only |
| /config/security/userservice/ldap#ldapUserIdAttributeType |
String |
The attribute type of the user name. The default value is "uid" |
Read-only |
| /config/security/userservice/ldap#ldapUserIdBaseDn |
String |
The root from which the LDAP user service starts to search a user. |
Read-only |
| /config/security/userservice/ldap#ldapUserIdRdnPattern |
String |
The pattern of user entries' RDN. A user ID is embedded in the placeholder "{0}" . |
Read-only |
| /config/security/userservice/ldap#ldapUserIdSearchFilterPattern |
String |
The pattern of the user search filter. A user ID is embedded in the place holder "{0}"
. The default value is "(&(uid={0}) (objectclass=inetOrgPerson))" |
Read-only |
| /config/security/userservice/registryImpl |
String |
The implementation class associated with the registry type
/config/security/userservice/registryImpl/registryType
|
Read-only |
| /config/security/userservice/registryType |
String |
The alias user registry type used by the security runtime The default value is "file". |
Read-only |
| /config/serverHeader |
String |
The value of the Server header string. If not set, then default value of
IBM WebSphere sMash/{Version Number} will be returned by the value.
If set to the empty string {""}, then the server header value will not be
included in responses. |
Read-only |
| /config/system/hostName |
String |
The hostname of the System |
Read/write |
| /config/task |
String |
The task which is being run, or should be run, when the runtime starts. Set by the CLI. |
Read-only |
| /config/tasks/defaultExtensions |
List <String> |
List of file extensions for CLI task handlers, in search order. |
Read |
| /config/tmpDir |
String |
The location of a directory for temporary files to be stored. The default
is the Java system property java.io.tmpdir. |
Read-only |
| /config/userZone/cookieName |
String |
The name of the cookie to use for the User zone
The default value is zsessionid |
Read-only |
| /config/userZone/disableSessionReaper |
Boolean |
If set to true will disable session reaper.
If this is done then the responsibility of cleaning up expired sessions
is with the user. |
Read only |
| /config/userZone/idleTimeout |
Integer |
The time of inactivity after which user sessions should be destroyed. Value is in seconds. |
Read-only |
| /config/userZone/invalidationTimeout |
Integer |
The total time after which user sessions should be destroyed. Value is in seconds |
Read-only |
| /config/xml/converters |
Map <String, String> |
Map of class name/converter pairs that are invoked when serializing
from/parsing to an instance of the specified class. Key=class name; value=converter implementation class. |
Read-only |
| /config/xml/objectToDom |
String |
name of the class that implements ObjectToDom interface
This class is instantiated by the ObjectToDomFactory |
Read-only |
| /config/zerohome |
String |
The location where the CLI is installed. |
Read-only |
| /config/zso/foreground |
Boolean |
Whether the ZSO should start in foreground mode. Default is false. |
Read only |
| /config/zso/immediateStart |
Boolean |
Whether the ZSO should start the underlying java runtime immediately upon the start of the application.
The default is on demand, or false. |
Read only |
| /config/zso/jvmargs |
List<String> |
The jvm args that should be used when the process is started. This section is further divided by a System
property to retrieve, then a String which will be used with .startsWith to determine the list of
parameters to add. |
Read only |
| /config/zso/loggingLevel |
Level |
What the default logging level of the ZSO should be when started |
Read Only |
| /config/zso/recycle/enable |
Boolean |
Whether recycle based on maxRequests / idleTimeout is enabled. Setting this to false will disable all
automatic recycles, but will not disable the ability to force a recycle via command line or API. |
Read only |
| /config/zso/recycle/idleTimeout |
Integer |
The default maximum number of seconds to wait after the last request before the Java Runtime
recycles. |
Read only |
| /config/zso/recycle/inParallel |
|
enable parallel recycling |
|
| /config/zso/recycle/maxRequests |
Integer |
The default maximum number of requests that should be accepted before the Java runtime recycles. |
Read only |
| /config/zso/recycle/pauseTime |
|
How long to wait before quiescing the running jvm
This value is ignored if parallelRecycle is false |
|