com.exalead.securityapi.client

Interface SecurityClient

All Known Implementing Classes:

SecurityClientImpl

public interface SecurityClient

Method Summary

Modifier and Type	Method and Description
com.exalead.security.sources.common.AuthenticationResult	authenticate(java.lang.String securitySource, java.lang.String login, java.lang.String password, boolean checkPassword) Retrieve security tokens for a user on a given security source.
com.exalead.security.sources.common.AuthenticationResult	authenticate(java.lang.String securitySource, java.lang.String login, java.lang.String password, boolean checkPassword, java.util.List<KeyValue> optParams) Retrieve security tokens for a user on a given security source.
com.exalead.security.sources.common.CustomSecurityCommandAnswer	customCommand(com.exalead.security.sources.common.CustomSecurityCommand command) Execute a custom command on a security source that have an IntrospectableComponent annotation
java.util.List<KeyValue>	getInfo(java.lang.String securitySource, java.util.List<KeyValue> kv) Custom method, its behavior depends of the implementation of the security source.
void	reset(java.lang.String securitySource) Restore the security source to its initial state.

Method Detail

authenticate

com.exalead.security.sources.common.AuthenticationResult authenticate(java.lang.String securitySource,
                                                                      java.lang.String login,
                                                                      java.lang.String password,
                                                                      boolean checkPassword)
                                                               throws com.exalead.security.sources.common.SecurityException

Retrieve security tokens for a user on a given security source.

Parameters:

securitySource - name of the security source on which the request will be performed

login - login of the user to authenticate

password - password of the user. Only needed if checkPassword is true

checkPassword - determines if the password is required for the authentication

Returns:

the result of authentication

Throws:

com.exalead.security.sources.common.SecurityException

authenticate

com.exalead.security.sources.common.AuthenticationResult authenticate(java.lang.String securitySource,
                                                                      java.lang.String login,
                                                                      java.lang.String password,
                                                                      boolean checkPassword,
                                                                      java.util.List<KeyValue> optParams)
                                                               throws com.exalead.security.sources.common.SecurityException

Retrieve security tokens for a user on a given security source.

Parameters:

securitySource - name of the security source on which the request will be performed

login - login of the user to authenticate

password - password of the user. Only needed if checkPassword is true

checkPassword - determines if the password is required for the authentication

optParams - additional parameters

Returns:

the result of authentication

Throws:

com.exalead.security.sources.common.SecurityException

getInfo

java.util.List<KeyValue> getInfo(java.lang.String securitySource,
                                 java.util.List<KeyValue> kv)
                          throws com.exalead.security.sources.common.SecurityException

Custom method, its behavior depends of the implementation of the security source.

Parameters:

securitySource - name of the security source on which the request will be performed

kv - list of KeyValue which can contain any information

Returns:

list of KeyValue which can contain any information

Throws:

com.exalead.security.sources.common.SecurityException

reset

void reset(java.lang.String securitySource)
    throws com.exalead.security.sources.common.SecurityException

Restore the security source to its initial state.

Parameters:

securitySource - name of the security source on which the request will be performed

Throws:

com.exalead.security.sources.common.SecurityException

customCommand

com.exalead.security.sources.common.CustomSecurityCommandAnswer customCommand(com.exalead.security.sources.common.CustomSecurityCommand command)
                                                                       throws com.exalead.security.sources.common.SecurityException

Execute a custom command on a security source that have an IntrospectableComponent annotation

Parameters:

command - definition of the command to execute

Returns:

custom command answer which contains a success flag and a KeyValue list

Throws:

com.exalead.security.sources.common.SecurityException

See Also:

IntrospectableComponent