com.xebialabs.deployit.core.api

Interface InternalSecurityProxy

@Path(value="/internal/security")
 @Consumes(value={"application/xml","application/json"})
 @Produces(value={"application/xml","application/json"})
public interface InternalSecurityProxy

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	exists(java.lang.String roleName) Deprecated.
default java.util.List<com.xebialabs.deployit.engine.api.security.Role>	list() Deprecated.
java.util.List<com.xebialabs.deployit.engine.api.security.Role>	list(java.lang.String id, java.lang.String rolePattern, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order) Deprecated.
default java.util.List<RolePermissions>	readRolePermissions(java.lang.String id, java.lang.String rolePattern, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order)
java.util.List<RolePermissions>	readRolePermissions(java.lang.String id, java.lang.String rolePattern, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order, java.lang.Boolean includeInherited)
default java.util.List<com.xebialabs.deployit.engine.api.security.RolePrincipals>	readRolePrincipals() Deprecated.
default java.util.List<RolePermissions>	readRolePrincipals(java.lang.String id)
java.util.List<com.xebialabs.deployit.engine.api.security.RolePrincipals>	readRolePrincipals(java.lang.String rolePattern, com.xebialabs.deployit.engine.api.dto.Paging paging, com.xebialabs.deployit.engine.api.dto.Ordering order) Deprecated.
void	writeRolePermissions(java.lang.String id, java.util.List<RolePermissions> permissions)
void	writeRolePrincipals(java.util.List<com.xebialabs.deployit.engine.api.security.RolePrincipals> rolePrincipals) Lists all role principals available in the security system.

Method Detail

exists

@Deprecated
 @GET
 @Path(value="exists/{name}")
java.lang.Boolean exists(@PathParam(value="name")
                                                                         java.lang.String roleName)

Deprecated.

Method @Deprecated use com.xebialabs.deployit.engine.api.RoleService.exists(String) instead Checks if role with given name exists

Parameters:

roleName - checked role name

Returns:

list

@Deprecated
 @GET
 @Path(value="roles/v2/{id:.+}")
java.util.List<com.xebialabs.deployit.engine.api.security.Role> list(@PathParam(value="id")
                                                                                                                        java.lang.String id,
                                                                                                                        @QueryParam(value="rolePattern")
                                                                                                                        java.lang.String rolePattern,
                                                                                                                        @BeanParam
                                                                                                                        com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                                                                        @QueryParam(value="order")
                                                                                                                        com.xebialabs.deployit.engine.api.dto.Ordering order)

Deprecated.

Method @Deprecated use com.xebialabs.deployit.engine.api.RoleService.list(String, String, Paging, Ordering) instead List the roles for given configuration item ID

Parameters:

id - configuration item ID

rolePattern - the role name pattern used for search

paging - search paging

order - search order

Returns:

list

@Deprecated
 @GET
 @Path(value="roles")
default java.util.List<com.xebialabs.deployit.engine.api.security.Role> list()

Deprecated.

Method @Deprecated use com.xebialabs.deployit.engine.api.RoleService.list() instead Lists the names of all available roles in the security system.

Returns:

a list of role names.

readRolePrincipals

@Deprecated
 @GET
 @Path(value="roles/v2/principals")
java.util.List<com.xebialabs.deployit.engine.api.security.RolePrincipals> readRolePrincipals(@QueryParam(value="rolePattern")
                                                                                                                                                   java.lang.String rolePattern,
                                                                                                                                                   @BeanParam
                                                                                                                                                   com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                                                                                                   @QueryParam(value="order")
                                                                                                                                                   com.xebialabs.deployit.engine.api.dto.Ordering order)

Deprecated.

Method @Deprecated use com.xebialabs.deployit.engine.api.RoleService.readRolePrincipals(String, Paging, Ordering) instead Lists paged role principals available in the security system for given role name pattern

Parameters:

rolePattern - the role name pattern used for search

paging - search paging

order - search order

readRolePrincipals

@Deprecated
 @GET
 @Path(value="roles/principals")
default java.util.List<com.xebialabs.deployit.engine.api.security.RolePrincipals> readRolePrincipals()

Deprecated.

Method @Deprecated use com.xebialabs.deployit.engine.api.RoleService.readRolePrincipals() instead Lists all role principals available in the security system.

writeRolePrincipals

@POST
 @Path(value="roles/principals")
void writeRolePrincipals(java.util.List<com.xebialabs.deployit.engine.api.security.RolePrincipals> rolePrincipals)

Lists all role principals available in the security system.

Parameters:

rolePrincipals - the list of all RolePrincipals to be overwrite old ones

readRolePermissions

@GET
 @Path(value="roles/v2/permissions/{id:.+}")
java.util.List<RolePermissions> readRolePermissions(@PathParam(value="id")
                                                                                                      java.lang.String id,
                                                                                                      @QueryParam(value="rolePattern")
                                                                                                      java.lang.String rolePattern,
                                                                                                      @BeanParam
                                                                                                      com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                                                                      @QueryParam(value="order")
                                                                                                      com.xebialabs.deployit.engine.api.dto.Ordering order,
                                                                                                      @DefaultValue(value="false") @QueryParam(value="includeInherited")
                                                                                                      java.lang.Boolean includeInherited)

readRolePermissions

default java.util.List<RolePermissions> readRolePermissions(java.lang.String id,
                                                            java.lang.String rolePattern,
                                                            com.xebialabs.deployit.engine.api.dto.Paging paging,
                                                            com.xebialabs.deployit.engine.api.dto.Ordering order)

readRolePrincipals

@GET
 @Path(value="roles/permissions/{id:.+}")
default java.util.List<RolePermissions> readRolePrincipals(@PathParam(value="id")
                                                                                                          java.lang.String id)

writeRolePermissions

@POST
 @Path(value="roles/permissions/{id:.+}")
void writeRolePermissions(@PathParam(value="id")
                                                                          java.lang.String id,
                                                                          java.util.List<RolePermissions> permissions)