Package org.apache.cxf.frontend
Class ClientProxyFactoryBean
- java.lang.Object
-
- org.apache.cxf.interceptor.AbstractBasicInterceptorProvider
-
- org.apache.cxf.frontend.ClientProxyFactoryBean
-
- All Implemented Interfaces:
org.apache.cxf.interceptor.InterceptorProvider
- Direct Known Subclasses:
ClientProxyFactoryBeanDefinitionParser.SpringClientProxyFactoryBean
public class ClientProxyFactoryBean extends org.apache.cxf.interceptor.AbstractBasicInterceptorProvider
This class will create a client for you which implements the specified service class. Example:ClientProxyFactoryBean factory = new ClientProxyFactoryBean(); factory.setServiceClass(YourServiceInterface.class); YourServiceInterface client = (YourServiceInterface) factory.create();
To access the underlying Client object:Client cxfClient = ClientProxy.getClient(client);
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
configured
-
Constructor Summary
Constructors Constructor Description ClientProxyFactoryBean()
ClientProxyFactoryBean(ClientFactoryBean fact)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ClientProxy
clientClientProxy(org.apache.cxf.endpoint.Client c)
Object
create()
Creates a proxy object that can be used to make remote invocations.<ProxyServiceType>
ProxyServiceTypecreate(Class<ProxyServiceType> serviceClass)
Create a proxy object that implements a specified Service Endpoint Interface.String
getAddress()
org.apache.cxf.binding.BindingConfiguration
getBindingConfig()
String
getBindingId()
org.apache.cxf.Bus
getBus()
ClientFactoryBean
getClientFactoryBean()
org.apache.cxf.endpoint.ConduitSelector
getConduitSelector()
protected String
getConfiguredName()
org.apache.cxf.databinding.DataBinding
getDataBinding()
QName
getEndpointName()
List<org.apache.cxf.feature.Feature>
getFeatures()
protected Class<?>[]
getImplementingClasses()
String
getPassword()
Map<String,Object>
getProperties()
Returns the property map for the proxy factory.Class<?>
getServiceClass()
org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean
getServiceFactory()
QName
getServiceName()
Returns the QName of the WSDL service the proxy implementsString
getTransportId()
String
getUsername()
String
getWsdlLocation()
String
getWsdlURL()
void
initFeatures()
void
setAddress(String add)
void
setBindingConfig(org.apache.cxf.binding.BindingConfiguration config)
void
setBindingId(String bind)
void
setBus(org.apache.cxf.Bus bus)
void
setClientFactoryBean(ClientFactoryBean clientFactoryBean)
void
setConduitSelector(org.apache.cxf.endpoint.ConduitSelector selector)
void
setDataBinding(org.apache.cxf.databinding.DataBinding dataBinding)
void
setEndpointName(QName endpointName)
void
setFeatures(List<? extends org.apache.cxf.feature.Feature> f)
void
setPassword(String password)
void
setProperties(Map<String,Object> properties)
Specifies a set of properties used to configure the proxies provided by the factory.void
setServiceClass(Class<?> serviceClass)
Specifies the class representing the SEI the proxy implements.void
setServiceFactory(org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean sf)
void
setServiceName(QName serviceName)
Specifies the QName of the WSDL service the proxy implements.void
setTransportId(String transportId)
void
setUsername(String username)
void
setWsdlLocation(String wsdlURL)
Specifies the URL where the proxy can find the WSDL defining the service the proxy implements.void
setWsdlURL(String wsdlURL)
Specifies the URL where the proxy can find the WSDL defining the service the proxy implements.
-
-
-
Constructor Detail
-
ClientProxyFactoryBean
public ClientProxyFactoryBean()
-
ClientProxyFactoryBean
public ClientProxyFactoryBean(ClientFactoryBean fact)
-
-
Method Detail
-
initFeatures
public void initFeatures()
-
create
public <ProxyServiceType> ProxyServiceType create(Class<ProxyServiceType> serviceClass)
Create a proxy object that implements a specified Service Endpoint Interface. This method is a combination ofsetServiceClass(Class)
andcreate()
.- Type Parameters:
ProxyServiceType
- The type for the SEI.- Parameters:
serviceClass
- The Java class object representing the interface you want.- Returns:
- the proxy.
-
getConfiguredName
protected String getConfiguredName()
-
create
public Object create()
Creates a proxy object that can be used to make remote invocations.- Returns:
- the proxy. You must cast the returned object to the appropriate class before using it.
-
getImplementingClasses
protected Class<?>[] getImplementingClasses()
-
clientClientProxy
protected ClientProxy clientClientProxy(org.apache.cxf.endpoint.Client c)
-
getClientFactoryBean
public ClientFactoryBean getClientFactoryBean()
-
setClientFactoryBean
public void setClientFactoryBean(ClientFactoryBean clientFactoryBean)
-
getPassword
public String getPassword()
-
setPassword
public void setPassword(String password)
-
getServiceClass
public Class<?> getServiceClass()
-
setServiceClass
public void setServiceClass(Class<?> serviceClass)
Specifies the class representing the SEI the proxy implements.- Parameters:
serviceClass
- the SEI's class
-
getUsername
public String getUsername()
-
setUsername
public void setUsername(String username)
-
getWsdlLocation
public String getWsdlLocation()
-
setWsdlLocation
public void setWsdlLocation(String wsdlURL)
Specifies the URL where the proxy can find the WSDL defining the service the proxy implements.- Parameters:
wsdlURL
- a string containing the WSDL's URL
-
getWsdlURL
public String getWsdlURL()
-
setWsdlURL
public void setWsdlURL(String wsdlURL)
Specifies the URL where the proxy can find the WSDL defining the service the proxy implements.- Parameters:
wsdlURL
- a string containing the WSDL's URL
-
getEndpointName
public QName getEndpointName()
-
setEndpointName
public void setEndpointName(QName endpointName)
-
getServiceName
public QName getServiceName()
Returns the QName of the WSDL service the proxy implements- Returns:
- the WSDL service's QName
-
setServiceName
public void setServiceName(QName serviceName)
Specifies the QName of the WSDL service the proxy implements. The service must exist or an error will result.- Parameters:
serviceName
- the QName of the service for the proxy
-
getAddress
public String getAddress()
-
setAddress
public void setAddress(String add)
-
getConduitSelector
public org.apache.cxf.endpoint.ConduitSelector getConduitSelector()
-
setConduitSelector
public void setConduitSelector(org.apache.cxf.endpoint.ConduitSelector selector)
-
setBindingId
public void setBindingId(String bind)
-
getBindingId
public String getBindingId()
-
setTransportId
public void setTransportId(String transportId)
-
getTransportId
public String getTransportId()
-
getServiceFactory
public org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean getServiceFactory()
-
setServiceFactory
public void setServiceFactory(org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean sf)
-
getBus
public org.apache.cxf.Bus getBus()
-
setBus
public void setBus(org.apache.cxf.Bus bus)
-
getProperties
public Map<String,Object> getProperties()
Returns the property map for the proxy factory.- Returns:
- the property map
-
setProperties
public void setProperties(Map<String,Object> properties)
Specifies a set of properties used to configure the proxies provided by the factory. These properties include things like adding a namespace map to the JAXB databinding.- Parameters:
properties
- the property map
-
getFeatures
public List<org.apache.cxf.feature.Feature> getFeatures()
-
setFeatures
public void setFeatures(List<? extends org.apache.cxf.feature.Feature> f)
-
getDataBinding
public org.apache.cxf.databinding.DataBinding getDataBinding()
-
setDataBinding
public void setDataBinding(org.apache.cxf.databinding.DataBinding dataBinding)
-
setBindingConfig
public void setBindingConfig(org.apache.cxf.binding.BindingConfiguration config)
-
getBindingConfig
public org.apache.cxf.binding.BindingConfiguration getBindingConfig()
-
-