Report (Microfocus Android Mobile Native Application SDK Library)

All Known Subinterfaces:

AuthenticatorReport, UnAuthenticatorReport
```
public interface Report
```
Defines the base report interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`NOT_STARTED` Indicates that associated process has not yet been started (initiated).
`static long`	`NOT_STOPPED` Indicates that associated process has not yet been stopped (completed).
`static long`	`UNKNOWN_EXPIRATION`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`existsAnyExceptions()` A convenience method that checks for existence of all kinds of Exceptions.
`java.lang.String`	`getAccessToken()` Return the access token that was obtained by the `Authenticator`.
`long`	`getAccessTokenExpirationTime()` Return the expiration time of the access token.
`java.lang.String`	`getAssociatedProcessUniqueId()` Get the unique identifier that may be used to correlate this report instance with any implementation instance objects associated with the process that created this report.
`java.util.Collection<java.lang.Exception>`	`getAuthenticatorExceptions()` Get the exception(s) throw by the `Authenticator` instance.
`long`	`getCreationTime()` Get the time stamp when the associated process was created.
`long`	`getDuration()` Get the associated process duration
`long`	`getDurationSinceCreation()` Get the duration since the associated process was created.
`long`	`getDurationSinceStarted()` Get the duration since the associated process started.
`long`	`getDurationSinceStopped()` Get the duration since the associated process stopped.
`IdentityProvider`	`getIdentityProvider()` Get the `IdentityProvider` used to perform the associated process.
`java.lang.String`	`getRefreshToken()` Return the refresh token that was obtained by the `Authenticator`.
`long`	`getStartTime()` Get the time stamp when associated process was started.
`long`	`getStopTime()` Get the time stamp when associated process was completed.
`boolean`	`isAuthenticated()` A convenience method that is equivalent to calling `getAccessToken()` and `getRefreshToken()` and then comparing the return values to `null`.
`boolean`	`isStarted()` A convenience method equivalent to calling `getStartTime()` and then comparing the returned value to `NOT_STARTED`
`boolean`	`isStopped()` A convenience method equivalent to calling `getStopTime()` and then comparing the returned value to `NOT_STOPPED`

- Field Detail
  - UNKNOWN_EXPIRATION
```
static final long UNKNOWN_EXPIRATION
```
    See Also:
    
    Constant Field Values
  - NOT_STARTED
```
static final long NOT_STARTED
```
    Indicates that associated process has not yet been started (initiated).
    
    See Also:
    
    Constant Field Values
  - NOT_STOPPED
```
static final long NOT_STOPPED
```
    Indicates that associated process has not yet been stopped (completed).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAssociatedProcessUniqueId
```
java.lang.String getAssociatedProcessUniqueId()
```
    Get the unique identifier that may be used to correlate this report instance with any implementation instance objects associated with the process that created this report.
    
    Returns:
    
    The unique id of the associated process object that created this report.
  - getIdentityProvider
```
IdentityProvider getIdentityProvider()
```
    Get the IdentityProvider used to perform the associated process.
    
    Returns:
    
    The IdentityProvider used to perform the associated process.
  - isAuthenticated
```
boolean isAuthenticated()
```
    A convenience method that is equivalent to calling getAccessToken() and getRefreshToken() and then comparing the return values to null.
    
    Returns:
    
    true iff an access or refresh token exists (i.e. the Identity Provider is authenticated)
  - getAccessToken
```
java.lang.String getAccessToken()
```
    Return the access token that was obtained by the Authenticator.
    
    Returns:
    
    The access token. May be null if the access token does not exist.
  - getAccessTokenExpirationTime
```
long getAccessTokenExpirationTime()
```
    Return the expiration time of the access token.
    
    Returns:
    
    The expiration time for the access token. Normally a future time indicated in milliseconds. If there is no Access Token, then UNKNOWN_EXPIRATION is returned.
  - getRefreshToken
```
java.lang.String getRefreshToken()
```
    Return the refresh token that was obtained by the Authenticator.
    
    Returns:
    
    The refresh token. May be null if the refresh token does not exist.
  - getAuthenticatorExceptions
```
java.util.Collection<java.lang.Exception> getAuthenticatorExceptions()
```
    Get the exception(s) throw by the Authenticator instance.
    
    Returns:
    
    The Collection of Exception instances were thrown by the Authenticator instance. May be null if no exception exists.
  - existsAnyExceptions
```
boolean existsAnyExceptions()
```
    A convenience method that checks for existence of all kinds of Exceptions. Equivalent to individually calling each applicable #get*Exceptions() method to determine if any of the "buckets" has an exception.
    
    Returns:
    
    true iff at least one exception exists in the report.
  - getCreationTime
```
long getCreationTime()
```
    Get the time stamp when the associated process was created.
    
    Returns:
    
    The associated process creation time in milliseconds since epoch.
  - getStartTime
```
long getStartTime()
```
    Get the time stamp when associated process was started.
    
    Returns:
    
    The associated process start time in milliseconds since epoch. If the associated process is not yet started, then NOT_STARTED will be returned.
  - getStopTime
```
long getStopTime()
```
    Get the time stamp when associated process was completed. If the associated process is not yet stopped, then NOT_STOPPED will be returned.
    
    Returns:
    
    The associated process stop (completion) time in milliseconds since epoch.
  - isStarted
```
boolean isStarted()
```
    A convenience method equivalent to calling getStartTime() and then comparing the returned value to NOT_STARTED
    
    Returns:
    
    true iff associated process was started
  - isStopped
```
boolean isStopped()
```
    A convenience method equivalent to calling getStopTime() and then comparing the returned value to NOT_STOPPED
    
    Returns:
    
    true iff associated process was stopped.
  - getDuration
```
long getDuration()
```
    Get the associated process duration
    
    Returns:
    
    The duration, in milliseconds, between the start and stop events. If the associated process is not stppped, then the value NOT_STOPPED will be returned.
  - getDurationSinceStopped
```
long getDurationSinceStopped()
```
    Get the duration since the associated process stopped. This helps determine the age of this Report object and any associated implementation instance objects.
    
    Returns:
    
    The duration, in milliseconds, between the stop event and the current system time. If the associated process is not stopped, then the value NOT_STOPPED will be returned.
  - getDurationSinceStarted
```
long getDurationSinceStarted()
```
    Get the duration since the associated process started. This helps determine the age of this Report object and its associated implementation instance objects. Useful for detecting implementation instance objects that may be "abandoned."
    
    Returns:
    
    The duration, in milliseconds, between the start event and the current system time. If the associated process is not started, then the value NOT_STARTED will be returned.
  - getDurationSinceCreation
```
long getDurationSinceCreation()
```
    Get the duration since the associated process was created. This helps determine the age of the associated process and any implementation instance objects. Useful for detecting implementation instances that may be "abandoned."
    
    Returns:
    
    The duration, in milliseconds, between the creation of the associated process and the current system time.

Interface Report

Field Summary

Method Summary

Field Detail

UNKNOWN_EXPIRATION

NOT_STARTED

NOT_STOPPED

Method Detail

getAssociatedProcessUniqueId

getIdentityProvider

isAuthenticated

getAccessToken

getAccessTokenExpirationTime

getRefreshToken

getAuthenticatorExceptions

existsAnyExceptions

getCreationTime

getStartTime

getStopTime

isStarted

isStopped

getDuration

getDurationSinceStopped

getDurationSinceStarted

getDurationSinceCreation