Package org.apache.syncope.client.lib

Class SyncopeClientFactoryBean

java.lang.Object

org.apache.syncope.client.lib.SyncopeClientFactoryBean

public class SyncopeClientFactoryBean
extends Object

Factory bean for creating instances of SyncopeClient. Supports Spring-bean configuration and override via subclassing (see protected methods).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyncopeClientFactoryBean.ContentType

Constructor Summary

Constructors

Constructor	Description
SyncopeClientFactoryBean()

Method Summary

Modifier and Type	Method	Description
SyncopeClient	create(String jwt)	Builds client instance which will be passing the provided value in the HttpHeaders.AUTHORIZATION request header.
SyncopeClient	create(String username, String password)	Builds client instance with the given credentials.
SyncopeClient	create(AuthenticationHandler handler)	Builds client instance with the given authentication handler.
SyncopeAnonymousClient	createAnonymous(String username, String password)	Builds client instance with the given anonymous credentials.
protected static RestClientExceptionMapper	defaultExceptionMapper()
protected static org.apache.cxf.transports.http.configuration.HTTPClientPolicy	defaultHTTPClientPolicy()
protected static com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider	defaultJsonProvider()
protected org.apache.cxf.jaxrs.client.JAXRSClientFactoryBean	defaultRestClientFactoryBean()
protected static com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider	defaultXmlProvider()
protected static com.fasterxml.jackson.jaxrs.yaml.JacksonYAMLProvider	defaultYamlProvider()
String	getAddress()
SyncopeClientFactoryBean.ContentType	getContentType()
String	getDomain()
RestClientExceptionMapper	getExceptionMapper()
org.apache.cxf.transports.http.configuration.HTTPClientPolicy	getHttpClientPolicy()
com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider	getJsonProvider()
org.apache.cxf.jaxrs.client.JAXRSClientFactoryBean	getRestClientFactoryBean()
TLSClientParameters	getTlsClientParameters()
com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider	getXmlProvider()
com.fasterxml.jackson.jaxrs.yaml.JacksonYAMLProvider	getYamlProvider()
boolean	isUseCompression()
SyncopeClientFactoryBean	setAddress(String address)
SyncopeClientFactoryBean	setContentType(String contentType)
SyncopeClientFactoryBean	setContentType(SyncopeClientFactoryBean.ContentType contentType)
SyncopeClientFactoryBean	setDomain(String domain)
SyncopeClientFactoryBean	setExceptionMapper(RestClientExceptionMapper exceptionMapper)
SyncopeClientFactoryBean	setHttpClientPolicy(org.apache.cxf.transports.http.configuration.HTTPClientPolicy httpClientPolicy)
void	setJsonProvider(com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider jsonProvider)
SyncopeClientFactoryBean	setRestClientFactoryBean(org.apache.cxf.jaxrs.client.JAXRSClientFactoryBean restClientFactoryBean)
SyncopeClientFactoryBean	setTlsClientParameters(TLSClientParameters tlsClientParameters)	Sets the client TLS configuration.
SyncopeClientFactoryBean	setUseCompression(boolean useCompression)	Sets the given service instance for transparent gzip Content-Encoding handling.
void	setXmlProvider(com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider xmlProvider)
void	setYamlProvider(com.fasterxml.jackson.jaxrs.yaml.JacksonYAMLProvider yamlProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncopeClientFactoryBean

public SyncopeClientFactoryBean()

Method Detail

defaultJsonProvider

protected static com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider defaultJsonProvider()

defaultXmlProvider

protected static com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider defaultXmlProvider()

defaultYamlProvider

protected static com.fasterxml.jackson.jaxrs.yaml.JacksonYAMLProvider defaultYamlProvider()

defaultExceptionMapper

protected static RestClientExceptionMapper defaultExceptionMapper()

defaultHTTPClientPolicy

protected static org.apache.cxf.transports.http.configuration.HTTPClientPolicy defaultHTTPClientPolicy()

defaultRestClientFactoryBean

protected org.apache.cxf.jaxrs.client.JAXRSClientFactoryBean defaultRestClientFactoryBean()

getJsonProvider

public com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider getJsonProvider()

setJsonProvider

public void setJsonProvider(com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider jsonProvider)

getXmlProvider

public com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider getXmlProvider()

setXmlProvider

public void setXmlProvider(com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider xmlProvider)

getYamlProvider

public com.fasterxml.jackson.jaxrs.yaml.JacksonYAMLProvider getYamlProvider()

setYamlProvider

public void setYamlProvider(com.fasterxml.jackson.jaxrs.yaml.JacksonYAMLProvider yamlProvider)

getExceptionMapper

public RestClientExceptionMapper getExceptionMapper()

setExceptionMapper

public SyncopeClientFactoryBean setExceptionMapper(RestClientExceptionMapper exceptionMapper)

getAddress

public String getAddress()

setAddress

public SyncopeClientFactoryBean setAddress(String address)

getContentType

public SyncopeClientFactoryBean.ContentType getContentType()

setContentType

public SyncopeClientFactoryBean setContentType(SyncopeClientFactoryBean.ContentType contentType)

setContentType

public SyncopeClientFactoryBean setContentType(String contentType)

getDomain

public String getDomain()

setDomain

public SyncopeClientFactoryBean setDomain(String domain)

setUseCompression

public SyncopeClientFactoryBean setUseCompression(boolean useCompression)

Sets the given service instance for transparent gzip Content-Encoding handling.

Parameters:

useCompression - whether transparent gzip Content-Encoding handling is to be enabled

Returns:

the current instance

isUseCompression

public boolean isUseCompression()

setHttpClientPolicy

public SyncopeClientFactoryBean setHttpClientPolicy(org.apache.cxf.transports.http.configuration.HTTPClientPolicy httpClientPolicy)

getHttpClientPolicy

public org.apache.cxf.transports.http.configuration.HTTPClientPolicy getHttpClientPolicy()

setTlsClientParameters

public SyncopeClientFactoryBean setTlsClientParameters(TLSClientParameters tlsClientParameters)

Sets the client TLS configuration.

Parameters:

tlsClientParameters - client TLS configuration

Returns:

the current instance

getTlsClientParameters

public TLSClientParameters getTlsClientParameters()

getRestClientFactoryBean

public org.apache.cxf.jaxrs.client.JAXRSClientFactoryBean getRestClientFactoryBean()

setRestClientFactoryBean

public SyncopeClientFactoryBean setRestClientFactoryBean(org.apache.cxf.jaxrs.client.JAXRSClientFactoryBean restClientFactoryBean)

create

public SyncopeClient create(String username,
                            String password)

Builds client instance with the given credentials. Such credentials will be used only to obtain a valid JWT in the HttpHeaders.AUTHORIZATION header;

Parameters:

username - username

password - password

Returns:

client instance with the given credentials

create

public SyncopeClient create(String jwt)

Builds client instance which will be passing the provided value in the HttpHeaders.AUTHORIZATION request header.

Parameters:

jwt - value received after login, in the RESTHeaders.TOKEN response header

Returns:

client instance which will be passing the provided value in the HttpHeaders.AUTHORIZATION request header

create

public SyncopeClient create(AuthenticationHandler handler)

Builds client instance with the given authentication handler.

Parameters:

handler - authentication handler

Returns:

client instance with the given authentication handler

createAnonymous

public SyncopeAnonymousClient createAnonymous(String username,
                                              String password)

Builds client instance with the given anonymous credentials.

Parameters:

username - username

password - password

Returns:

client instance with the given credentials