br.com.caelum.vraptor.view

Interface Status

All Superinterfaces:

View

All Known Implementing Classes:

DefaultStatus

public interface Status
extends View

Allows status + header related results.

Since:

3.0.3

Author:

guilherme silveira

Method Summary

Methods

Modifier and Type	Method and Description
void	accepted() Return Accepted (202) Status
void	badRequest(java.util.List<?> errors) Returns a Bad Request (400) status Notifies the client that he should not try to execute the same request again: part of its representation is somehow invalid.
void	badRequest(java.lang.String message) Returns a Bad Request (400) status Notifies the client that he should not try to execute the same request again: part of its representation is somehow invalid.
void	conflict() Returns a Conflict (409) status
void	created() Returns a Created status (201)
void	created(java.lang.String location) Sets the status to 201 and sets the location to the server's location + the location content. created("/order/2") ==> http://localhost:8080/my_context/order/2
void	forbidden(java.lang.String message) Returns a Forbidden (403) status.
void	header(java.lang.String key, java.lang.String value)
void	methodNotAllowed(java.util.EnumSet<HttpMethod> allowedMethods)
<T> T	movedPermanentlyTo(java.lang.Class<T> controller) same as movedPermanentlyTo(String), but will use the url for controller.method(args); Example: result.use(http()).movedPermanentlyTo(ClientsController.class).list();
void	movedPermanentlyTo(java.lang.String url) Send redirect with Moved Permanently (301) Header Example: result.use(http()).movedPermanentlyTo("/clients"); will move to //clients
void	noContent() Returns a No Content status (204)
void	notAcceptable() The accepted media type is not supported.(406)
void	notFound() Returns a Not Found (404) status
void	notModified() Returns a Not Modified (304) status
void	ok() Returns a Ok status (200)
void	unsupportedMediaType(java.lang.String errorMessage) The media type sent to the server is not supported.(415)

Method Detail

ok

void ok()

Returns a Ok status (200)

created

void created()

Returns a Created status (201)

created

void created(java.lang.String location)

Sets the status to 201 and sets the location to the server's location + the location content.
created("/order/2") ==> http://localhost:8080/my_context/order/2

Parameters:

location -

noContent

void noContent()

Returns a No Content status (204)

badRequest

void badRequest(java.lang.String message)

Returns a Bad Request (400) status Notifies the client that he should not try to execute the same request again: part of its representation is somehow invalid.

Parameters:

message -

badRequest

void badRequest(java.util.List<?> errors)

Returns a Bad Request (400) status Notifies the client that he should not try to execute the same request again: part of its representation is somehow invalid. Serializes the given List as "errors", with

    result.use(representation()).from(errors, "errors").serialize();
 

Parameters:

message -

forbidden

void forbidden(java.lang.String message)

Returns a Forbidden (403) status. You must specify a reason.

Parameters:

message -

notFound

void notFound()

Returns a Not Found (404) status

conflict

void conflict()

Returns a Conflict (409) status

header

void header(java.lang.String key,
          java.lang.String value)

methodNotAllowed

void methodNotAllowed(java.util.EnumSet<HttpMethod> allowedMethods)

notModified

void notModified()

Returns a Not Modified (304) status

movedPermanentlyTo

void movedPermanentlyTo(java.lang.String url)

Send redirect with Moved Permanently (301) Header Example: result.use(http()).movedPermanentlyTo("/clients"); will move to //clients

Parameters:

uri - absolute uri to redirect

movedPermanentlyTo

<T> T movedPermanentlyTo(java.lang.Class<T> controller)

same as movedPermanentlyTo(String), but will use the url for controller.method(args); Example: result.use(http()).movedPermanentlyTo(ClientsController.class).list();

unsupportedMediaType

void unsupportedMediaType(java.lang.String errorMessage)

The media type sent to the server is not supported.(415)

Parameters:

errorMessage -

notAcceptable

void notAcceptable()

The accepted media type is not supported.(406)

Parameters:

errorMessage -

accepted

void accepted()

Return Accepted (202) Status