com.atlassian.confluence.api.impl.model.validation

Class CoreValidationResult

java.lang.Object

com.atlassian.confluence.api.impl.model.validation.CoreValidationResult

All Implemented Interfaces:

ValidationResult

Deprecated.

since 5.7, use SimpleValidationResult instead.

@Deprecated
public class CoreValidationResult
extends Object
implements ValidationResult

Adapts Confluence Core ValidationErrors to API ValidationResults.

Field Summary

Fields

Modifier and Type	Field and Description
static CoreValidationResult	FORBIDDEN Deprecated. A singleton unauthorized result.
static CoreValidationResult	VALID Deprecated. A singleton valid result.

Method Summary

Modifier and Type	Method and Description
ServiceException	convertToServiceException(String errorMsg) Deprecated. Converts this validation result into a ServiceException without throwing.
static CoreValidationResult	create(boolean authorized, Collection<ValidationError> coreErrors) Deprecated. since 5.7, use CoreValidationResultFactory#create(boolean, java.util.Collection) instead.
static CoreValidationResult	create(boolean authorized, List<ValidationError> errors) Deprecated. since 5.7, use SimpleValidationResult.Builder instead
static CoreValidationResult	create(boolean authorized, Message message) Deprecated. since 5.7, use SimpleValidationResult.Builder instead.
static ValidationResult	create(Message message, com.google.common.base.Function<String,? extends ServiceException> exceptionSupplier) Deprecated. since 5.7, use {@link com.atlassian.confluence.api.model.validation.SimpleValidationResult.Builder instead.
List<ValidationError>	getErrors() Deprecated. Returns an iterable of the errors (if any) stored in this result.
boolean	isAuthorized() Deprecated. Checks for authorization status.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.api.model.validation.ValidationResult

isNotSuccessful, isSuccessful, isValid, throwIfInvalid, throwIfInvalid, throwIfNotSuccessful, throwIfNotSuccessful, throwIfNotValid

Field Detail

VALID

public static final CoreValidationResult VALID

Deprecated.

A singleton valid result.

FORBIDDEN

public static final CoreValidationResult FORBIDDEN

Deprecated.

A singleton unauthorized result.

Method Detail

create

@Deprecated
public static CoreValidationResult create(boolean authorized,
                                                      Collection<ValidationError> coreErrors)

Deprecated. since 5.7, use CoreValidationResultFactory#create(boolean, java.util.Collection) instead.

Creates an API validation result from ValidationErrors.

Parameters:

authorized - boolean value to identify is user is authorized to perform an action

coreErrors - core errors to adapt into API validation results

Returns:

a core validation result

create

@Deprecated
public static CoreValidationResult create(boolean authorized,
                                                      List<ValidationError> errors)

Deprecated. since 5.7, use SimpleValidationResult.Builder instead

Creates an API validation result from ValidationErrors.

Parameters:

authorized - boolean value to identify is user is authorized to perform an action

errors - API errors to transform into API validation results

Returns:

a core validation result

create

@Deprecated
public static CoreValidationResult create(boolean authorized,
                                                      Message message)

Deprecated. since 5.7, use SimpleValidationResult.Builder instead.

Creates an API validation result from a Message.

Parameters:

authorized - boolean value to identify is user is authorized to perform an action

message - error message to create an API validation result from

Returns:

a core validation result

create

@Deprecated
public static ValidationResult create(Message message,
                                                  com.google.common.base.Function<String,? extends ServiceException> exceptionSupplier)

Deprecated. since 5.7, use {@link com.atlassian.confluence.api.model.validation.SimpleValidationResult.Builder instead.

Creates an API validation result from a Message.

Parameters:

message - error message to create an API validation result from, to be used in the exception being thrown

exceptionSupplier - provides an exception to be thrown for a specific type of invalid result

Returns:

a core validation result

isAuthorized

public boolean isAuthorized()

Deprecated.

Description copied from interface: ValidationResult

Checks for authorization status. Does NOT imply the validity check.

Specified by:

isAuthorized in interface ValidationResult

Returns:

true if the current user is permitted to perform the execution that the validation is for, false otherwise.

See Also:

ValidationResult.isValid(), ValidationResult.isSuccessful()

getErrors

public List<ValidationError> getErrors()

Deprecated.

Description copied from interface: ValidationResult

Returns an iterable of the errors (if any) stored in this result. By contract having any errors here MUST also result in ValidationResult.isValid() returning false.

Default implementation of ValidationResult.isValid() is safe for null values. Be cautious about returning null if not using the default implementation for ValidationResult.isValid().

Specified by:

getErrors in interface ValidationResult

Returns:

an iterable of the errors stored in this result.

See Also:

ValidationResult.isValid(), ValidationError

convertToServiceException

public ServiceException convertToServiceException(String errorMsg)

Deprecated.

Description copied from interface: ValidationResult

Converts this validation result into a ServiceException without throwing. Implementations of this method should reasonably analyze the internals of this ValidationResult and return appropriate subclass of ServiceException which is most suitable for the case.

This method is used internally in the default implementations of ValidationResult.throwIfNotSuccessful() and ValidationResult.throwIfNotSuccessful(String)

Specified by:

convertToServiceException in interface ValidationResult

Parameters:

errorMsg - message to put in the Exception returned

Returns:

instance of appropriate ServiceException subclass.

See Also:

ValidationResult.throwIfNotSuccessful(), ValidationResult.throwIfNotSuccessful(String)