홈
제품
Red Hat Fuse
6.3
Apache CXF Development Guide
47.2. Using WebApplicationException exceptions to report errors

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

47.2. Using WebApplicationException exceptions to report errors

Overview
링크 복사

The JAX-RS API introduced the WebApplicationException runtime exception to provide an easy way for resource methods to create exceptions that are appropriate for RESTful clients to consume. WebApplicationException exceptions can include a Response object that defines the entity body to return to the originator of the request. It also provides a mechanism for specifying the HTTP status code to be returned to the client if no entity body is provided.

Creating a simple exception
링크 복사

The easiest means of creating a WebApplicationException exception is to use either the no argument constructor or the constructor that wraps the original exception in a WebApplicationException exception. Both constructors create a WebApplicationException with an empty response.

When an exception created by either of these constructors is thrown, the runtime returns a response with an empty entity body and a status code of 500 Server Error.

Setting the status code returned to the client
링크 복사

When you want to return an error code other than 500, you can use one of the four WebApplicationException constructors that allow you to specify the status. Two of these constructors, shown in Example 47.1, “Creating a WebApplicationException with a status code”, take the return status as an integer.

Example 47.1. Creating a WebApplicationException with a status code

WebApplicationException(int status);

WebApplicationException(java.lang.Throwable cause,
                        int status);

The other two, shown in Example 47.2, “Creating a WebApplicationException with a status code” take the response status as an instance of Response.Status.

Example 47.2. Creating a WebApplicationException with a status code

WebApplicationException(javax.ws.rs.core.Response.Status status);

WebApplicationException(java.lang.Throwable cause,
                        javax.ws.rs.core.Response.Status status);

When an exception created by either of these constructors is thrown, the runtime returns a response with an empty entity body and the specified status code.

Providing an entity body
링크 복사

If you want a message to be sent along with the exception, you can use one of the WebApplicationException constructors that takes a Response object. The runtime uses the Response object to create the response sent to the client. The entity stored in the response is mapped to the entity body of the message and the status field of the response is mapped to the HTTP status of the message.

Example 47.3, “Sending a message with an exception” shows code for returning a text message to a client containing the reason for the exception and sets the HTTP message status to 409 Conflict.

Example 47.3. Sending a message with an exception

import javax.ws.rs.core.Response;
import javax.ws.rs.WebApplicationException;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

...
ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.status(Response.Status.CONFLICT);
builder.entity("The requested resource is conflicted.");
Response response = builder.build();
throw WebApplicationException(response);

import javax.ws.rs.core.Response;
import javax.ws.rs.WebApplicationException;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

...
ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.status(Response.Status.CONFLICT);
builder.entity("The requested resource is conflicted.");
Response response = builder.build();
throw WebApplicationException(response);

Copy to Clipboard

Toggle word wrap

Extending the generic exception
링크 복사

It is possible to extend the WebApplicationException exception. This would allow you to create custom exceptions and eliminate some boiler plate code.

Example 47.4, “Extending WebApplicationException” shows a new exception that creates a similar response to the code in Example 47.3, “Sending a message with an exception”.

Example 47.4. Extending WebApplicationException

public class ConflicteddException extends WebApplicationException
{
  public ConflictedException(String message)
  {
    ResponseBuilderImpl builder = new ResponseBuilderImpl();
    builder.status(Response.Status.CONFLICT);
    builder.entity(message);
    super(builder.build());
     }
}

...
throw ConflictedException("The requested resource is conflicted.");

public class ConflicteddException extends WebApplicationException
{
  public ConflictedException(String message)
  {
    ResponseBuilderImpl builder = new ResponseBuilderImpl();
    builder.status(Response.Status.CONFLICT);
    builder.entity(message);
    super(builder.build());
     }
}

...
throw ConflictedException("The requested resource is conflicted.");

Copy to Clipboard

Toggle word wrap

맨 위로 이동

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

47.2. Using WebApplicationException exceptions to report errors

Overview
링크 복사

Creating a simple exception
링크 복사

Setting the status code returned to the client
링크 복사

Providing an entity body
링크 복사

Extending the generic exception
링크 복사

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat 소개

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

47.2. Using WebApplicationException exceptions to report errors

Overview링크 복사링크가 클립보드에 복사되었습니다!

Creating a simple exception링크 복사링크가 클립보드에 복사되었습니다!

Setting the status code returned to the client링크 복사링크가 클립보드에 복사되었습니다!

Providing an entity body링크 복사링크가 클립보드에 복사되었습니다!

Extending the generic exception링크 복사링크가 클립보드에 복사되었습니다!

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat 소개

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Overview
링크 복사

Creating a simple exception
링크 복사

Setting the status code returned to the client
링크 복사

Providing an entity body
링크 복사

Extending the generic exception
링크 복사