net.bluemind.authentication.api

Interface IAuthentication

All Known Subinterfaces:

IInCoreAuthentication

All Known Implementing Classes:

Authentication

@Path(value="/auth")
public interface IAuthentication

Authentication service

Method Summary

Modifier and Type	Method and Description
AuthUser	getCurrentUser()
LoginResponse	login(java.lang.String login, java.lang.String password, java.lang.String origin) Try to log in user into Blue-Mind and create valid session on success
LoginResponse	loginWithParams(java.lang.String login, java.lang.String password, java.lang.String origin, java.lang.Boolean interactive) Try to log in user into Blue-Mind and create valid session on success
void	logout() Close a Blue-Mind session
void	ping() Refreshes the session, or throws exception if the SecurityContext is invalid.
LoginResponse	su(java.lang.String login) Create Blue-Mind access token for requested user. This token can be used for authenticate against Blue-Mind components
LoginResponse	suWithParams(java.lang.String login, java.lang.Boolean interactive)
ValidationKind	validate(java.lang.String login, java.lang.String password, java.lang.String origin) Validate credential

Method Detail

login

@POST
 @Path(value="login")
LoginResponse login(@QueryParam(value="login")
                                                java.lang.String login,
                                                java.lang.String password,
                                                @QueryParam(value="origin")
                                                java.lang.String origin)
                                         throws ServerFault

Try to log in user into Blue-Mind and create valid session on success

Parameters:

user - user login

password - user password

origin - Blue Mind application from which user try to log in

Returns:

LoginResponse

Throws:

ServerFault

loginWithParams

@POST
 @Path(value="loginWithParams")
LoginResponse loginWithParams(@QueryParam(value="login")
                                                                    java.lang.String login,
                                                                    java.lang.String password,
                                                                    @QueryParam(value="origin")
                                                                    java.lang.String origin,
                                                                    @QueryParam(value="interactive")
                                                                    java.lang.Boolean interactive)
                                                             throws ServerFault

Try to log in user into Blue-Mind and create valid session on success

Parameters:

user - user login

password - user password

origin - Blue Mind application from which user try to log in

interactive - interactive

Returns:

LoginResponse

Throws:

ServerFault

validate

@POST
 @Path(value="validate")
ValidationKind validate(@QueryParam(value="login")
                                                       java.lang.String login,
                                                       java.lang.String password,
                                                       @QueryParam(value="origin")
                                                       java.lang.String origin)
                                                throws ServerFault

Validate credential

Parameters:

user - user login

password - user password

origin - Blue Mind application from which user try to log in

Returns:

LoginResponse

Throws:

ServerFault

ping

@GET
 @Path(value="ping")
void ping()
                             throws ServerFault

Refreshes the session, or throws exception if the SecurityContext is invalid.

Throws:

ServerFault

logout

@POST
 @Path(value="logout")
void logout()
                                  throws ServerFault

Close a Blue-Mind session

Throws:

ServerFault

su

@POST
 @Path(value="_su")
LoginResponse su(@QueryParam(value="login")
                                           java.lang.String login)
                                    throws ServerFault

Create Blue-Mind access token for requested user.
This token can be used for authenticate against Blue-Mind components

Only token from global domain are allowed to do this.

Parameters:

login - requested login@domain access token

Returns:

LoginResponse

Throws:

ServerFault

suWithParams

@POST
 @Path(value="_suWithParams")
LoginResponse suWithParams(@QueryParam(value="login")
                                                               java.lang.String login,
                                                               @QueryParam(value="interactive")
                                                               java.lang.Boolean interactive)
                                                        throws ServerFault

Throws:

ServerFault

getCurrentUser

@GET
AuthUser getCurrentUser()
                      throws ServerFault

Throws:

ServerFault