Class SyncopeClientFactoryBean

  • public class SyncopeClientFactoryBean
    extends Object
    Factory bean for creating instances of SyncopeClient. Supports Spring-bean configuration and override via subclassing (see protected methods).
    • 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()
      • 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)
      • getAddress

        public String getAddress()
      • getDomain

        public String getDomain()
      • setUseCompression

        public SyncopeClientFactoryBean setUseCompression​(boolean useCompression)
        Sets the given service instance for transparent gzip Content-Encoding handling.
        useCompression - whether transparent gzip Content-Encoding handling is to be enabled
        the current instance
      • isUseCompression

        public boolean isUseCompression()
      • setTlsClientParameters

        public SyncopeClientFactoryBean setTlsClientParameters​(TLSClientParameters tlsClientParameters)
        Sets the client TLS configuration.
        tlsClientParameters - client TLS configuration
        the current instance
      • create

        public SyncopeClient create()
        Builds client instance with no authentication, for user self-registration and password reset.
        client instance with no authentication
      • 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;
        username - username
        password - password
        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.
        jwt - value received after login, in the RESTHeaders.TOKEN response header
        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.
        handler - authentication handler
        client instance with the given authentication handler