org.alfresco.bm.publicapi.factory

Interface PublicApiFactory

All Known Implementing Classes:

BasicAuthPublicApiFactory, OAuthPublicApiFactory

public interface PublicApiFactory

A factory for creating a public api connection for a specific user.

Author:

steveglover

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.social.alfresco.api.Alfresco	getAdminPublicApi() Get a public api connection for the admin user.
org.springframework.social.alfresco.api.Alfresco	getPublicApi(String username) Get a public api connection for the "username"
org.springframework.social.alfresco.api.Alfresco	getTenantAdminPublicApi(String domain) Get a public api connection for the admin user of the given domain.

Method Detail

getPublicApi

org.springframework.social.alfresco.api.Alfresco getPublicApi(String username)

Get a public api connection for the "username"

Parameters:

username - the user name of the user

Returns:

a public api connection for the given user

Throws:

Exception

getTenantAdminPublicApi

org.springframework.social.alfresco.api.Alfresco getTenantAdminPublicApi(String domain)

Get a public api connection for the admin user of the given domain. Note: may not be implemented by all factories.

Parameters:

domain - the domain id of the domain admin user

Returns:

a public api connection for the admin user of the given domain

Throws:

Exception

getAdminPublicApi

org.springframework.social.alfresco.api.Alfresco getAdminPublicApi()

Get a public api connection for the admin user. Note: may not be implemented by all factories.

Returns:

a public api connection for the admin user

Throws:

Exception