PsaRstApiErrFac

java.lang.Object

de.pisa.psa.rst.obj.PsaRstApiErrFac

public class PsaRstApiErrFac extends Object

REST API: error factory

Since:: 21.06.2023
Author:: weiland

Constructor Summary

Constructors

Constructor

Description

PsaRstApiErrFac(PsaRstApiErrCod code)

Constructor

PsaRstApiErrFac(javax.ws.rs.core.Response.StatusType status)

Constructor
Method Summary

Modifier and Type

Method

Description

PsaRstApiErrFac

addDetail(String key, String value)

add a detail

PsaRstApiErr

buildError()

build a new error instance where the placeholders in the message ore replaced

PsaRstApiErrFac

setErrorCode(String code)

set the error code

PsaRstApiErrFac

setErrorMessage(String message)

set the error message

void

throwError()

throw a web exception

String

toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- PsaRstApiErrFac
  
  public PsaRstApiErrFac(PsaRstApiErrCod code)
  
  Constructor
  
  Parameters:
  
  code - error code
- PsaRstApiErrFac
  
  public PsaRstApiErrFac(javax.ws.rs.core.Response.StatusType status)
  
  Constructor
  
  Parameters:
  
  status - status code
Method Details
- toString
  
  public String toString()
  Overrides:
  
  toString in class Object
  
  See Also:
  
  Object.toString()
- setErrorCode
  
  public PsaRstApiErrFac setErrorCode(String code)
  
  set the error code
  
  Parameters:
  
  code - code
  
  Returns:
  
  this
- setErrorMessage
  
  public PsaRstApiErrFac setErrorMessage(String message)
  
  set the error message
  
  Parameters:
  
  message - message
  
  Returns:
  
  this
- addDetail
  
  public PsaRstApiErrFac addDetail(String key, String value)
  
  add a detail
  
  Parameters:
  
  key - key
  
  value - value
  
  Returns:
  
  this
- buildError
  
  public PsaRstApiErr buildError()
  
  build a new error instance where the placeholders in the message ore replaced
  
  Returns:
  
  error
- throwError
  
  public void throwError() throws javax.ws.rs.ClientErrorException, javax.ws.rs.ServerErrorException
  
  throw a web exception
  
  Throws:
  
  javax.ws.rs.ClientErrorException - if the response has a 4XX status
  
  javax.ws.rs.ServerErrorException - if the response has a 5XX status
  
  RuntimeException - if the response has not a status of 4XX or 5XX