PolicyAdvice (forgerock-auth 3.4.0 API)

java.lang.Object
- org.forgerock.android.auth.PolicyAdvice

All Implemented Interfaces:

java.io.Serializable
```
public class PolicyAdvice
extends java.lang.Object
implements java.io.Serializable
```
Domain object for advice. The Advice is received from resource API for Step up authentication

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PolicyAdvice.PolicyAdviceBuilder

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AUTH_LEVEL_CONDITION_ADVICE`
`static int`	`AUTH_SCHEME_CONDITION_ADVICE`
`static int`	`AUTHENTICATE_TO_REALM_CONDITION_ADVICE`
`static int`	`AUTHENTICATE_TO_SERVICE_CONDITION_ADVICE`
`static int`	`SESSION_CONDITION_ADVICE`
`static int`	`TRANSACTION_CONDITION_ADVICE`
`static int`	`UNKNOWN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PolicyAdvice.PolicyAdviceBuilder`	`builder()`
`int`	`getType()`
`@NonNull java.lang.String`	`getValue()`
`static PolicyAdvice`	`parse(java.lang.String xml)`	Parse the advice xml
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- AUTH_LEVEL_CONDITION_ADVICE
```
public static final int AUTH_LEVEL_CONDITION_ADVICE
```
  See Also:
  
  Constant Field Values
- AUTH_SCHEME_CONDITION_ADVICE
```
public static final int AUTH_SCHEME_CONDITION_ADVICE
```
  See Also:
  
  Constant Field Values
- AUTHENTICATE_TO_REALM_CONDITION_ADVICE
```
public static final int AUTHENTICATE_TO_REALM_CONDITION_ADVICE
```
  See Also:
  
  Constant Field Values
- AUTHENTICATE_TO_SERVICE_CONDITION_ADVICE
```
public static final int AUTHENTICATE_TO_SERVICE_CONDITION_ADVICE
```
  See Also:
  
  Constant Field Values
- SESSION_CONDITION_ADVICE
```
public static final int SESSION_CONDITION_ADVICE
```
  See Also:
  
  Constant Field Values
- TRANSACTION_CONDITION_ADVICE
```
public static final int TRANSACTION_CONDITION_ADVICE
```
  See Also:
  
  Constant Field Values
- UNKNOWN
```
public static final int UNKNOWN
```
  See Also:
  
  Constant Field Values

Method Detail

toString
```
@NonNull
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

getType
```
public int getType()
```

parse
```
public static PolicyAdvice parse(java.lang.String xml)
```
Parse the advice xml

Parameters:

xml - The Advice in xml form

Returns:

The parsed Policy Advice

builder

public static PolicyAdvice.PolicyAdviceBuilder builder()

getValue

@NonNull
public @NonNull java.lang.String getValue()