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 ofSyncopeClient
. 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SyncopeClient
create(String jwt)
Builds client instance which will be passing the provided value in theHttpHeaders.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 HTTPClientPolicy
defaultHTTPClientPolicy()
protected static com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider
defaultJsonProvider()
protected 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()
HTTPClientPolicy
getHttpClientPolicy()
com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider
getJsonProvider()
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(HTTPClientPolicy httpClientPolicy)
void
setJsonProvider(com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider jsonProvider)
SyncopeClientFactoryBean
setRestClientFactoryBean(JAXRSClientFactoryBean restClientFactoryBean)
SyncopeClientFactoryBean
setTlsClientParameters(TLSClientParameters tlsClientParameters)
Sets the client TLS configuration.SyncopeClientFactoryBean
setUseCompression(boolean useCompression)
Sets the given service instance for transparent gzipContent-Encoding
handling.void
setXmlProvider(com.fasterxml.jackson.jaxrs.xml.JacksonXMLProvider xmlProvider)
void
setYamlProvider(com.fasterxml.jackson.jaxrs.yaml.JacksonYAMLProvider yamlProvider)
-
-
-
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 HTTPClientPolicy defaultHTTPClientPolicy()
-
defaultRestClientFactoryBean
protected 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 gzipContent-Encoding
handling.- Parameters:
useCompression
- whether transparent gzipContent-Encoding
handling is to be enabled- Returns:
- the current instance
-
isUseCompression
public boolean isUseCompression()
-
setHttpClientPolicy
public SyncopeClientFactoryBean setHttpClientPolicy(HTTPClientPolicy httpClientPolicy)
-
getHttpClientPolicy
public 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 JAXRSClientFactoryBean getRestClientFactoryBean()
-
setRestClientFactoryBean
public SyncopeClientFactoryBean setRestClientFactoryBean(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 theHttpHeaders.AUTHORIZATION
header;- Parameters:
username
- usernamepassword
- 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 theHttpHeaders.AUTHORIZATION
request header.- Parameters:
jwt
- value received after login, in theRESTHeaders.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
- usernamepassword
- password- Returns:
- client instance with the given credentials
-
-