/
fr-login-failure.ts
64 lines (55 loc) · 1.45 KB
/
fr-login-failure.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
* @forgerock/javascript-sdk
*
* fr-login-failure.ts
*
* Copyright (c) 2020 ForgeRock. All rights reserved.
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
import FRPolicy from '../fr-policy';
import type { MessageCreator, ProcessedPropertyError } from '../fr-policy/interfaces';
import type { Step } from '../auth/interfaces';
import { StepType } from './enums';
import type { AuthResponse, FailureDetail } from './interfaces';
class FRLoginFailure implements AuthResponse {
/**
* The type of step.
*/
public readonly type = StepType.LoginFailure;
/**
* @param payload The raw payload returned by OpenAM
*/
constructor(public payload: Step) {}
/**
* Gets the error code.
*/
public getCode(): number {
return Number(this.payload.code);
}
/**
* Gets the failure details.
*/
public getDetail(): FailureDetail | undefined {
return this.payload.detail;
}
/**
* Gets the failure message.
*/
public getMessage(): string | undefined {
return this.payload.message;
}
/**
* Gets processed failure message.
*/
public getProcessedMessage(messageCreator?: MessageCreator): ProcessedPropertyError[] {
return FRPolicy.parseErrors(this.payload, messageCreator);
}
/**
* Gets the failure reason.
*/
public getReason(): string | undefined {
return this.payload.reason;
}
}
export default FRLoginFailure;