org.jboss.dna.jcr
Enum JcrRepository.Option

java.lang.Object
  java.lang.Enum<JcrRepository.Option>
      org.jboss.dna.jcr.JcrRepository.Option

All Implemented Interfaces:

Serializable, Comparable<JcrRepository.Option>

Enclosing class:

JcrRepository

public static enum JcrRepository.Option
extends Enum<JcrRepository.Option>

The available options for the JcrRepository.

Enum Constant Summary

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.

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.

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

PROJECT_NODE_TYPES

public static final JcrRepository.Option PROJECT_NODE_TYPES

Flag that defines whether or not the node types should be exposed as content under the "/jcr:system/jcr:nodeTypes" node. Value is either "true" or "false" (default).

See Also:

JcrRepository.DefaultOption.PROJECT_NODE_TYPES

JAAS_LOGIN_CONFIG_NAME

public static final JcrRepository.Option JAAS_LOGIN_CONFIG_NAME

The JAAS application configuration name that specifies which login modules should be used to validate credentials.

SYSTEM_SOURCE_NAME

public static final JcrRepository.Option SYSTEM_SOURCE_NAME

The name of the source (and optionally the workspace in the source) where the "/jcr:system" branch should be stored. The format is "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.

READ_DEPTH

public static final JcrRepository.Option READ_DEPTH

The depth of the subgraphs that should be loaded the connectors. The default value is 1.

Method Detail

values

public static JcrRepository.Option[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JcrRepository.Option c : JcrRepository.Option.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JcrRepository.Option valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

findOption

public static JcrRepository.Option findOption(String option)

Determine the option given the option name. This does more than 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").

Parameters:

option - the string version of the option's name

Returns:

the matching Option instance, or null if an option could not be matched using the supplied value