Package org.pac4j.config.builder

Class AbstractBuilder

java.lang.Object

org.pac4j.config.builder.AbstractBuilder

All Implemented Interfaces:

PropertiesConstants

Direct Known Subclasses:

CasClientBuilder, DbAuthenticatorBuilder, DirectClientBuilder, IndirectHttpClientBuilder, LdapAuthenticatorBuilder, OAuthBuilder, OidcClientBuilder, PropertiesConfigFactory, RestAuthenticatorBuilder, Saml2ClientBuilder, ShiroEncoderBuilder, SpringEncoderBuilder

public abstract class AbstractBuilder
extends java.lang.Object
implements PropertiesConstants

An abstract builder of the configuration.

Since:

2.0.0

Author:

Jerome Leleu

Nested Class Summary

Nested classes/interfaces inherited from interface org.pac4j.config.client.PropertiesConstants

PropertiesConstants.SpringEncoderType

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,org.pac4j.core.credentials.authenticator.Authenticator>	authenticators
protected static int	MAX_NUM_AUTHENTICATORS
protected static int	MAX_NUM_CLIENTS
protected static int	MAX_NUM_CUSTOM_PROPERTIES
protected static int	MAX_NUM_ENCODERS
protected java.util.Map<java.lang.String,java.lang.String>	properties

Fields inherited from interface org.pac4j.config.client.PropertiesConstants

ANONYMOUS, AUTHENTICATOR_TEST_TOKEN, AUTHENTICATOR_TEST_USERNAME_PASSWORD, CAS_LOGIN_URL, CAS_PROTOCOL, CLIENT_NAME, DB_ALLOW_POOL_SUSPENSION, DB_ATTRIBUTES, DB_AUTO_COMMIT, DB_CATALOG, DB_CONNECTION_INIT_SQL, DB_CONNECTION_TEST_QUERY, DB_CONNECTION_TIMEOUT, DB_CUSTOM_PARAM_KEY, DB_CUSTOM_PARAM_VALUE, DB_DATASOURCE_CLASS_NAME, DB_DATASOURCE_JNDI, DB_DRIVER_CLASS_NAME, DB_IDLE_TIMEOUT, DB_INITIALIZATION_FAIL_TIMEOUT, DB_ISOLATE_INTERNAL_QUERIES, DB_JDBC_URL, DB_LEAK_DETECTION_THRESHOLD, DB_LOGIN_TIMEOUT, DB_MAX_LIFETIME, DB_MAXIMUM_POOL_SIZE, DB_MINIMUM_IDLE, DB_PASSWORD, DB_PASSWORD_ENCODER, DB_POOL_NAME, DB_READ_ONLY, DB_REGISTER_MBEANS, DB_TRANSACTION_ISOLATION, DB_USER_ID_ATTRIBUTE, DB_USER_PASSWORD_ATTRIBUTE, DB_USERNAME, DB_USERNAME_ATTRIBUTE, DB_USERS_TABLE, DB_VALIDATION_TIMEOUT, DIRECTBASICAUTH_AUTHENTICATOR, DROPBOX_ID, DROPBOX_SECRET, FACEBOOK_FIELDS, FACEBOOK_ID, FACEBOOK_SCOPE, FACEBOOK_SECRET, FORMCLIENT_AUTHENTICATOR, FORMCLIENT_LOGIN_URL, FORMCLIENT_PASSWORD_PARAMETER, FORMCLIENT_USERNAME_PARAMETER, FOURSQUARE_ID, FOURSQUARE_SECRET, GITHUB_ID, GITHUB_SECRET, GOOGLE_ID, GOOGLE_SCOPE, GOOGLE_SECRET, INDIRECTBASICAUTH_AUTHENTICATOR, INDIRECTBASICAUTH_REALM_NAME, LDAP_ALLOW_MULTIPLE_DNS, LDAP_ATTRIBUTES, LDAP_BIND_CREDENTIAL, LDAP_BIND_DN, LDAP_BLOCK_WAIT_TIME, LDAP_CONNECT_TIMEOUT, LDAP_DN_FORMAT, LDAP_ENHANCE_WITH_ENTRY_RESOLVER, LDAP_FAIL_FAST, LDAP_IDLE_TIME, LDAP_KEYSTORE, LDAP_KEYSTORE_PASSWORD, LDAP_KEYSTORE_TYPE, LDAP_MAX_POOL_SIZE, LDAP_MIN_POOL_SIZE, LDAP_POOL_PASSIVATOR, LDAP_PRINCIPAL_ATTRIBUTE_ID, LDAP_PRINCIPAL_ATTRIBUTE_PASSWORD, LDAP_PRUNE_PERIOD, LDAP_SASL_AUTHORIZATION_ID, LDAP_SASL_MECHANISM, LDAP_SASL_QUALITY_OF_PROTECTION, LDAP_SASL_REALM, LDAP_SASL_SECURITY_STRENGTH, LDAP_SUBTREE_SEARCH, LDAP_TRUST_CERTIFICATES, LDAP_TYPE, LDAP_URL, LDAP_USE_START_TLS, LDAP_USER_FILTER, LDAP_USERS_DN, LDAP_VALIDATE_ON_CHECKOUT, LDAP_VALIDATE_PERIOD, LDAP_VALIDATE_PERIODICALLY, LINKEDIN_FIELDS, LINKEDIN_ID, LINKEDIN_SCOPE, LINKEDIN_SECRET, OAUTH2_AUTH_URL, OAUTH2_CLIENT_AUTHENTICATION_METHOD, OAUTH2_ID, OAUTH2_PROFILE_ID, OAUTH2_PROFILE_PATH, OAUTH2_PROFILE_URL, OAUTH2_SCOPE, OAUTH2_SECRET, OAUTH2_TOKEN_URL, OAUTH2_WITH_STATE, OIDC_AZURE_TENANT, OIDC_AZURE_TYPE, OIDC_CLIENT_AUTHENTICATION_METHOD, OIDC_CUSTOM_PARAM_KEY, OIDC_CUSTOM_PARAM_VALUE, OIDC_DISCOVERY_URI, OIDC_GOOGLE_TYPE, OIDC_ID, OIDC_MAX_CLOCK_SKEW, OIDC_PREFERRED_JWS_ALGORITHM, OIDC_RESPONSE_MODE, OIDC_RESPONSE_TYPE, OIDC_SCOPE, OIDC_SECRET, OIDC_TYPE, OIDC_USE_NONCE, REST_URL, SAML_ACCEPTED_SKEW, SAML_ASSERTION_CONSUMER_SERVICE_INDEX, SAML_ATTRIBUTE_AS_ID, SAML_AUTHN_CONTEXT_CLASS_REFS, SAML_AUTHN_REQUEST_BINDING_TYPE, SAML_AUTHN_REQUEST_SIGNED, SAML_COMPARISON_TYPE, SAML_FORCE_AUTH, SAML_IDENTITY_PROVIDER_METADATA_PATH, SAML_ISSUER_FORMAT, SAML_KEYSTORE_ALIAS, SAML_KEYSTORE_PASSWORD, SAML_KEYSTORE_PATH, SAML_MAPPED_ATTRIBUTES, SAML_MAXIMUM_AUTHENTICATION_LIFETIME, SAML_NAMEID_ATTRIBUTE, SAML_PASSIVE, SAML_PRIVATE_KEY_PASSWORD, SAML_RESPONSE_BINDING_TYPE, SAML_SERVICE_PROVIDER_ENTITY_ID, SAML_SERVICE_PROVIDER_METADATA_PATH, SAML_WANTS_ASSERTIONS_SIGNED, SAML_WANTS_RESPONSES_SIGNED, SHIRO_ENCODER, SHIRO_ENCODER_GENERATE_PUBLIC_SALT, SHIRO_ENCODER_HASH_ALGORITHM_NAME, SHIRO_ENCODER_HASH_ITERATIONS, SHIRO_ENCODER_PRIVATE_SALT, SPRING_ENCODER, SPRING_ENCODER_BCRYPT_LENGTH, SPRING_ENCODER_PBKDF2_HASH_WIDTH, SPRING_ENCODER_PBKDF2_ITERATIONS, SPRING_ENCODER_PBKDF2_SECRET, SPRING_ENCODER_SCRYPT_CPU_COST, SPRING_ENCODER_SCRYPT_KEY_LENGTH, SPRING_ENCODER_SCRYPT_MEMORY_COST, SPRING_ENCODER_SCRYPT_PARALLELIZATION, SPRING_ENCODER_SCRYPT_SALT_LENGTH, SPRING_ENCODER_STANDARD_SECRET, SPRING_ENCODER_TYPE, TWITTER_ID, TWITTER_SECRET, WINDOWSLIVE_ID, WINDOWSLIVE_SECRET, YAHOO_ID, YAHOO_SECRET

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder(java.util.Map<java.lang.String,java.lang.String> properties)
protected	AbstractBuilder(java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,org.pac4j.core.credentials.authenticator.Authenticator> authenticators)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	concat(java.lang.String value, int num)
protected boolean	containsProperty(java.lang.String name, int num)
protected org.pac4j.core.credentials.authenticator.Authenticator	getAuthenticator(java.lang.String name)
protected java.lang.String	getProperty(java.lang.String name)
protected java.lang.String	getProperty(java.lang.String name, int num)
protected boolean	getPropertyAsBoolean(java.lang.String name, int num)
protected int	getPropertyAsInteger(java.lang.String name, int num)
protected long	getPropertyAsLong(java.lang.String name, int num)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NUM_CLIENTS

protected static final int MAX_NUM_CLIENTS

See Also:

Constant Field Values

MAX_NUM_AUTHENTICATORS

protected static final int MAX_NUM_AUTHENTICATORS

See Also:

Constant Field Values

MAX_NUM_CUSTOM_PROPERTIES

protected static final int MAX_NUM_CUSTOM_PROPERTIES

See Also:

Constant Field Values

MAX_NUM_ENCODERS

protected static final int MAX_NUM_ENCODERS

See Also:

Constant Field Values

properties

protected final java.util.Map<java.lang.String,java.lang.String> properties

authenticators

protected final java.util.Map<java.lang.String,org.pac4j.core.credentials.authenticator.Authenticator> authenticators

Constructor Detail

AbstractBuilder

protected AbstractBuilder(java.util.Map<java.lang.String,java.lang.String> properties)

AbstractBuilder

protected AbstractBuilder(java.util.Map<java.lang.String,java.lang.String> properties,
                          java.util.Map<java.lang.String,org.pac4j.core.credentials.authenticator.Authenticator> authenticators)

Method Detail

concat

protected java.lang.String concat(java.lang.String value,
                                  int num)

getProperty

protected java.lang.String getProperty(java.lang.String name)

getProperty

protected java.lang.String getProperty(java.lang.String name,
                                       int num)

containsProperty

protected boolean containsProperty(java.lang.String name,
                                   int num)

getPropertyAsBoolean

protected boolean getPropertyAsBoolean(java.lang.String name,
                                       int num)

getPropertyAsInteger

protected int getPropertyAsInteger(java.lang.String name,
                                   int num)

getPropertyAsLong

protected long getPropertyAsLong(java.lang.String name,
                                 int num)

getAuthenticator

protected org.pac4j.core.credentials.authenticator.Authenticator getAuthenticator(java.lang.String name)