org.ff4j.web.api.conf

Class FF4jApiConfig

java.lang.Object

org.ff4j.web.api.conf.FF4jApiConfig

All Implemented Interfaces:

FF4JProvider, FF4jWebConstants

public class FF4jApiConfig
extends java.lang.Object
implements FF4JProvider, FF4jWebConstants

Bean to configure security for the WebAPI. This custom bean is defined to limit dependencies to Spring security for instance.

Author:

Cedrick LUNVEN

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log logger for this class.

Fields inherited from interface org.ff4j.web.api.FF4jWebConstants

HEADER_AUTHORIZATION, LOCATION, MANIFEST_FILE, MANIFEST_VERSION, OPERATION_ADDGROUP, OPERATION_CHECK, OPERATION_DISABLE, OPERATION_ENABLE, OPERATION_GRANTROLE, OPERATION_REMOVEGROUP, OPERATION_REMOVEROLE, PARAM_AUTHKEY, PARAM_END, PARAM_NBPOINTS, PARAM_START, PARAM_UID, POST_PARAMNAME_CUSTOM_PREFIX, POST_PARAMNAME_FEATURE_UID, RESOURCE_BAR, RESOURCE_CACHE, RESOURCE_FEATURES, RESOURCE_FF4J, RESOURCE_GROUPS, RESOURCE_MONITORING, RESOURCE_PIE, RESOURCE_SECURITY, RESOURCE_STORE, ROLE_READ, ROLE_WRITE

Constructor Summary

Constructors

Constructor and Description
FF4jApiConfig() Default constructor.
FF4jApiConfig(FF4j ff) Initialized with a ff4j.

Method Summary

Modifier and Type	Method and Description
FF4jApiConfig	createApiKey(java.lang.String apiKey, boolean read, boolean write, java.util.Set<java.lang.String> usrPerm) Helper method to create an apiKey.
FF4jApiConfig	createUser(java.lang.String userName, java.lang.String password, boolean read, boolean write, java.util.Set<java.lang.String> usrPerm) Helper method to create a user.
FF4jApiConfig	disableAuthentication()
FF4jApiConfig	disableAuthorization()
FF4jApiConfig	disableDocumentation() Fluent helper to work with API settings.
FF4jApiConfig	enableAuthentication()
FF4jApiConfig	enableAuthorization()
FF4jApiConfig	enableDocumentation() Fluent helper to work with API settings.
java.util.Set<java.lang.String>	getApiKeys() Getter accessor for attribute 'apiKeys'.
java.lang.String	getContextPath() Getter accessor for attribute 'contextPath'.
FF4j	getFF4j() Initialize the FF4j object to be injected within console.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getPermissions() Getter accessor for attribute 'permissions'.
java.util.Map<java.lang.String,java.lang.String>	getUsers() Getter accessor for attribute 'users'.
java.lang.String	getVersionNumber() Getter accessor for attribute 'versionNumber'.
boolean	isEnableAuthentication() Getter accessor for attribute 'enableAuthentication'.
boolean	isEnableAuthorization() Getter accessor for attribute 'enableAuthorization'.
boolean	isEnableDocumentation() Getter accessor for attribute 'enableDocumentation'.
boolean	isEnableLogging() Getter accessor for attribute 'enableLogging'.
void	setApiKeys(java.util.Set<java.lang.String> apiKeys) Setter accessor for attribute 'apiKeys'.
void	setContextPath(java.lang.String contextPath) Setter accessor for attribute 'contextPath'.
void	setEnableAuthentication(boolean enableAuthentication) Setter accessor for attribute 'enableAuthentication'.
void	setEnableAuthorization(boolean enableAuthorization) Setter accessor for attribute 'enableAuthorization'.
void	setEnableDocumentation(boolean enableDocumentation) Setter accessor for attribute 'enableDocumentation'.
void	setEnableLogging(boolean enableLogging) Setter accessor for attribute 'enableLogging'.
void	setFF4j(FF4j fF4j) Setter accessor for attribute 'fF4j'.
void	setPermissions(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> permissions) Setter accessor for attribute 'permissions'.
void	setUsers(java.util.Map<java.lang.String,java.lang.String> users) Setter accessor for attribute 'users'.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

logger for this class.

Constructor Detail

FF4jApiConfig

public FF4jApiConfig()

Default constructor.

FF4jApiConfig

public FF4jApiConfig(FF4j ff)

Initialized with a ff4j.

Method Detail

enableDocumentation

public FF4jApiConfig enableDocumentation()

Fluent helper to work with API settings.

Returns:

reference of current object

disableDocumentation

public FF4jApiConfig disableDocumentation()

Fluent helper to work with API settings.

Returns:

reference of current object

enableAuthentication

public FF4jApiConfig enableAuthentication()

disableAuthentication

public FF4jApiConfig disableAuthentication()

disableAuthorization

public FF4jApiConfig disableAuthorization()

enableAuthorization

public FF4jApiConfig enableAuthorization()

createUser

public FF4jApiConfig createUser(java.lang.String userName,
                                java.lang.String password,
                                boolean read,
                                boolean write,
                                java.util.Set<java.lang.String> usrPerm)

Helper method to create a user.

Parameters:

userName - target username

password - target password

read - role read

write - role write

createApiKey

public FF4jApiConfig createApiKey(java.lang.String apiKey,
                                  boolean read,
                                  boolean write,
                                  java.util.Set<java.lang.String> usrPerm)

Helper method to create an apiKey.

Parameters:

apiKey - target apiKey

read - role read

write - role write

getFF4j

public FF4j getFF4j()

Initialize the FF4j object to be injected within console.

Specified by:

getFF4j in interface FF4JProvider

Returns:

instance of ff4j for this application.

setFF4j

public void setFF4j(FF4j fF4j)

Setter accessor for attribute 'fF4j'.

Parameters:

fF4j - new value for 'fF4j '

isEnableAuthentication

public boolean isEnableAuthentication()

Getter accessor for attribute 'enableAuthentication'.

Returns:

current value of 'enableAuthentication'

setEnableAuthentication

public void setEnableAuthentication(boolean enableAuthentication)

Setter accessor for attribute 'enableAuthentication'.

Parameters:

enableAuthentication - new value for 'enableAuthentication '

isEnableAuthorization

public boolean isEnableAuthorization()

Getter accessor for attribute 'enableAuthorization'.

Returns:

current value of 'enableAuthorization'

setEnableAuthorization

public void setEnableAuthorization(boolean enableAuthorization)

Setter accessor for attribute 'enableAuthorization'.

Parameters:

enableAuthorization - new value for 'enableAuthorization '

isEnableLogging

public boolean isEnableLogging()

Getter accessor for attribute 'enableLogging'.

Returns:

current value of 'enableLogging'

setEnableLogging

public void setEnableLogging(boolean enableLogging)

Setter accessor for attribute 'enableLogging'.

Parameters:

enableLogging - new value for 'enableLogging '

getUsers

public java.util.Map<java.lang.String,java.lang.String> getUsers()

Getter accessor for attribute 'users'.

Returns:

current value of 'users'

setUsers

public void setUsers(java.util.Map<java.lang.String,java.lang.String> users)

Setter accessor for attribute 'users'.

Parameters:

users - new value for 'users '

getApiKeys

public java.util.Set<java.lang.String> getApiKeys()

Getter accessor for attribute 'apiKeys'.

Returns:

current value of 'apiKeys'

setApiKeys

public void setApiKeys(java.util.Set<java.lang.String> apiKeys)

Setter accessor for attribute 'apiKeys'.

Parameters:

apiKeys - new value for 'apiKeys '

getPermissions

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPermissions()

Getter accessor for attribute 'permissions'.

Returns:

current value of 'permissions'

setPermissions

public void setPermissions(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> permissions)

Setter accessor for attribute 'permissions'.

Parameters:

permissions - new value for 'permissions '

isEnableDocumentation

public boolean isEnableDocumentation()

Getter accessor for attribute 'enableDocumentation'.

Returns:

current value of 'enableDocumentation'

setEnableDocumentation

public void setEnableDocumentation(boolean enableDocumentation)

Setter accessor for attribute 'enableDocumentation'.

Parameters:

enableDocumentation - new value for 'enableDocumentation '

getVersionNumber

public java.lang.String getVersionNumber()

Getter accessor for attribute 'versionNumber'.

Returns:

current value of 'versionNumber'

getContextPath

public java.lang.String getContextPath()

Getter accessor for attribute 'contextPath'.

Returns:

current value of 'contextPath'

setContextPath

public void setContextPath(java.lang.String contextPath)

Setter accessor for attribute 'contextPath'.

Parameters:

contextPath - new value for 'contextPath '