com.edmunds.rest.databricks.service

Class ScimServiceImpl

java.lang.Object

com.edmunds.rest.databricks.service.DatabricksService

com.edmunds.rest.databricks.service.ScimServiceImpl

All Implemented Interfaces:

ScimService

public class ScimServiceImpl
extends DatabricksService
implements ScimService

Field Summary

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

client, mapper

Constructor Summary

Constructors

Constructor and Description
ScimServiceImpl(DatabricksRestClient client)

Method Summary

Modifier and Type	Method and Description
void	addUsersToGroup(long groupId, long[] userIds) Update a group in Databricks by adding new members.
long	createGroup(GroupDTO group) Creates a group in the Databricks workspace.
long	createUser(UserDTO userDTO) Create a user in the Databricks workspace.
void	deleteGroup(long id) Removes a group from the workspace.
void	deleteUser(long id) Inactivates an user.
void	editUser(UserDTO userDTO) Updates an user.
GroupDTO	getGroup(long id) Gets a group by id.
UserDTO	getUser(long id) Gets an user by id.
ListResponseDTO<GroupDTO>	listGroups() Retrieve a list of groups associated with a Databricks workspace.
ListResponseDTO<GroupDTO>	listGroups(String filters) Retrieve a list of groups associated with a Databricks workspace.
ListResponseDTO<UserDTO>	listUsers() Retrieve a list of users associated with a Databricks workspace.
ListResponseDTO<UserDTO>	listUsers(String filters) Retrieve a list of users associated with a Databricks workspace.
void	removeUsersFromGroup(long groupId, long[] userIds) Update a group in Databricks by removing members.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScimServiceImpl

public ScimServiceImpl(DatabricksRestClient client)

Method Detail

getUser

public UserDTO getUser(long id)
                throws IOException,
                       DatabricksRestException

Description copied from interface: ScimService

Gets an user by id.

Specified by:

getUser in interface ScimService

Parameters:

id - user id

Returns:

POJO representing an user

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-user-by-id

deleteUser

public void deleteUser(long id)
                throws DatabricksRestException

Description copied from interface: ScimService

Inactivates an user.

Specified by:

deleteUser in interface ScimService

Parameters:

id - user id

Throws:

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#delete-user-by-id

listUsers

public ListResponseDTO<UserDTO> listUsers()
                                   throws IOException,
                                          DatabricksRestException

Description copied from interface: ScimService

Retrieve a list of users associated with a Databricks workspace. No search criteria are provided.

Specified by:

listUsers in interface ScimService

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-users

listUsers

public ListResponseDTO<UserDTO> listUsers(String filters)
                                   throws IOException,
                                          DatabricksRestException

Description copied from interface: ScimService

Retrieve a list of users associated with a Databricks workspace.

Specified by:

listUsers in interface ScimService

Parameters:

filters - query filters, can be null @see https://docs.databricks.com/dev-tools/api/latest/scim.html#scim-filters

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-users

createUser

public long createUser(UserDTO userDTO)
                throws IOException,
                       DatabricksRestException

Description copied from interface: ScimService

Create a user in the Databricks workspace.

Specified by:

createUser in interface ScimService

Parameters:

userDTO - POJO representing an user

Returns:

the user id

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#create-user

editUser

public void editUser(UserDTO userDTO)
              throws IOException,
                     DatabricksRestException

Description copied from interface: ScimService

Updates an user.

Specified by:

editUser in interface ScimService

Parameters:

userDTO - POJO representing an user

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#update-user-by-id-put

getGroup

public GroupDTO getGroup(long id)
                  throws IOException,
                         DatabricksRestException

Description copied from interface: ScimService

Gets a group by id.

Specified by:

getGroup in interface ScimService

Parameters:

id - the group id

Returns:

POJO representing an group

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-group-by-id

deleteGroup

public void deleteGroup(long id)
                 throws DatabricksRestException

Description copied from interface: ScimService

Removes a group from the workspace. The users associated are not removed

Specified by:

deleteGroup in interface ScimService

Parameters:

id - group id

Throws:

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#delete-group

listGroups

public ListResponseDTO<GroupDTO> listGroups()
                                     throws IOException,
                                            DatabricksRestException

Description copied from interface: ScimService

Retrieve a list of groups associated with a Databricks workspace. No search criteria are provided.

Specified by:

listGroups in interface ScimService

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-groups

listGroups

public ListResponseDTO<GroupDTO> listGroups(String filters)
                                     throws IOException,
                                            DatabricksRestException

Description copied from interface: ScimService

Retrieve a list of groups associated with a Databricks workspace.

Specified by:

listGroups in interface ScimService

Parameters:

filters - query filters, can be null @see https://docs.databricks.com/dev-tools/api/latest/scim.html#scim-filters

Returns:

query response

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#get-groups

createGroup

public long createGroup(GroupDTO group)
                 throws IOException,
                        DatabricksRestException

Description copied from interface: ScimService

Creates a group in the Databricks workspace.

Specified by:

createGroup in interface ScimService

Parameters:

group - POJO representing an group

Returns:

the group id

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#create-group

addUsersToGroup

public void addUsersToGroup(long groupId,
                            long[] userIds)
                     throws IOException,
                            DatabricksRestException

Description copied from interface: ScimService

Update a group in Databricks by adding new members.

Specified by:

addUsersToGroup in interface ScimService

Parameters:

groupId - group id

userIds - user ids

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#update-group

removeUsersFromGroup

public void removeUsersFromGroup(long groupId,
                                 long[] userIds)
                          throws IOException,
                                 DatabricksRestException

Description copied from interface: ScimService

Update a group in Databricks by removing members.

Specified by:

removeUsersFromGroup in interface ScimService

Parameters:

groupId - group id

userIds - user ids

Throws:

IOException - any other errors

DatabricksRestException - any errors with request

See Also:

https://docs.databricks.com/dev-tools/api/latest/scim.html#update-group