io.toro.martini

Class UserGroupMethods

java.lang.Object

io.toro.martini.UserGroupMethods

public final class UserGroupMethods
extends Object

This class provides methods for mapping access control list management via Gloop.

Method Summary

Modifier and Type	Method and Description
static void	addUserToGroup(String username, String groupname)
static void	deleteGroup(String id)
static void	deleteUser(String id)
static io.toro.gloop.object.property.GloopModel	findAccessTokenByUserId(String userName)
static List<String>	findGroups()
static io.toro.gloop.object.property.GloopModel	findUser(String username)
static io.toro.gloop.object.property.GloopModel	findUser(String username, String password)
static io.toro.gloop.object.property.GloopModel	findUserByEmail(String emailAddress)
static io.toro.gloop.object.property.GloopModel	findUsers(Closure predicateClosure)
static io.toro.gloop.object.property.GloopModel	generateToken(String userName)
static boolean	groupExists(String name)
static List<String>	groupsExist(List<String> groupNames)
static void	removeUserFromGroup(String username, String groupname)
static void	saveGroup(String groupName)
static void	saveUser(io.toro.gloop.object.property.GloopModel user)

Methods inherited from class java.lang.Object

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

Method Detail

findUser

@GloopObjectParameter(value="user{\n  user#io.toro.martini.user.User{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel findUser(@GloopParameter(allowNull=false)
                                                                                                                                                String username)

findUser

@GloopObjectParameter(value="user{\n  user#io.toro.martini.user.User{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel findUser(@GloopParameter(allowNull=false)
                                                                                                                                                String username,
                                                                                                                                                @GloopParameter(allowNull=false)
                                                                                                                                                String password)

findUserByEmail

@GloopObjectParameter(value="user{\n  user#io.toro.martini.user.User{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel findUserByEmail(@GloopParameter(allowNull=false)
                                                                                                                                                       String emailAddress)

groupExists

public static boolean groupExists(@GloopParameter(allowNull=false)
                                  String name)

groupsExist

@GloopComment(value="Returns a list of group names that were found")
public static List<String> groupsExist(@GloopParameter(allowNull=false)
                                                                                                            List<String> groupNames)

saveUser

public static void saveUser(@GloopParameter(allowNull=false) @GloopObjectParameter(value="user#io.toro.martini.user.User{\n}")
                            io.toro.gloop.object.property.GloopModel user)

findUsers

@GloopObjectParameter(value="users{\n  users#io.toro.martini.user.User[]{\n  }\n}")
 @GloopComment(value="The closure needs to be a groovy expression that starts with { and ends with }. It will have one argument called \'it\' that is a io.toro.martini.permissions.model.User object. The closure should return a boolean telling the method whether to include the user in the result or not")
public static io.toro.gloop.object.property.GloopModel findUsers(Closure predicateClosure)
                                                                                                                                                                                                                                                                                                                                                                                                                                                               throws ToroException

Throws:

ToroException

findGroups

public static List<String> findGroups()

saveGroup

public static void saveGroup(@GloopParameter(allowNull=false)
                             String groupName)

addUserToGroup

public static void addUserToGroup(@GloopParameter(allowNull=false)
                                  String username,
                                  @GloopParameter(allowNull=false)
                                  String groupname)

removeUserFromGroup

public static void removeUserFromGroup(@GloopParameter(allowNull=false)
                                       String username,
                                       @GloopParameter(allowNull=false)
                                       String groupname)
                                throws ToroException

Throws:

ToroException

deleteUser

public static void deleteUser(@GloopParameter(allowNull=false)
                              String id)

deleteGroup

public static void deleteGroup(@GloopParameter(allowNull=false)
                               String id)

findAccessTokenByUserId

@GloopObjectParameter(value="token{\n  token#io.toro.martini.user.AccessToken{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel findAccessTokenByUserId(String userName)

generateToken

@GloopObjectParameter(value="token{\n  token#io.toro.martini.user.AccessToken{\n  }\n}")
public static io.toro.gloop.object.property.GloopModel generateToken(String userName)
                                                                                                                                                       throws ToroException

Throws:

ToroException