com.edmunds.rest.databricks.service

Class GroupsServiceImpl

java.lang.Object

com.edmunds.rest.databricks.service.DatabricksService

com.edmunds.rest.databricks.service.GroupsServiceImpl

All Implemented Interfaces:

GroupsService

public class GroupsServiceImpl
extends DatabricksService
implements GroupsService

The implementation of GroupsService.

Field Summary

Fields inherited from class com.edmunds.rest.databricks.service.DatabricksService

client, mapper

Constructor Summary

Constructors

Constructor and Description
GroupsServiceImpl(DatabricksRestClient client)

Method Summary

Modifier and Type	Method and Description
void	addGroupToGroup(String groupName, String parentName) Adds a group to a group.
void	addUserToGroup(String userName, String parentName) Adds a user to a group.
String	createGroup(String groupName) Creates a new group.
void	deleteGroup(String groupName) Removes a group from this organization.
boolean	groupExists(String groupName) Check to see if a group exists with a given name.
String[]	listGroups() Returns all the groups in an organization.
PrincipalNameDTO[]	listMembers(String groupName) Returns all of the members of a particular group.
String[]	listParentsOfGroup(String groupName) Retrieves all groups in which a given group is a member.
String[]	listParentsOfUser(String userName) Retrieves all groups in which a given user is a member.
void	removeGroupFromGroup(String groupName, String parentName) Removes a group from a group.
void	removeUserFromGroup(String userName, String parentName) Removes a user from a group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsServiceImpl

public GroupsServiceImpl(DatabricksRestClient client)

Method Detail

addUserToGroup

public void addUserToGroup(String userName,
                           String parentName)
                    throws IOException,
                           DatabricksRestException

Description copied from interface: GroupsService

Adds a user to a group.

Specified by:

addUserToGroup in interface GroupsService

Parameters:

userName - the userName to be added

parentName - name of the parent group to which the new member will be added

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#add-member

addGroupToGroup

public void addGroupToGroup(String groupName,
                            String parentName)
                     throws IOException,
                            DatabricksRestException

Description copied from interface: GroupsService

Adds a group to a group.

Specified by:

addGroupToGroup in interface GroupsService

Parameters:

groupName - the groupName to be added

parentName - name of the parent group to which the new member will be added

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#add-member

createGroup

public String createGroup(String groupName)
                   throws IOException,
                          DatabricksRestException

Description copied from interface: GroupsService

Creates a new group.

Specified by:

createGroup in interface GroupsService

Parameters:

groupName - the groupName to be created

Returns:

the groupName

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#create

listMembers

public PrincipalNameDTO[] listMembers(String groupName)
                               throws IOException,
                                      DatabricksRestException

Description copied from interface: GroupsService

Returns all of the members of a particular group.

Specified by:

listMembers in interface GroupsService

Parameters:

groupName - the groupName whose members we want to retrieve

Returns:

all users and groups that belong to a given group

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list-members

listGroups

public String[] listGroups()
                    throws IOException,
                           DatabricksRestException

Description copied from interface: GroupsService

Returns all the groups in an organization.

Specified by:

listGroups in interface GroupsService

Returns:

the groupNames of all groups

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list

listParentsOfUser

public String[] listParentsOfUser(String userName)
                           throws IOException,
                                  DatabricksRestException

Description copied from interface: GroupsService

Retrieves all groups in which a given user is a member.

Specified by:

listParentsOfUser in interface GroupsService

Parameters:

userName - name of the user

Returns:

the groupNames of all groups the user belongs to

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list-parents

listParentsOfGroup

public String[] listParentsOfGroup(String groupName)
                            throws IOException,
                                   DatabricksRestException

Description copied from interface: GroupsService

Retrieves all groups in which a given group is a member.

Specified by:

listParentsOfGroup in interface GroupsService

Parameters:

groupName - name of the group

Returns:

the groupNames of all groups the group belongs to

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list-parents

removeUserFromGroup

public void removeUserFromGroup(String userName,
                                String parentName)
                         throws IOException,
                                DatabricksRestException

Description copied from interface: GroupsService

Removes a user from a group.

Specified by:

removeUserFromGroup in interface GroupsService

Parameters:

userName - name of the user

parentName - name of parent group

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#remove-member

removeGroupFromGroup

public void removeGroupFromGroup(String groupName,
                                 String parentName)
                          throws IOException,
                                 DatabricksRestException

Description copied from interface: GroupsService

Removes a group from a group.

Specified by:

removeGroupFromGroup in interface GroupsService

Parameters:

groupName - name of the group

parentName - name of parent group

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#remove-member

deleteGroup

public void deleteGroup(String groupName)
                 throws IOException,
                        DatabricksRestException

Description copied from interface: GroupsService

Removes a group from this organization.

Specified by:

deleteGroup in interface GroupsService

Parameters:

groupName - name of the group to be deleted

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#delete

groupExists

public boolean groupExists(String groupName)
                    throws IOException,
                           DatabricksRestException

Description copied from interface: GroupsService

Check to see if a group exists with a given name.

Specified by:

groupExists in interface GroupsService

Parameters:

groupName - name to check

Returns:

whether or not the groupName was found in the list of groups

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request