org.apache.jackrabbit.oak.spi.security.authentication.external.impl

Class DefaultSyncConfigImpl

java.lang.Object

org.apache.jackrabbit.oak.spi.security.authentication.external.basic.DefaultSyncConfig

org.apache.jackrabbit.oak.spi.security.authentication.external.impl.DefaultSyncConfigImpl

public class DefaultSyncConfigImpl
extends DefaultSyncConfig

DefaultSyncConfig defines how users and groups from an external source are synced into the repository using the DefaultSyncHandler.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.jackrabbit.oak.spi.security.authentication.external.basic.DefaultSyncConfig

DefaultSyncConfig.Authorizable, DefaultSyncConfig.Group, DefaultSyncConfig.User

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_GROUP_AUTO_MEMBERSHIP
static String[]	PARAM_GROUP_AUTO_MEMBERSHIP_DEFAULT
static String	PARAM_GROUP_EXPIRATION_TIME
static String	PARAM_GROUP_EXPIRATION_TIME_DEFAULT
static String	PARAM_GROUP_PATH_PREFIX
static String	PARAM_GROUP_PATH_PREFIX_DEFAULT
static String	PARAM_GROUP_PROPERTY_MAPPING
static String[]	PARAM_GROUP_PROPERTY_MAPPING_DEFAULT
static String	PARAM_NAME
static String	PARAM_NAME_DEFAULT
static String	PARAM_USER_AUTO_MEMBERSHIP
static String[]	PARAM_USER_AUTO_MEMBERSHIP_DEFAULT
static String	PARAM_USER_EXPIRATION_TIME
static String	PARAM_USER_EXPIRATION_TIME_DEFAULT
static String	PARAM_USER_MEMBERSHIP_EXPIRATION_TIME
static String	PARAM_USER_MEMBERSHIP_EXPIRATION_TIME_DEFAULT
static String	PARAM_USER_MEMBERSHIP_NESTING_DEPTH
static int	PARAM_USER_MEMBERSHIP_NESTING_DEPTH_DEFAULT
static String	PARAM_USER_PATH_PREFIX
static String	PARAM_USER_PATH_PREFIX_DEFAULT
static String	PARAM_USER_PROPERTY_MAPPING
static String[]	PARAM_USER_PROPERTY_MAPPING_DEFAULT

Constructor Summary

Constructors

Constructor and Description
DefaultSyncConfigImpl()

Method Summary

Methods

Modifier and Type	Method and Description
static DefaultSyncConfig	of(org.apache.jackrabbit.oak.spi.security.ConfigurationParameters params) Creates a new LDAP provider configuration based on the properties store in the given parameters.

Methods inherited from class org.apache.jackrabbit.oak.spi.security.authentication.external.basic.DefaultSyncConfig

getName, group, setName, user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_NAME_DEFAULT

public static final String PARAM_NAME_DEFAULT

See Also:

DefaultSyncConfig.getName(), Constant Field Values

PARAM_NAME

@Property(label="Sync Handler Name",
          description="Name of this sync configuration. This is used to reference this handler by the login modules.",
          value="default")
public static final String PARAM_NAME

See Also:

DefaultSyncConfig.getName(), Constant Field Values

PARAM_USER_EXPIRATION_TIME_DEFAULT

public static final String PARAM_USER_EXPIRATION_TIME_DEFAULT

See Also:

DefaultSyncConfigImpl.User#getExpirationTime(), Constant Field Values

PARAM_USER_EXPIRATION_TIME

@Property(label="User Expiration Time",
          description="Duration until a synced user gets expired (eg. \'1h 30m\' or \'1d\').",
          value="1h")
public static final String PARAM_USER_EXPIRATION_TIME

See Also:

DefaultSyncConfigImpl.User#getExpirationTime(), Constant Field Values

PARAM_USER_AUTO_MEMBERSHIP_DEFAULT

public static final String[] PARAM_USER_AUTO_MEMBERSHIP_DEFAULT

See Also:

DefaultSyncConfigImpl.User#getAutoMembership()

PARAM_USER_AUTO_MEMBERSHIP

@Property(label="User auto membership",
          description="List of groups that a synced user is added to automatically",
          value={},
          cardinality=2147483647)
public static final String PARAM_USER_AUTO_MEMBERSHIP

See Also:

DefaultSyncConfigImpl.User#getAutoMembership(), Constant Field Values

PARAM_USER_PROPERTY_MAPPING_DEFAULT

public static final String[] PARAM_USER_PROPERTY_MAPPING_DEFAULT

See Also:

DefaultSyncConfigImpl.User#getPropertyMapping()

PARAM_USER_PROPERTY_MAPPING

@Property(label="User property mapping",
          description="List mapping definition of local properties from external ones. eg: \'profile/email=mail\'.Use double quotes for fixed values. eg: \'profile/nt:primaryType=\"nt:unstructured\"",
          value="rep:fullname=cn",
          cardinality=2147483647)
public static final String PARAM_USER_PROPERTY_MAPPING

See Also:

DefaultSyncConfigImpl.User#getPropertyMapping(), Constant Field Values

PARAM_USER_PATH_PREFIX_DEFAULT

public static final String PARAM_USER_PATH_PREFIX_DEFAULT

See Also:

DefaultSyncConfigImpl.User#getPathPrefix(), Constant Field Values

PARAM_USER_PATH_PREFIX

@Property(label="User Path Prefix",
          description="The path prefix used when creating new users.",
          value="")
public static final String PARAM_USER_PATH_PREFIX

See Also:

DefaultSyncConfigImpl.User#getPathPrefix(), Constant Field Values

PARAM_USER_MEMBERSHIP_EXPIRATION_TIME_DEFAULT

public static final String PARAM_USER_MEMBERSHIP_EXPIRATION_TIME_DEFAULT

See Also:

DefaultSyncConfigImpl.User#getMembershipExpirationTime(), Constant Field Values

PARAM_USER_MEMBERSHIP_EXPIRATION_TIME

@Property(label="User Membership Expiration",
          description="Time after which membership expires (eg. \'1h 30m\' or \'1d\'). Note however, that a membership sync is aways bound to a sync of the user.",
          value="1h")
public static final String PARAM_USER_MEMBERSHIP_EXPIRATION_TIME

See Also:

DefaultSyncConfigImpl.User#getMembershipExpirationTime(), Constant Field Values

PARAM_USER_MEMBERSHIP_NESTING_DEPTH_DEFAULT

public static final int PARAM_USER_MEMBERSHIP_NESTING_DEPTH_DEFAULT

See Also:

User#getMembershipNestingDepth(), Constant Field Values

PARAM_USER_MEMBERSHIP_NESTING_DEPTH

@Property(label="User membership nesting depth",
          description="Returns the maximum depth of group nesting when membership relations are synced. A value of 0 effectively disables group membership lookup. A value of 1 only adds the direct groups of a user. This value has no effect when syncing individual groups only when syncing a users membership ancestry.",
          intValue=0)
public static final String PARAM_USER_MEMBERSHIP_NESTING_DEPTH

See Also:

User#getMembershipNestingDepth(), Constant Field Values

PARAM_GROUP_EXPIRATION_TIME_DEFAULT

public static final String PARAM_GROUP_EXPIRATION_TIME_DEFAULT

See Also:

DefaultSyncConfigImpl.Group#getExpirationTime(), Constant Field Values

PARAM_GROUP_EXPIRATION_TIME

@Property(label="Group Expiration Time",
          description="Duration until a synced group expires (eg. \'1h 30m\' or \'1d\').",
          value="1d")
public static final String PARAM_GROUP_EXPIRATION_TIME

See Also:

DefaultSyncConfigImpl.Group#getExpirationTime(), Constant Field Values

PARAM_GROUP_AUTO_MEMBERSHIP_DEFAULT

public static final String[] PARAM_GROUP_AUTO_MEMBERSHIP_DEFAULT

See Also:

DefaultSyncConfigImpl.Group#getAutoMembership()

PARAM_GROUP_AUTO_MEMBERSHIP

@Property(label="Group auto membership",
          description="List of groups that a synced group is added to automatically",
          value={},
          cardinality=2147483647)
public static final String PARAM_GROUP_AUTO_MEMBERSHIP

See Also:

DefaultSyncConfigImpl.Group#getAutoMembership(), Constant Field Values

PARAM_GROUP_PROPERTY_MAPPING_DEFAULT

public static final String[] PARAM_GROUP_PROPERTY_MAPPING_DEFAULT

See Also:

DefaultSyncConfigImpl.Group#getPropertyMapping()

PARAM_GROUP_PROPERTY_MAPPING

@Property(label="Group property mapping",
          description="List mapping definition of local properties from external ones.",
          value={},
          cardinality=2147483647)
public static final String PARAM_GROUP_PROPERTY_MAPPING

See Also:

DefaultSyncConfigImpl.Group#getPropertyMapping(), Constant Field Values

PARAM_GROUP_PATH_PREFIX_DEFAULT

public static final String PARAM_GROUP_PATH_PREFIX_DEFAULT

See Also:

DefaultSyncConfigImpl.Group#getPathPrefix(), Constant Field Values

PARAM_GROUP_PATH_PREFIX

@Property(label="Group Path Prefix",
          description="The path prefix used when creating new groups.",
          value="")
public static final String PARAM_GROUP_PATH_PREFIX

See Also:

DefaultSyncConfigImpl.Group#getPathPrefix(), Constant Field Values

Constructor Detail

DefaultSyncConfigImpl

public DefaultSyncConfigImpl()

Method Detail

of

public static DefaultSyncConfig of(org.apache.jackrabbit.oak.spi.security.ConfigurationParameters params)

Creates a new LDAP provider configuration based on the properties store in the given parameters.

Parameters:

params - the configuration parameters.

Returns:

the config