Package io.continual.iam.impl.jsondoc

Class JsonDocDb

java.lang.Object

io.continual.iam.impl.common.CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

io.continual.iam.impl.jsondoc.JsonDocDb

All Implemented Interfaces:

AccessDb<CommonJsonGroup>, AccessManager<CommonJsonGroup>, AclUpdateListener, IamDb<CommonJsonIdentity,CommonJsonGroup>, IdentityDb<CommonJsonIdentity>, IdentityManager<CommonJsonIdentity>, TagManager, MetricsSupplier, Closeable, AutoCloseable

public class JsonDocDb
extends CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

This "database" is a single JSON document.

Nested Class Summary

Nested classes/interfaces inherited from class io.continual.iam.impl.common.CommonJsonDb

CommonJsonDb.AclFactory

Field Summary

Fields inherited from class io.continual.iam.impl.common.CommonJsonDb

kAlias, kCreateTsMs, kEnabled, kExpireEpoch, kPasswordBlock, kPasswordHash, kPasswordSalt, kSecret, kTagId, kTagType, kTagType_PasswordReset, kUserId

Fields inherited from interface io.continual.iam.access.AccessDb

kCreateOperation, kDeleteOperation, kReadOperation, kWriteOperation

Constructor Summary

Constructors

Constructor	Description
JsonDocDb()
JsonDocDb(org.json.JSONObject doc)

Method Summary

Modifier and Type	Method	Description
void	close()
protected org.json.JSONObject	createApiKeyObject(String userId, String apiKey, String apiSecret)
protected org.json.JSONObject	createNewGroup(String id, String groupDesc)
protected org.json.JSONObject	createNewUser(String id)
protected void	deleteAclObject(String id)
protected void	deleteAliasObject(String id)
protected void	deleteApiKeyObject(String id)
protected void	deleteGroupObject(String id)
protected void	deleteTagObject(String id, String userId, String appTagType)
protected void	deleteUserObject(String id)
List<String>	findUsers(String startingWith)	Find users with a user ID that starts with the given string
Collection<String>	getAllGroups()	Get all group IDs in this db.
Collection<String>	getAllUsers()	Get all user IDs in this db.
protected ApiKey	instantiateApiKey(String id, org.json.JSONObject data)
protected CommonJsonGroup	instantiateGroup(String id, org.json.JSONObject data)
protected CommonJsonIdentity	instantiateIdentity(String id, org.json.JSONObject data)
protected boolean	isInvalidJwtToken(String token)
protected org.json.JSONObject	loadAclObject(String id)
protected Collection<String>	loadAliasesForUser(String userId)
protected org.json.JSONObject	loadAliasObject(String id)
Map<String,CommonJsonIdentity>	loadAllUsers()	Load all users in this identity manager.
protected org.json.JSONObject	loadApiKeyObject(String id)
protected Collection<String>	loadApiKeysForUser(String userId)
protected org.json.JSONObject	loadGroupObject(String id)
protected org.json.JSONObject	loadTagObject(String id, boolean expiredOk)
protected org.json.JSONObject	loadTagObject(String userId, String appTagType, boolean expiredOk)
protected org.json.JSONObject	loadUserObject(String id)
String	serialize()
protected void	storeAclObject(String id, org.json.JSONObject data)
protected void	storeAliasObject(String apiKeyId, org.json.JSONObject data)
protected void	storeApiKeyObject(String apiKeyId, org.json.JSONObject data)
protected void	storeGroupObject(String id, org.json.JSONObject data)
protected void	storeInvalidJwtToken(String token)
protected void	storeTagObject(String id, String userId, String appTagType, org.json.JSONObject data)
protected void	storeUserObject(String id, org.json.JSONObject data)
void	sweepExpiredTags()	Sweep any expired tags.

Methods inherited from class io.continual.iam.impl.common.CommonJsonDb

addAlias, addJwtValidator, addUserToGroup, aliasExists, authenticate, authenticate, authenticate, canUser, completePasswordReset, createAnonymousUser, createApiKey, createGroup, createGroup, createJwtToken, createTag, createUser, deleteUser, generateKey, getAclFor, getAliasesFor, getAppNonce, getUserIdForTag, getUsersGroups, getUsersInGroup, invalidateJwtToken, loadApiKeyRecord, loadGroup, loadUser, loadUserOrAlias, onAclUpdate, populateMetrics, removeAlias, removeMatchingTag, removeUserFromGroup, restoreApiKey, userExists, userOrAliasExists

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.continual.iam.IamDb

start

Constructor Detail

JsonDocDb

public JsonDocDb()

JsonDocDb

public JsonDocDb(org.json.JSONObject doc)

Method Detail

close

public void close()

serialize

public String serialize()

findUsers

public List<String> findUsers(String startingWith)
                       throws IamSvcException

Description copied from interface: IdentityManager

Find users with a user ID that starts with the given string

Parameters:

startingWith - a prefix for users

Returns:

a list of 0 or more matching user IDs

Throws:

IamSvcException - when the call cannot be completed due to a service error

getAllUsers

public Collection<String> getAllUsers()
                               throws IamSvcException

Description copied from interface: IdentityManager

Get all user IDs in this db. Clearly not suitable for systems beyond a few thousand users. For larger scale, this call may throw an IamSvcException signaling that the underlying database won't return a user list.

Returns:

a collection of user Ids

Throws:

IamSvcException - when the call cannot be completed due to a service error

getAllGroups

public Collection<String> getAllGroups()
                                throws IamSvcException

Description copied from interface: AccessManager

Get all group IDs in this db. Clearly not suitable for systems beyond a few thousand groups. For larger scale, this call may throw an IamSvcException signaling that the underlying database won't return a group list.

Returns:

a collection of group Ids

Throws:

IamSvcException - when the call cannot be completed due to a service error

loadAllUsers

public Map<String,CommonJsonIdentity> loadAllUsers()
                                                  throws IamSvcException

Description copied from interface: IdentityManager

Load all users in this identity manager. Clearly not suitable for systems beyond a few thousand users. For larger scale, this call may throw an IamSvcException signaling that the underlying database won't return a user list.

Returns:

a map of user ID to identity

Throws:

IamSvcException - when the call cannot be completed due to a service error

sweepExpiredTags

public void sweepExpiredTags()
                      throws IamSvcException

Description copied from interface: TagManager

Sweep any expired tags. The tag manager implementation may not actually require this operation. In that case, make it a no-op.

Throws:

IamSvcException - if there's a problem in the IAM service

createNewUser

protected org.json.JSONObject createNewUser(String id)

Specified by:

createNewUser in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

loadUserObject

protected org.json.JSONObject loadUserObject(String id)
                                      throws IamSvcException

Specified by:

loadUserObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

storeUserObject

protected void storeUserObject(String id,
                               org.json.JSONObject data)
                        throws IamSvcException

Specified by:

storeUserObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

deleteUserObject

protected void deleteUserObject(String id)
                         throws IamSvcException

Specified by:

deleteUserObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

instantiateIdentity

protected CommonJsonIdentity instantiateIdentity(String id,
                                                 org.json.JSONObject data)

Specified by:

instantiateIdentity in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

createNewGroup

protected org.json.JSONObject createNewGroup(String id,
                                             String groupDesc)

Specified by:

createNewGroup in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

loadGroupObject

protected org.json.JSONObject loadGroupObject(String id)
                                       throws IamSvcException

Specified by:

loadGroupObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

storeGroupObject

protected void storeGroupObject(String id,
                                org.json.JSONObject data)
                         throws IamSvcException

Specified by:

storeGroupObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

deleteGroupObject

protected void deleteGroupObject(String id)
                          throws IamSvcException

Specified by:

deleteGroupObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

instantiateGroup

protected CommonJsonGroup instantiateGroup(String id,
                                           org.json.JSONObject data)

Specified by:

instantiateGroup in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

createApiKeyObject

protected org.json.JSONObject createApiKeyObject(String userId,
                                                 String apiKey,
                                                 String apiSecret)

Specified by:

createApiKeyObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

loadApiKeyObject

protected org.json.JSONObject loadApiKeyObject(String id)
                                        throws IamSvcException

Specified by:

loadApiKeyObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

storeApiKeyObject

protected void storeApiKeyObject(String apiKeyId,
                                 org.json.JSONObject data)
                          throws IamSvcException,
                                 IamBadRequestException

Specified by:

storeApiKeyObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

IamBadRequestException

deleteApiKeyObject

protected void deleteApiKeyObject(String id)
                           throws IamSvcException

Specified by:

deleteApiKeyObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

instantiateApiKey

protected ApiKey instantiateApiKey(String id,
                                   org.json.JSONObject data)

Specified by:

instantiateApiKey in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

loadApiKeysForUser

protected Collection<String> loadApiKeysForUser(String userId)
                                         throws IamSvcException,
                                                IamIdentityDoesNotExist

Specified by:

loadApiKeysForUser in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

IamIdentityDoesNotExist

loadAclObject

protected org.json.JSONObject loadAclObject(String id)
                                     throws IamSvcException

Specified by:

loadAclObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

storeAclObject

protected void storeAclObject(String id,
                              org.json.JSONObject data)
                       throws IamSvcException

Specified by:

storeAclObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

deleteAclObject

protected void deleteAclObject(String id)
                        throws IamSvcException

Specified by:

deleteAclObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

loadTagObject

protected org.json.JSONObject loadTagObject(String id,
                                            boolean expiredOk)
                                     throws IamSvcException

Specified by:

loadTagObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

loadTagObject

protected org.json.JSONObject loadTagObject(String userId,
                                            String appTagType,
                                            boolean expiredOk)
                                     throws IamSvcException

Specified by:

loadTagObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

storeTagObject

protected void storeTagObject(String id,
                              String userId,
                              String appTagType,
                              org.json.JSONObject data)
                       throws IamSvcException

Specified by:

storeTagObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

deleteTagObject

protected void deleteTagObject(String id,
                               String userId,
                               String appTagType)
                        throws IamSvcException

Specified by:

deleteTagObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

loadAliasObject

protected org.json.JSONObject loadAliasObject(String id)
                                       throws IamSvcException

Specified by:

loadAliasObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

storeAliasObject

protected void storeAliasObject(String apiKeyId,
                                org.json.JSONObject data)
                         throws IamBadRequestException,
                                IamSvcException

Specified by:

storeAliasObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamBadRequestException

IamSvcException

deleteAliasObject

protected void deleteAliasObject(String id)
                          throws IamSvcException

Specified by:

deleteAliasObject in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

loadAliasesForUser

protected Collection<String> loadAliasesForUser(String userId)
                                         throws IamSvcException,
                                                IamIdentityDoesNotExist

Specified by:

loadAliasesForUser in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

IamIdentityDoesNotExist

storeInvalidJwtToken

protected void storeInvalidJwtToken(String token)
                             throws IamSvcException

Specified by:

storeInvalidJwtToken in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException

isInvalidJwtToken

protected boolean isInvalidJwtToken(String token)
                             throws IamSvcException

Specified by:

isInvalidJwtToken in class CommonJsonDb<CommonJsonIdentity,CommonJsonGroup>

Throws:

IamSvcException