com.adobe.cq.social.serviceusers.internal

Interface ServiceUserWrapper

public interface ServiceUserWrapper

A wrapper for service user functionality in Sling. By passing all calls through this wrapper clients can mitigate risk associated with the need to backport code to environments which don't support service users or the service users of interest. In those environments this service can be replaced with a version which maps some or all service users to the admin user.

Method Summary

Modifier and Type	Method and Description
ResourceResolver	getServiceResourceResolver(ResourceResolverFactory factory, java.util.Map<java.lang.String,java.lang.Object> authInfo) Returns a new ResourceResolver for the given service user alias.
javax.jcr.Session	impersonateFromService(SlingRepository repo, java.lang.String alias, javax.jcr.Credentials cred)
javax.jcr.Session	loginService(SlingRepository repo, java.lang.String alias) Returns a new session for the given service user alias.

Method Detail

loginService

javax.jcr.Session loginService(SlingRepository repo,
                               java.lang.String alias)
                        throws javax.jcr.LoginException,
                               javax.jcr.RepositoryException

Returns a new session for the given service user alias.

Parameters:

repo - The Sling repository.

alias - The alias, may be null if only one service user is configured for the bundle providing the repository instance.

Returns:

The session authenticated as the service user.

Throws:

javax.jcr.LoginException - If the service user cannot be logged in.

javax.jcr.RepositoryException - If other repository errors are encountered while creating the session.

impersonateFromService

javax.jcr.Session impersonateFromService(SlingRepository repo,
                                         java.lang.String alias,
                                         javax.jcr.Credentials cred)
                                  throws javax.jcr.LoginException,
                                         javax.jcr.RepositoryException

Throws:

javax.jcr.LoginException

javax.jcr.RepositoryException

getServiceResourceResolver

ResourceResolver getServiceResourceResolver(ResourceResolverFactory factory,
                                            java.util.Map<java.lang.String,java.lang.Object> authInfo)
                                     throws LoginException

Returns a new ResourceResolver for the given service user alias.

Parameters:

factory - The ResourceResolverFactory.

authInfo - authInfo map containing the ResourceResolverFactory.SUBSERVICE value naming the alias to use.

Returns:

The ResourceResolver authenticated as the service user.

Throws:

LoginException - If the service user cannot be logged in.