Package org.apache.jackrabbit.oak.spi.security.principal

Class PrincipalManagerImpl

java.lang.Object

org.apache.jackrabbit.oak.spi.security.principal.PrincipalManagerImpl

All Implemented Interfaces:

org.apache.jackrabbit.api.security.principal.PrincipalManager, PrincipalQueryManager

public class PrincipalManagerImpl
extends Object
implements PrincipalQueryManager, org.apache.jackrabbit.api.security.principal.PrincipalManager

Default implementation of the PrincipalManager interface.

Field Summary

Fields inherited from interface org.apache.jackrabbit.api.security.principal.PrincipalManager

SEARCH_TYPE_ALL, SEARCH_TYPE_GROUP, SEARCH_TYPE_NOT_GROUP

Constructor Summary

Constructors

Constructor	Description
PrincipalManagerImpl(@NotNull PrincipalProvider principalProvider)

Method Summary

Modifier and Type	Method	Description
@NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator	findPrincipals(@Nullable String simpleFilter)
@NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator	findPrincipals(@Nullable String simpleFilter, boolean fullText, int searchType, long offset, long limit)	Gets the principals matching a simple filter expression applied against the principal name AND the specified search type.
@NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator	findPrincipals(@Nullable String simpleFilter, int searchType)
@NotNull Principal	getEveryone()
@NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator	getGroupMembership(@NotNull Principal principal)
@Nullable Principal	getPrincipal(@NotNull String principalName)
@NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator	getPrincipals(int searchType)
boolean	hasPrincipal(@NotNull String principalName)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrincipalManagerImpl

public PrincipalManagerImpl(@NotNull
                            @NotNull PrincipalProvider principalProvider)

Method Detail

hasPrincipal

public boolean hasPrincipal(@NotNull
                            @NotNull String principalName)

Specified by:

hasPrincipal in interface org.apache.jackrabbit.api.security.principal.PrincipalManager

getPrincipal

@Nullable
public @Nullable Principal getPrincipal(@NotNull
                                        @NotNull String principalName)

Specified by:

getPrincipal in interface org.apache.jackrabbit.api.security.principal.PrincipalManager

findPrincipals

@NotNull
public @NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator findPrincipals(@Nullable
                                                                                              @Nullable String simpleFilter)

Specified by:

findPrincipals in interface org.apache.jackrabbit.api.security.principal.PrincipalManager

findPrincipals

@NotNull
public @NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator findPrincipals(@Nullable
                                                                                              @Nullable String simpleFilter,
                                                                                              int searchType)

Specified by:

findPrincipals in interface org.apache.jackrabbit.api.security.principal.PrincipalManager

getPrincipals

@NotNull
public @NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator getPrincipals(int searchType)

Specified by:

getPrincipals in interface org.apache.jackrabbit.api.security.principal.PrincipalManager

getGroupMembership

@NotNull
public @NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator getGroupMembership(@NotNull
                                                                                                  @NotNull Principal principal)

Specified by:

getGroupMembership in interface org.apache.jackrabbit.api.security.principal.PrincipalManager

getEveryone

@NotNull
public @NotNull Principal getEveryone()

Specified by:

getEveryone in interface org.apache.jackrabbit.api.security.principal.PrincipalManager

findPrincipals

@NotNull
public @NotNull org.apache.jackrabbit.api.security.principal.PrincipalIterator findPrincipals(@Nullable
                                                                                              @Nullable String simpleFilter,
                                                                                              boolean fullText,
                                                                                              int searchType,
                                                                                              long offset,
                                                                                              long limit)

Description copied from interface: PrincipalQueryManager

Gets the principals matching a simple filter expression applied against the principal name AND the specified search type. Results are expected to be sorted by the principal name. An implementation may limit the number of principals returned. If there are no matching principals, an empty iterator is returned.

Specified by:

findPrincipals in interface PrincipalQueryManager

searchType - Any of the following constants:

• PrincipalManager.SEARCH_TYPE_ALL
• PrincipalManager.SEARCH_TYPE_GROUP
• PrincipalManager.SEARCH_TYPE_NOT_GROUP

offset - Offset from where to start returning results. 0 for no offset.

limit - Maximal number of results to return. -1 for no limit.

Returns:

a PrincipalIterator over the Principals matching the given filter and search type.