org.camunda.bpm.engine.rest.dto

Class AuthorizationExceptionDto

java.lang.Object

org.camunda.bpm.engine.rest.dto.ExceptionDto

org.camunda.bpm.engine.rest.dto.AuthorizationExceptionDto

public class AuthorizationExceptionDto
extends ExceptionDto

Dto for AuthorizationException

The exception contains a list of Missing authorizations. The List is a disjunction i.e. a user should have any of the authorization for the engine to continue the execution beyond the point where it failed.

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field and Description
protected List<MissingAuthorizationDto>	missingAuthorizations
protected String	permissionName
protected String	resourceId
protected String	resourceName
protected String	userId

Fields inherited from class org.camunda.bpm.engine.rest.dto.ExceptionDto

message, type

Constructor Summary

Constructors

Constructor and Description
AuthorizationExceptionDto()

Method Summary

Methods

Modifier and Type	Method and Description
static AuthorizationExceptionDto	fromException(AuthorizationException e)
List<MissingAuthorizationDto>	getMissingAuthorizations()
String	getPermissionName() Deprecated. Use getMissingAuthorizations() to get the name of the violated permission of the MissingAuthorizationDto(s). This method will be removed in future version.
String	getResourceId() Deprecated. Use getMissingAuthorizations() to get the id of the resource of the MissingAuthorizationDto(s). This method will be removed in future version.
String	getResourceName() Deprecated. Use getMissingAuthorizations() to get the name of the resource of the MissingAuthorizationDto(s). This method will be removed in future version.
String	getUserId()
void	setMissingAuthorizations(List<MissingAuthorizationDto> info)
void	setPermissionName(String permissionName) Deprecated. Use setMissingAuthorizations(List)} to set the the MissingAuthorizationDto(s). This method will be removed in future version.
void	setResourceId(String resourceId) Deprecated. Use setMissingAuthorizations(List)} to set the the MissingAuthorizationDto(s). This method will be removed in future version.
void	setResourceName(String resourceName) Deprecated. Use setMissingAuthorizations(List)} to set the the MissingAuthorizationDto(s). This method will be removed in future version.
void	setUserId(String userId)

Methods inherited from class org.camunda.bpm.engine.rest.dto.ExceptionDto

fromException, getMessage, getType, setMessage, setType

Methods inherited from class java.lang.Object

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

Field Detail

userId

protected String userId

resourceName

protected String resourceName

resourceId

protected String resourceId

permissionName

protected String permissionName

missingAuthorizations

protected List<MissingAuthorizationDto> missingAuthorizations

Constructor Detail

AuthorizationExceptionDto

public AuthorizationExceptionDto()

Method Detail

fromException

public static AuthorizationExceptionDto fromException(AuthorizationException e)

getResourceName

@Deprecated
public String getResourceName()

Deprecated. Use getMissingAuthorizations() to get the name of the resource of the MissingAuthorizationDto(s). This method will be removed in future version.

Returns:

the name of the resource if there is only one MissingAuthorizationDto, null otherwise

setResourceName

@Deprecated
public void setResourceName(String resourceName)

Deprecated. Use setMissingAuthorizations(List)} to set the the MissingAuthorizationDto(s). This method will be removed in future version.

getResourceId

@Deprecated
public String getResourceId()

Deprecated. Use getMissingAuthorizations() to get the id of the resource of the MissingAuthorizationDto(s). This method will be removed in future version.

Returns:

the id of the resource if there is only one MissingAuthorizationDto, null otherwise

setResourceId

@Deprecated
public void setResourceId(String resourceId)

Deprecated. Use setMissingAuthorizations(List)} to set the the MissingAuthorizationDto(s). This method will be removed in future version.

getPermissionName

@Deprecated
public String getPermissionName()

Deprecated. Use getMissingAuthorizations() to get the name of the violated permission of the MissingAuthorizationDto(s). This method will be removed in future version.

Returns:

the name of the violated permission if there is only one MissingAuthorizationDto, null otherwise

setPermissionName

@Deprecated
public void setPermissionName(String permissionName)

Deprecated. Use setMissingAuthorizations(List)} to set the the MissingAuthorizationDto(s). This method will be removed in future version.

getUserId

public String getUserId()

setUserId

public void setUserId(String userId)

getMissingAuthorizations

public List<MissingAuthorizationDto> getMissingAuthorizations()

Returns:

Disjunctive list of MissingAuthorizationDto from which a user needs to have at least one for the authorization to pass

setMissingAuthorizations

public void setMissingAuthorizations(List<MissingAuthorizationDto> info)