|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<JcrRepository.Option>
org.jboss.dna.jcr.JcrRepository.Option
public static enum JcrRepository.Option
The available options for the JcrRepository
.
Enum Constant Summary | |
---|---|
ANONYMOUS_USER_ROLES
A comma-delimited list of default roles provided for anonymous access. |
|
JAAS_LOGIN_CONFIG_NAME
The JAAS application configuration name that specifies which
login modules should be used to validate credentials. |
|
PROJECT_NODE_TYPES
Flag that defines whether or not the node types should be exposed as content under the " /jcr:system/jcr:nodeTypes " node. |
|
QUERY_EXECUTION_ENABLED
A boolean flag that specifies whether this repository is expected to execute searches and queries. |
|
QUERY_INDEX_DIRECTORY
The system may maintain a set of indexes that improve the performance of searching and querying the content. |
|
QUERY_INDEXES_UPDATED_SYNCHRONOUSLY
A boolean flag that specifies whether updates to the indexes (if used) should be made synchronously, meaning that a call to Session.save() will not return until the search indexes have been completely updated. |
|
READ_DEPTH
The depth of the subgraphs that should be loaded the connectors. |
|
SYSTEM_SOURCE_NAME
The name of the source (and optionally the workspace in the source) where the "/jcr:system" branch should be stored. |
|
TABLES_INCLUDE_COLUMNS_FOR_INHERITED_PROPERTIES
The query system represents node types as tables that can be queried, but there are two ways to define the columns for each of those tables. |
Method Summary | |
---|---|
static JcrRepository.Option |
findOption(String option)
Determine the option given the option name. |
static JcrRepository.Option |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static JcrRepository.Option[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final JcrRepository.Option PROJECT_NODE_TYPES
/jcr:system/jcr:nodeTypes
" node. Value is either "true
" or "false
" (default).
JcrRepository.DefaultOption.PROJECT_NODE_TYPES
public static final JcrRepository.Option JAAS_LOGIN_CONFIG_NAME
JAAS application configuration name
that specifies which
login modules should be used to validate credentials.
public static final JcrRepository.Option SYSTEM_SOURCE_NAME
name of workspace@name of source
", or simply "name of source
" if the default
workspace is to be used. If this option is not used, a transient in-memory source will be used.
Note that all leading and trailing whitespace is removed for both the source name and workspace name. Thus, a value of
"@
" implies a zero-length workspace name and zero-length source name.
Also, any use of the '@' character in source and workspace names must be escaped with a preceding backslash.
public static final JcrRepository.Option READ_DEPTH
public static final JcrRepository.Option ANONYMOUS_USER_ROLES
public static final JcrRepository.Option TABLES_INCLUDE_COLUMNS_FOR_INHERITED_PROPERTIES
NodeType.getSupertypes()
.
The default value is 'true'.
public static final JcrRepository.Option QUERY_EXECUTION_ENABLED
The default is 'true', meaning that clients can execute searches and queries.
public static final JcrRepository.Option QUERY_INDEX_DIRECTORY
If specified, the value must be a valid path to a writable directory on the file system. If the path specifies a non-existant location, the repository may attempt to create the missing directories. The path may be absolute or relative to the location where this VM was started. If the specified location is not a readable and writable directory (or cannot be created as such), then this will generate an exception when the repository is created.
The default value is null, meaning the search indexes may not be stored on the local file system and, if needed, will be stored within memory.
public static final JcrRepository.Option QUERY_INDEXES_UPDATED_SYNCHRONOUSLY
Session.save()
will not return until the search indexes have been completely updated. The benefit of
synchronous updates is that a search or query performed immediately after a save()
will operate upon
content that was just changed. The downside is that the save()
operation will take longer.
With asynchronous updates, however, the only work done during a save()
invocation is that required to
persist the changes in the underlying repository source, while changes to the search indexes are made in a different
thread that may not run immediately. In this case, there may be an indeterminate lag before searching or querying after
a save()
will operate upon the changed content.
The default is value 'false', meaning the updates are performed asynchronously.
Method Detail |
---|
public static JcrRepository.Option[] values()
for (JcrRepository.Option c : JcrRepository.Option.values()) System.out.println(c);
public static JcrRepository.Option valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic static JcrRepository.Option findOption(String option)
valueOf(String)
, since this method first
tries to match the supplied string to the option's name
, then the uppercase version of the
supplied string to the option's name, and finally if the supplied string is a camel-case version of the name (e.g.,
"projectNodeTypes").
option
- the string version of the option's name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |