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

Class DefaultSyncConfig.Authorizable

java.lang.Object

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

Direct Known Subclasses:

DefaultSyncConfig.Group, DefaultSyncConfig.User

Enclosing class:

DefaultSyncConfig

public abstract static class DefaultSyncConfig.Authorizable
extends Object

Base config class for users and groups

Constructor Summary

Constructors

Constructor and Description
DefaultSyncConfig.Authorizable()

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAutoMembership() Defines the set of group names that are automatically added to synced authorizable.
long	getExpirationTime() Returns the duration in milliseconds until a synced authorizable gets expired.
String	getPathPrefix() Defines the authorizables intermediate path prefix that is used when creating new authorizables.
Map<String,String>	getPropertyMapping() Defines the mapping of internal property names from external values.
boolean	isApplyRFC7613UsernameCaseMapped() Returns true if new AuthorizableIDs will be normalized according to the UsernameCaseMapped profile defined in RFC7613
DefaultSyncConfig.Authorizable	setApplyRFC7613UsernameCaseMapped(boolean applyRFC7613UsernameCaseMapped) Set to true if new AuthorizableIDs shall be normalized according to the UsernameCaseMapped profile defined in RFC7613.
DefaultSyncConfig.Authorizable	setAutoMembership(String... autoMembership) Sets the auto membership.
DefaultSyncConfig.Authorizable	setExpirationTime(long expirationTime) Sets the expiration time.
DefaultSyncConfig.Authorizable	setPathPrefix(String pathPrefix) Sets the path prefix.
DefaultSyncConfig.Authorizable	setPropertyMapping(Map<String,String> propertyMapping) Sets the property mapping.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSyncConfig.Authorizable

public DefaultSyncConfig.Authorizable()

Method Detail

getExpirationTime

public long getExpirationTime()

Returns the duration in milliseconds until a synced authorizable gets expired. An expired authorizable will be re-synced.

Returns:

the expiration time in milliseconds.

setExpirationTime

@Nonnull
public DefaultSyncConfig.Authorizable setExpirationTime(long expirationTime)

Sets the expiration time.

Parameters:

expirationTime - time in milliseconds.

Returns:

this

See Also:

getExpirationTime()

isApplyRFC7613UsernameCaseMapped

public boolean isApplyRFC7613UsernameCaseMapped()

Returns true if new AuthorizableIDs will be normalized according to the UsernameCaseMapped profile defined in RFC7613

Returns:

true if new AuthorizableIDs will be normalized.

setApplyRFC7613UsernameCaseMapped

public DefaultSyncConfig.Authorizable setApplyRFC7613UsernameCaseMapped(boolean applyRFC7613UsernameCaseMapped)

Set to true if new AuthorizableIDs shall be normalized according to the UsernameCaseMapped profile defined in RFC7613.

Parameters:

applyRFC7613UsernameCaseMapped - true if the UsernameCaseMapped profile shall be used for normalization.

Returns:

this

See Also:

isApplyRFC7613UsernameCaseMapped()

getAutoMembership

@Nonnull
public Set<String> getAutoMembership()

Defines the set of group names that are automatically added to synced authorizable.

Returns:

set of group names.

setAutoMembership

@Nonnull
public DefaultSyncConfig.Authorizable setAutoMembership(@Nonnull
                                                       String... autoMembership)

Sets the auto membership. Note that the passed group names will be trimmed and empty string values will be ignored (along with null values).

Parameters:

autoMembership - the membership

Returns:

this

See Also:

getAutoMembership()

getPropertyMapping

@Nonnull
public Map<String,String> getPropertyMapping()

Defines the mapping of internal property names from external values. Only the external properties defined as keys of this map are synced with the mapped internal properties. note that the property names can be relative paths. the intermediate nodes will be created accordingly. Example:

{
         "rep:fullname": "cn",
         "country", "c",
         "profile/email": "mail",
         "profile/givenName": "cn"
     }
 

The implicit properties like userid, groupname, password must not be mapped.

Returns:

the property mapping where the keys are the local property names and the values the external ones.

setPropertyMapping

@Nonnull
public DefaultSyncConfig.Authorizable setPropertyMapping(@Nonnull
                                                        Map<String,String> propertyMapping)

Sets the property mapping.

Parameters:

propertyMapping - the mapping

Returns:

this

See Also:

getPropertyMapping()

getPathPrefix

@Nonnull
public String getPathPrefix()

Defines the authorizables intermediate path prefix that is used when creating new authorizables. This prefix is always prepended to the path provided by the ExternalIdentity.

Returns:

the intermediate path prefix.

setPathPrefix

@Nonnull
public DefaultSyncConfig.Authorizable setPathPrefix(@Nonnull
                                                   String pathPrefix)

Sets the path prefix.

Parameters:

pathPrefix - the path prefix.

Returns:

this

See Also:

getPathPrefix()