Package io.continual.iam.impl.common

Class CommonJsonGroup

java.lang.Object

io.continual.iam.impl.common.CommonJsonObject

io.continual.iam.impl.common.CommonJsonGroup

All Implemented Interfaces:

Group, UserDataHolder

public class CommonJsonGroup
extends CommonJsonObject
implements Group

Constructor Summary

Constructors

Constructor	Description
CommonJsonGroup(CommonJsonDb<?,?> db, String id, org.json.JSONObject groupData)	Deprecated. Use the other form, which is more similar to the identity constructor
CommonJsonGroup(String id, org.json.JSONObject groupData, CommonJsonDb<?,?> db)

Method Summary

Modifier and Type	Method	Description
void	addUser(String userId)
protected org.json.JSONObject	getDataRecord()
String	getId()	Get an identifier for this group
Set<String>	getMembers()	Get members of the group
String	getName()	Get a readable name for this group
static org.json.JSONObject	initializeGroup(String name)
boolean	isMember(String userId)	Is the given user a member of this group?
void	reload()	reload this object from the server
void	removeUser(String userId)
protected void	store()

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

getAllUserData, getUserData, getValue, getValue, putUserData, removeUserData, removeValue, setValue

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.identity.UserDataHolder

getAllUserData, getUserData, putUserData, removeUserData

Constructor Detail

CommonJsonGroup

@Deprecated
public CommonJsonGroup(CommonJsonDb<?,?> db,
                       String id,
                       org.json.JSONObject groupData)

Deprecated.

Use the other form, which is more similar to the identity constructor

Construct a group

Parameters:

db - an identity database

id - the group's ID

groupData - additional group data

CommonJsonGroup

public CommonJsonGroup(String id,
                       org.json.JSONObject groupData,
                       CommonJsonDb<?,?> db)

Method Detail

initializeGroup

public static org.json.JSONObject initializeGroup(String name)

getId

public String getId()

Description copied from interface: Group

Get an identifier for this group

Specified by:

getId in interface Group

Returns:

a string id

getName

public String getName()

Description copied from interface: Group

Get a readable name for this group

Specified by:

getName in interface Group

Returns:

a name that's not necessarily unique in the system

isMember

public boolean isMember(String userId)
                 throws IamSvcException

Description copied from interface: Group

Is the given user a member of this group?

Specified by:

isMember in interface Group

Parameters:

userId - a user ID

Returns:

true if the user is a member

Throws:

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

getMembers

public Set<String> getMembers()
                       throws IamSvcException

Description copied from interface: Group

Get members of the group

Specified by:

getMembers in interface Group

Returns:

a set of 0 or more user IDs

Throws:

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

addUser

public void addUser(String userId)
             throws IamSvcException

Throws:

IamSvcException

removeUser

public void removeUser(String userId)
                throws IamSvcException

Throws:

IamSvcException

reload

public void reload()
            throws IamSvcException

Description copied from interface: UserDataHolder

reload this object from the server

Specified by:

reload in interface UserDataHolder

Specified by:

reload in class CommonJsonObject

Throws:

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

getDataRecord

protected org.json.JSONObject getDataRecord()

Specified by:

getDataRecord in class CommonJsonObject

store

protected void store()
              throws IamSvcException

Specified by:

store in class CommonJsonObject

Throws:

IamSvcException