Package de.xima.fc.user_portal.api.context

Class UserPortalInvocationContextFactory

java.lang.Object

de.xima.fc.user_portal.api.context.UserPortalInvocationContextFactory

All Implemented Interfaces:

Serializable

@SessionScoped
public class UserPortalInvocationContextFactory
extends Object
implements Serializable

Factory for creating IUserPortalInvocationContext instances.

Since:

8.2.0

Author:

XIMA Media GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserPortalInvocationContextFactory()

Method Summary

Modifier and Type	Method	Description
IUserPortalInvocationContext	live()	Creates a new IUserPortalInvocationContext instance that accesses a live user portal REST API.
IUserPortalInvocationContext	live(EHttpTransportType clientType)	Creates a new IUserPortalInvocationContext instance that accesses a live user portal REST API.
IUserPortalInvocationContext	live(EHttpTransportType clientType, IUserPortalRestClientConfig config, Locale locale, UserPortalRestAuthenticator authentication, UserPortalUnauthorizedHandler unauthorizedHandler)	Creates a new IUserPortalInvocationContext instance that accesses a live user portal REST API.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPortalInvocationContextFactory

public UserPortalInvocationContextFactory()

Method Detail

live

public IUserPortalInvocationContext live()

Creates a new IUserPortalInvocationContext instance that accesses a live user portal REST API. It makes uses of the default client and the default configuration, see UserPortalRestConfigManager, as well as the authentication for the current user, if any.

Returns:

A new IUserPortalInvocationContext instance.

live

public IUserPortalInvocationContext live(EHttpTransportType clientType)

Creates a new IUserPortalInvocationContext instance that accesses a live user portal REST API. It makes uses of the default configuration, see UserPortalRestConfigManager.

Parameters:

clientType - Type of the HTTP client.

Returns:

A new IUserPortalInvocationContext instance.

live

public IUserPortalInvocationContext live(EHttpTransportType clientType,
                                         IUserPortalRestClientConfig config,
                                         Locale locale,
                                         UserPortalRestAuthenticator authentication,
                                         UserPortalUnauthorizedHandler unauthorizedHandler)

Creates a new IUserPortalInvocationContext instance that accesses a live user portal REST API. It makes uses of the given configuration.

Parameters:

clientType - Type of the HTTP client.

config - Configuration for the REST client.

locale - Locale to use for the request.

authentication - Optional authentication applied to all REST requests.

unauthorizedHandler - Handler for unauthorized requests.

Returns:

A new IUserPortalInvocationContext instance.