org.glassfish.security.services.api.authentication

Interface ImpersonationService

All Known Implementing Classes:

ImpersonationServiceImpl

@Contract
public interface ImpersonationService

The Impersonation Service

Method Summary

Modifier and Type	Method and Description
Subject	impersonate(String user, String[] groups, Subject subject, boolean virtual) Impersonate a user, specifying the user and group principal names that should be established in the resulting Subject.

Method Detail

impersonate

Subject impersonate(String user,
                    String[] groups,
                    Subject subject,
                    boolean virtual)
             throws LoginException

Impersonate a user, specifying the user and group principal names that should be established in the resulting Subject. Note that, that this method always behaves as if virtual were true in the case that the underlying user store provider does not support user lookup.

Parameters:

user - The username.

groups - An array of group names. If virtual is true, group principals will be created using this array. If virtual is false and groups is non-null, it will be used to filter the groups returned by the configured UserStoreProvider.

subject - An optional Subject to receive principals and credentials for the logged in user. If provided, it will be returned as the return value; if not, a new Subject will be returned.

virtual - If true, simply create a subject with the given user and group names. If false, configured UserStoreProvider will be queried for the given username and a Subject created only if the user exists. Groups will be populated with the intersection of the groups parameter and the groups returned by the UserStoreProvider.

Returns:

A Subject representing the impersonated user.

Throws:

LoginException