Package ch.bztf.m226blb1.Auth

Class AuthController

java.lang.Object

ch.bztf.m226blb1.Auth.AuthController

@RestController
@RequestMapping("/auth")
public class AuthController
extends Object

The rest controller for handling authentication.

See Also:

• AuthService

API Note:

All methods return a ResponseHandler with the status and the data

Constructor Summary

Constructors

Constructor	Description
AuthController()

Method Summary

Modifier and Type	Method	Description
ResponseHandler<String>	deleteKey(@Size(min=128,max=128) String apiKey)	Deletes an account with the given API-key
ResponseHandler<String>	generateKey(AuthAccount account)	Post method for generating an API-key for the given account.
ResponseHandler<String>	regenerateKey(AuthAccount account)	Put method for regenerating an API-key for the given account

Methods inherited from class java.lang.Object

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

Constructor Details

AuthController

public AuthController()

Method Details

generateKey

@PostMapping("/generate")
public ResponseHandler<String> generateKey(@RequestBody
 AuthAccount account)

Post method for generating an API-key for the given account.

Parameters:

account - with the credentials needed to generate an account

Returns:

the API-key

See Also:

• AuthService.createAccount(AuthAccount)

regenerateKey

@PutMapping("/generate")
public ResponseHandler<String> regenerateKey(@RequestBody
 AuthAccount account)

Put method for regenerating an API-key for the given account

Parameters:

account - with the existing API-key and logging data

Returns:

the new API-key

See Also:

• AuthService.regenerateAPIKey(AuthAccount)

deleteKey

@DeleteMapping("/delete")
public ResponseHandler<String> deleteKey(@RequestParam(name="apiKey",required=false) @RequestHeader(name="Authorization",required=false) @Size(min=128,max=128)
 @Size(min=128,max=128) String apiKey)

Deletes an account with the given API-key

Parameters:

apiKey - the API-key of the account to delete

Returns:

the status of the deletion

See Also:

• AuthService.deleteAccount(String)