org.hippoecm.frontend.service

Interface IRestProxyService

All Superinterfaces:

org.apache.wicket.util.io.IClusterable, Serializable

public interface IRestProxyService
extends org.apache.wicket.util.io.IClusterable

Creates proxies to talk to REST services. Proxies are generated from classes that specify the API of the REST service to use.

Method Summary

Modifier and Type	Method and Description
<T> T	createRestProxy(Class<T> restServiceApiClass) Creates a proxy to a REST service based on the provided class
<T> T	createRestProxy(Class<T> restServiceApiClass, List<Object> additionalProviders) Creates a proxy to a REST service based on the provided class
<T> T	createSecureRestProxy(Class<T> restServiceApiClass) Creates a proxy to a REST service based on the provided class and security Subject A security Subject which indicates that the caller wants a security context to be propagated with the REST call
<T> T	createSecureRestProxy(Class<T> restServiceApiClass, List<Object> additionalProviders) Creates a proxy to a REST service based on the provided class and security Subject A security Subject which indicates that the caller wants a security context to be propagated with the REST call
String	getContextPath() The context path for this IRestProxyService.
String	getRestURI()

Method Detail

getContextPath

String getContextPath()

The context path for this IRestProxyService. The context path for ROOT.war is an empty String. Other allowed values must start with a '/' and are not allowed to have another '/'. If not configured, null is returned

Returns:

the context path for which this rest proxy service is available, optionally null when not configured

getRestURI

String getRestURI()

Returns:

the base rest URI for this IRestProxyService

createRestProxy

<T> T createRestProxy(Class<T> restServiceApiClass)

Creates a proxy to a REST service based on the provided class

Type Parameters:

T - the generic type of the REST service API class.

Parameters:

restServiceApiClass - the class representing the REST service API.

Returns:

a proxy to the REST service represented by the given class, or null if no proxy could be created.

createSecureRestProxy

<T> T createSecureRestProxy(Class<T> restServiceApiClass)

Creates a proxy to a REST service based on the provided class and security Subject A security Subject which indicates that the caller wants a security context to be propagated with the REST call

Type Parameters:

T - the generic type of the REST service API class.

Parameters:

restServiceApiClass - the class representing the REST service API.

Returns:

a proxy to the REST service represented by the given class, or null if no proxy could be created.

createRestProxy

<T> T createRestProxy(Class<T> restServiceApiClass,
                      List<Object> additionalProviders)

Creates a proxy to a REST service based on the provided class

This version takes addition list of providers to configure the client proxy with

Type Parameters:

T - the generic type of the REST service API class.

Parameters:

restServiceApiClass - the class representing the REST service API.

additionalProviders - List of additional providers to configure client proxies with

Returns:

a proxy to the REST service represented by the given class, or null if no proxy could be created.

createSecureRestProxy

<T> T createSecureRestProxy(Class<T> restServiceApiClass,
                            List<Object> additionalProviders)

Creates a proxy to a REST service based on the provided class and security Subject A security Subject which indicates that the caller wants a security context to be propagated with the REST call

This version takes addition list of providers to configure the client proxy with

Type Parameters:

T - the generic type of the REST service API class.

Parameters:

restServiceApiClass - the class representing the REST service API.

additionalProviders - List of additional providers to configure client proxies with

Returns:

a proxy to the REST service represented by the given class, or null if no proxy could be created.