org.apache.jackrabbit.api.security.user
Interface Impersonation

public interface Impersonation

The Impersonation maintains Principals that are allowed to impersonate. Principals can be added or removed using grantImpersonation(Principal) and revokeImpersonation(Principal), respectively.

See Also:

User.getImpersonation()

Method Summary

boolean	allows(Subject subject) Test if the given subject (i.e. any of the principals it contains) is allowed to impersonate.
PrincipalIterator	getImpersonators()
boolean	grantImpersonation(Principal principal)
boolean	revokeImpersonation(Principal principal)

Method Detail

getImpersonators

PrincipalIterator getImpersonators()
                                   throws RepositoryException

Returns:

An iterator over the Principals that are allowed to impersonate the User this Impersonation object has been created for.

Throws:

RepositoryException - If an error occurs.

grantImpersonation

boolean grantImpersonation(Principal principal)
                           throws RepositoryException

Parameters:

principal - The principal that should be allowed to impersonate the User this Impersonation has been built for.

Returns:

true if the specified Principal has not been allowed to impersonate before and if impersonation has been successfully granted to it, false otherwise.

Throws:

RepositoryException - If an error occurs.

revokeImpersonation

boolean revokeImpersonation(Principal principal)
                            throws RepositoryException

Parameters:

principal - The principal that should no longer be allowed to impersonate.

Returns:

If the granted impersonation has been successfully revoked for the given principal; false otherwise.

Throws:

RepositoryException - If an error occurs.

allows

boolean allows(Subject subject)
               throws RepositoryException

Test if the given subject (i.e. any of the principals it contains) is allowed to impersonate.

Parameters:

subject - to impersonate.

Returns:

true if this Impersonation allows the specified Subject to impersonate.

Throws:

RepositoryException - If an error occurs.