Package org.forgerock.am.identity.application

Interface IdentityActivityService

public interface IdentityActivityService

Service informs the caller of an identity's active status.

Since:

7.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IdentityActivityService.ActivityLookupException	Exception that represents an error on looking up an identity's active status.

Method Summary

Modifier and Type	Method	Description
boolean	isActive(IdType type, String username, String realm)	Informs the caller of the passed identity's active status for a given identity type.
boolean	isActive(String universalId)	Informs the caller of the passed identity's active status.
default boolean	isActive(String username, String realm)	Informs the caller of the passed identity's active status.

Method Details

isActive

boolean isActive(String universalId)
          throws IdentityActivityService.ActivityLookupException

Informs the caller of the passed identity's active status.

Parameters:

universalId - the universal ID

Returns:

true if the identity is active

Throws:

IdentityActivityService.ActivityLookupException - should an error occur looking up the identity's active status

isActive

default boolean isActive(String username,
 String realm)
                  throws IdentityActivityService.ActivityLookupException,
IdentityNotFoundException

Informs the caller of the passed identity's active status. Only checks for identities of type 'User'.

Parameters:

username - the username

realm - the realm to search for the user within

Returns:

true if the identity is active

Throws:

IdentityActivityService.ActivityLookupException - should an error occur looking up the identity's active status

IdentityNotFoundException

isActive

boolean isActive(IdType type,
 String username,
 String realm)
          throws IdentityActivityService.ActivityLookupException,
IdentityNotFoundException

Informs the caller of the passed identity's active status for a given identity type.

Parameters:

type - the identity type

username - the username

realm - the realm to search for the identity within

Returns:

true if the identity is active

Throws:

IdentityActivityService.ActivityLookupException - should an error occur looking up the identity's active status

IdentityNotFoundException