Package org.operaton.bpm.engine.rest.dto

Class AuthorizationExceptionDto

java.lang.Object

org.operaton.bpm.engine.rest.dto.ExceptionDto

org.operaton.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	Description
protected List<MissingAuthorizationDto>	missingAuthorizations
protected String	permissionName
protected String	resourceId
protected String	resourceName
protected String	userId

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

code, message, type

Constructor Summary

Constructors

Constructor	Description
AuthorizationExceptionDto()

Method Summary

Modifier and Type	Method	Description
static AuthorizationExceptionDto	fromException(AuthorizationException e)
List<MissingAuthorizationDto>	getMissingAuthorizations()
String	getPermissionName()	Deprecated, for removal: This API element is subject to removal in a future version. Use getMissingAuthorizations() to get the name of the violated permission of the MissingAuthorizationDto(s) instead.
String	getResourceId()	Deprecated, for removal: This API element is subject to removal in a future version. Use getMissingAuthorizations() to get the id of the resource of the MissingAuthorizationDto(s) instead.
String	getResourceName()	Deprecated, for removal: This API element is subject to removal in a future version. Use getMissingAuthorizations() to get the name of the resource of the MissingAuthorizationDto(s) instead.
String	getUserId()
void	setMissingAuthorizations(List<MissingAuthorizationDto> info)
void	setPermissionName(String permissionName)	Deprecated, for removal: This API element is subject to removal in a future version. Use setMissingAuthorizations(List)} to set the MissingAuthorizationDto(s) instead.
void	setResourceId(String resourceId)	Deprecated, for removal: This API element is subject to removal in a future version. Use setMissingAuthorizations(List)} to set the MissingAuthorizationDto(s) instead.
void	setResourceName(String resourceName)	Deprecated, for removal: This API element is subject to removal in a future version. Use setMissingAuthorizations(List)} to set the MissingAuthorizationDto(s) instead.
void	setUserId(String userId)

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

fromException, fromException, getCode, getMessage, getType, setCode, setMessage, setType

Methods inherited from class java.lang.Object

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

Field Details

userId

protected String userId

resourceName

protected String resourceName

resourceId

protected String resourceId

permissionName

protected String permissionName

missingAuthorizations

protected List<MissingAuthorizationDto> missingAuthorizations

Constructor Details

AuthorizationExceptionDto

public AuthorizationExceptionDto()

Method Details

fromException

public static AuthorizationExceptionDto fromException(AuthorizationException e)

getResourceName

@Deprecated(forRemoval=true,
            since="1.0")
public String getResourceName()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getMissingAuthorizations() to get the name of the resource of the MissingAuthorizationDto(s) instead.

Returns:

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

setResourceName

@Deprecated(forRemoval=true,
            since="1.0")
public void setResourceName(String resourceName)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setMissingAuthorizations(List)} to set the MissingAuthorizationDto(s) instead.

getResourceId

@Deprecated(forRemoval=true,
            since="1.0")
public String getResourceId()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getMissingAuthorizations() to get the id of the resource of the MissingAuthorizationDto(s) instead.

Returns:

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

setResourceId

@Deprecated(forRemoval=true,
            since="1.0")
public void setResourceId(String resourceId)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setMissingAuthorizations(List)} to set the MissingAuthorizationDto(s) instead.

getPermissionName

@Deprecated(forRemoval=true,
            since="1.0")
public String getPermissionName()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getMissingAuthorizations() to get the name of the violated permission of the MissingAuthorizationDto(s) instead.

Returns:

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

setPermissionName

@Deprecated(forRemoval=true,
            since="1.0")
public void setPermissionName(String permissionName)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setMissingAuthorizations(List)} to set the MissingAuthorizationDto(s) instead.

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)