org.ff4j.web

Class ApiConfig

java.lang.Object

org.ff4j.web.ApiConfig

All Implemented Interfaces:

FF4jProvider

public class ApiConfig
extends Object
implements FF4jProvider

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

Author:

Cedrick Lunven (@clunven)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ApiConfig	createApiKey(String apiKey, boolean read, boolean write, Set<String> usrPerm) Helper method to create an apiKey.
ApiConfig	createUser(String userName, String password, boolean read, boolean write, Set<String> usrPerm) Helper method to create a user.
Set<String>	getApiKeys() Getter accessor for attribute 'apiKeys'.
String	getContextPath() Getter accessor for attribute 'contextPath'.
FF4j	getFF4j() Initialize the FF4j object to be injected within console.
String	getHost() Getter accessor for attribute 'host'.
Map<String,Set<String>>	getPermissions() Getter accessor for attribute 'permissions'.
int	getPort() Getter accessor for attribute 'port'.
Map<String,String>	getUsers() Getter accessor for attribute 'users'.
String	getVersion() Getter accessor for attribute 'version'.
String	getWebContext() Getter accessor for attribute 'webContext'.
boolean	isAuthenticate() Getter accessor for attribute 'authenticate'.
boolean	isAutorize() Getter accessor for attribute 'autorize'.
boolean	isDocumentation() Getter accessor for attribute 'documentation'.
boolean	isLog() Getter accessor for attribute 'log'.
void	setApiKeys(Set<String> apiKeys) Setter accessor for attribute 'apiKeys'.
void	setAuthenticate(boolean authenticate) Setter accessor for attribute 'authenticate'.
void	setAutorize(boolean autorize) Setter accessor for attribute 'autorize'.
void	setDocumentation(boolean documentation) Setter accessor for attribute 'documentation'.
void	setFF4j(FF4j fF4j) Setter accessor for attribute 'fF4j'.
void	setHost(String host) Setter accessor for attribute 'host'.
void	setLog(boolean log) Setter accessor for attribute 'log'.
void	setPermissions(Map<String,Set<String>> permissions) Setter accessor for attribute 'permissions'.
void	setPort(int port) Setter accessor for attribute 'port'.
void	setUsers(Map<String,String> users) Setter accessor for attribute 'users'.
void	setVersion(String version) Setter accessor for attribute 'version'.
void	setWebContext(String webContext) Setter accessor for attribute 'webContext'.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiConfig

public ApiConfig()

Default constructor.

ApiConfig

public ApiConfig(FF4j ff)

Initialized with a ff4j.

Method Detail

createUser

public ApiConfig createUser(String userName,
                            String password,
                            boolean read,
                            boolean write,
                            Set<String> usrPerm)

Helper method to create a user.

Parameters:

userName - target username

password - target password

read - role read

write - role write

createApiKey

public ApiConfig createApiKey(String apiKey,
                              boolean read,
                              boolean write,
                              Set<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 '

getUsers

public Map<String,String> getUsers()

Getter accessor for attribute 'users'.

Returns:

current value of 'users'

setUsers

public void setUsers(Map<String,String> users)

Setter accessor for attribute 'users'.

Parameters:

users - new value for 'users '

getApiKeys

public Set<String> getApiKeys()

Getter accessor for attribute 'apiKeys'.

Returns:

current value of 'apiKeys'

setApiKeys

public void setApiKeys(Set<String> apiKeys)

Setter accessor for attribute 'apiKeys'.

Parameters:

apiKeys - new value for 'apiKeys '

getPermissions

public Map<String,Set<String>> getPermissions()

Getter accessor for attribute 'permissions'.

Returns:

current value of 'permissions'

setPermissions

public void setPermissions(Map<String,Set<String>> permissions)

Setter accessor for attribute 'permissions'.

Parameters:

permissions - new value for 'permissions '

getContextPath

public String getContextPath()

Getter accessor for attribute 'contextPath'.

Returns:

current value of 'contextPath'

getHost

public String getHost()

Getter accessor for attribute 'host'.

Returns:

current value of 'host'

setHost

public void setHost(String host)

Setter accessor for attribute 'host'.

Parameters:

host - new value for 'host '

getPort

public int getPort()

Getter accessor for attribute 'port'.

Returns:

current value of 'port'

setPort

public void setPort(int port)

Setter accessor for attribute 'port'.

Parameters:

port - new value for 'port '

getWebContext

public String getWebContext()

Getter accessor for attribute 'webContext'.

Returns:

current value of 'webContext'

setWebContext

public void setWebContext(String webContext)

Setter accessor for attribute 'webContext'.

Parameters:

webContext - new value for 'webContext '

isAuthenticate

public boolean isAuthenticate()

Getter accessor for attribute 'authenticate'.

Returns:

current value of 'authenticate'

setAuthenticate

public void setAuthenticate(boolean authenticate)

Setter accessor for attribute 'authenticate'.

Parameters:

authenticate - new value for 'authenticate '

isAutorize

public boolean isAutorize()

Getter accessor for attribute 'autorize'.

Returns:

current value of 'autorize'

setAutorize

public void setAutorize(boolean autorize)

Setter accessor for attribute 'autorize'.

Parameters:

autorize - new value for 'autorize '

isLog

public boolean isLog()

Getter accessor for attribute 'log'.

Returns:

current value of 'log'

setLog

public void setLog(boolean log)

Setter accessor for attribute 'log'.

Parameters:

log - new value for 'log '

isDocumentation

public boolean isDocumentation()

Getter accessor for attribute 'documentation'.

Returns:

current value of 'documentation'

setDocumentation

public void setDocumentation(boolean documentation)

Setter accessor for attribute 'documentation'.

Parameters:

documentation - new value for 'documentation '

getVersion

public String getVersion()

Getter accessor for attribute 'version'.

Returns:

current value of 'version'

setVersion

public void setVersion(String version)

Setter accessor for attribute 'version'.

Parameters:

version - new value for 'version '