js.rmi

Class BusinessException

java.lang.Object

java.lang.Throwable

java.lang.Exception

js.rmi.BusinessException

All Implemented Interfaces:

Serializable

public final class BusinessException
extends Exception

Business logic constrains generated by application logic from server and sent to client as it is. It transports error codes that are agreed between server side and client logic.

Under normal conditions client data is validated by client logic and reach the server side normalized. Anyway, there may be complex business constrains between data items, data that is persisted on server. In order to avoid server communication delays and adding complexity to client, data validation logic uses this exception to signal a constrain is not fulfilled. Client side logic will display an alert based on this exception error code.

Developers note: business exception instance is sent back to client code via HTTP-RMI using status code 400 - HttpServletResponse.SC_BAD_REQUEST and JSON serialization.

 public void saveEmployer(Employer employer) throws BusinessException {
        BusinessRules.uniqueEmployerClientCode(employer);
        BusinessRules.uniqueEmployerName(employer);
        dao.saveEmployer(employer);
 }
 
 public class BusinessRules {
        private static final int NOT_UNIQUE_CLIENT_CODE = 0x0001;
        private static final int NOT_UNIQUE_EMPLOYER_NAME = 0x0002;
 
        public static void uniqueEmployerClientCode(Employer employer) throws BusinessException {
                if (dao.getEmployerIdByClientCode(clientCode) != employer.getId()) {
                        throw new BusinessException(NOT_UNIQUE_CLIENT_CODE);
                }
        }
 
        public static void uniqueEmployerName(Employer employer) throws BusinessException {
                if (dao.getEmployerIdByName(name) != employer.getId()) {
                        throw new BusinessException(NOT_UNIQUE_EMPLOYER_NAME);
                }
        }
 }
 

Note that this exception is checked since it is desirable to explicitly state we are going to use it.

Version:

final

Author:

Iulian Rotaru

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	errorCode Business logic error code.
private static long	serialVersionUID Java serialization version.

Constructor Summary

Constructors

Constructor and Description
BusinessException() Default constructor for JSON serialization.
BusinessException(int errorCode) Create immutable instance.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Get business logic error code.
String	getMessage() Get this business error code formated as 8 digits hexadecimal number.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Java serialization version.

See Also:

Constant Field Values

errorCode

private final int errorCode

Business logic error code.

Constructor Detail

BusinessException

public BusinessException()

Default constructor for JSON serialization.

BusinessException

public BusinessException(int errorCode)

Create immutable instance.

Parameters:

errorCode - business logic error code.

Method Detail

getErrorCode

public int getErrorCode()

Get business logic error code.

Returns:

business logic error code.

getMessage

public String getMessage()

Get this business error code formated as 8 digits hexadecimal number.

Overrides:

getMessage in class Throwable

Returns:

error code in hexadecimal format.