Package com.devonfw.module.cxf.common.impl.client

Class SyncServiceClientFactoryCxf

java.lang.Object

com.devonfw.module.cxf.common.impl.client.SyncServiceClientFactoryCxf

All Implemented Interfaces:

SyncServiceClientFactory

public abstract class SyncServiceClientFactoryCxf
extends Object
implements SyncServiceClientFactory

Abstract base implementation of SyncServiceClientFactory for service clients using Apache CXF.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
SyncServiceClientFactoryCxf()

Method Summary

Modifier and Type	Method	Description
protected abstract <S> void	applyAspects(ServiceContext<S> context, S serviceClient, String serviceName)	Implementations should call the following methods: applyInterceptors(ServiceContext, InterceptorProvider, String) applyClientPolicy(ServiceContext, HTTPConduit) applyHeaders(ServiceContext, Object)
protected void	applyClientPolicy(ServiceContext<?> context, org.apache.cxf.transport.http.HTTPConduit conduit)
protected abstract void	applyHeaders(ServiceContext<?> context, Object serviceClient)	Applies headers to the given serviceClient.
protected void	applyInterceptors(ServiceContext<?> context, org.apache.cxf.interceptor.InterceptorProvider client, String serviceName)	Applies CXF interceptors to the given serviceClient.
<S> S	create(ServiceContext<S> context)
protected org.apache.cxf.transports.http.configuration.HTTPClientPolicy	createClientPolicy(ServiceContext<?> context)
protected abstract <S> S	createService(ServiceContext<S> context, String url, String serviceName)
protected String	createServiceName(ServiceContext<?> context)
protected abstract String	getServiceTypeFolderName()
protected String	getUrl(ServiceContext<?> context)
protected abstract boolean	isResponsibleForService(ServiceContext<?> context)

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncServiceClientFactoryCxf

public SyncServiceClientFactoryCxf()

Method Detail

create

public <S> S create(ServiceContext<S> context)

Specified by:

create in interface SyncServiceClientFactory

createService

protected abstract <S> S createService(ServiceContext<S> context,
                                       String url,
                                       String serviceName)

Type Parameters:

S - the generic type of the service API.

Parameters:

context - the ServiceContext.

url - the resolved end-point URL of the service to invoke.

serviceName - the service name.

Returns:

a new client stub for the service. See create(ServiceContext) for further details.

getUrl

protected String getUrl(ServiceContext<?> context)

Parameters:

context - the ServiceContext.

Returns:

the URL with additional post-processing such as resolving variables.

applyAspects

protected abstract <S> void applyAspects(ServiceContext<S> context,
                                         S serviceClient,
                                         String serviceName)

Implementations should call the following methods:

• applyInterceptors(ServiceContext, InterceptorProvider, String)
• applyClientPolicy(ServiceContext, HTTPConduit)
• applyHeaders(ServiceContext, Object)

Type Parameters:

S - the generic type of the service API.

Parameters:

context - the ServiceContext.

serviceClient - the created service client stub.

serviceName - the service name.

getServiceTypeFolderName

protected abstract String getServiceTypeFolderName()

Returns:

the resolved value for ServiceConstants.VARIABLE_TYPE such as e.g. ServiceConstants.URL_FOLDER_REST.

createClientPolicy

protected org.apache.cxf.transports.http.configuration.HTTPClientPolicy createClientPolicy(ServiceContext<?> context)

Parameters:

context - the ServiceContext.

Returns:

the HTTPClientPolicy for the configuration or null to use defaults.

createServiceName

protected String createServiceName(ServiceContext<?> context)

Parameters:

context - the ServiceContext.

Returns:

the display name of the service for exception or log messages.

applyInterceptors

protected void applyInterceptors(ServiceContext<?> context,
                                 org.apache.cxf.interceptor.InterceptorProvider client,
                                 String serviceName)

Applies CXF interceptors to the given serviceClient.

Parameters:

context - the ServiceContext.

client - the InterceptorProvider.

serviceName - the service name.

applyClientPolicy

protected void applyClientPolicy(ServiceContext<?> context,
                                 org.apache.cxf.transport.http.HTTPConduit conduit)

Parameters:

context - the ServiceContext.

conduit - the HTTPConduit where to apply the HTTPClientPolicy to.

applyHeaders

protected abstract void applyHeaders(ServiceContext<?> context,
                                     Object serviceClient)

Applies headers to the given serviceClient.

Parameters:

context - the ServiceContext.

serviceClient - the service client instance.

isResponsibleForService

protected abstract boolean isResponsibleForService(ServiceContext<?> context)

Parameters:

context - the ServiceContext.

Returns:

true if this implementation is responsibe for creating a service client corresponding to the given ServiceContext, false otherwise.