Class UserPortalRestClientManager

java.lang.Object

de.xima.fc.user_portal.api.client.UserPortalRestClientManager

@ApplicationScoped
public class UserPortalRestClientManager
extends Object

Manages the REST client instances for interacting with the user portal REST API.

This is the low-level API, use UserPortalApi for high-level access to the user portal API.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
UserPortalRestClientManager()

Method Summary

Modifier and Type	Method	Description
UserPortalClient<ApiBundle>	publicFormClient(EHttpTransportType httpClient, IUserPortalRestClientConfig config)	This method returns the generated ApiBundle with the REST client for the public form API.
UserPortalClient<ApiBundle>	publicFormRecordClient(EHttpTransportType httpClient, IUserPortalRestClientConfig config)	This method returns the generated ApiBundle with the REST client for the public form record API.
UserPortalClient<ApiBundle>	publicGenericClient(EHttpTransportType httpClient, IUserPortalRestClientConfig config)	This method returns the generated ApiBundle with the REST client for the public user portal API.
UserPortalClient<ApiBundle>	publicSecurityClient(EHttpTransportType httpClient, IUserPortalRestClientConfig config)	This method returns the ApiBundle with the REST client for the public security API.
UserPortalClient<ApiBundle>	publicUserClient(EHttpTransportType httpClient, IUserPortalRestClientConfig config)	This method returns the ApiBundle with the REST client for the public user portal API.
UserPortalClient<ApiBundle>	publicUserPortalClient(EHttpTransportType httpClient, IUserPortalRestClientConfig config)	This method returns the ApiBundle with the REST client for the public user portal API.

Methods inherited from class Object

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

Constructor Details

UserPortalRestClientManager

public UserPortalRestClientManager()

Method Details

publicFormClient

public UserPortalClient<ApiBundle> publicFormClient(EHttpTransportType httpClient,
 IUserPortalRestClientConfig config)
                                             throws IllegalStateException

This method returns the generated ApiBundle with the REST client for the public form API.

Parameters:

httpClient - Type of the HTTP client to use.

config - Configuration for the REST client.

Returns:

The REST client for the public form API.

Throws:

IllegalStateException

publicFormRecordClient

public UserPortalClient<ApiBundle> publicFormRecordClient(EHttpTransportType httpClient,
 IUserPortalRestClientConfig config)
                                                   throws IllegalStateException

This method returns the generated ApiBundle with the REST client for the public form record API.

Parameters:

httpClient - Type of the HTTP client to use.

config - Configuration for the REST client.

Returns:

The REST client for the public form record API.

Throws:

IllegalStateException

publicGenericClient

public UserPortalClient<ApiBundle> publicGenericClient(EHttpTransportType httpClient,
 IUserPortalRestClientConfig config)
                                                throws IllegalStateException

This method returns the generated ApiBundle with the REST client for the public user portal API.

Parameters:

httpClient - Type of the HTTP client to use.

config - Configuration for the REST client.

Returns:

The REST client for the public user portal API.

Throws:

IllegalStateException

publicSecurityClient

public UserPortalClient<ApiBundle> publicSecurityClient(EHttpTransportType httpClient,
 IUserPortalRestClientConfig config)
                                                 throws IllegalStateException

This method returns the ApiBundle with the REST client for the public security API.

Parameters:

httpClient - Type of the HTTP client to use.

config - Configuration for the REST client.

Returns:

The REST client for the public security API.

Throws:

IllegalStateException

publicUserClient

public UserPortalClient<ApiBundle> publicUserClient(EHttpTransportType httpClient,
 IUserPortalRestClientConfig config)
                                             throws IllegalStateException

This method returns the ApiBundle with the REST client for the public user portal API.

Parameters:

httpClient - Type of the HTTP client to use.

config - Configuration for the REST client.

Returns:

The REST client for the public user portal API.

Throws:

IllegalStateException

publicUserPortalClient

public UserPortalClient<ApiBundle> publicUserPortalClient(EHttpTransportType httpClient,
 IUserPortalRestClientConfig config)
                                                   throws IllegalStateException

This method returns the ApiBundle with the REST client for the public user portal API.

Parameters:

httpClient - Type of the HTTP client to use.

config - Configuration for the REST client.

Returns:

The REST client for the public user portal API.

Throws:

IllegalStateException