public class StatusFilter extends Filter
Constructor and Description |
---|
StatusFilter(Context context,
boolean overwriting,
String email,
Reference homeRef)
Constructor.
|
StatusFilter(Context context,
StatusService statusService)
Constructor from a status service.
|
Modifier and Type | Method and Description |
---|---|
void |
afterHandle(Request request,
Response response)
Allows filtering after its handling by the target Restlet.
|
protected int |
doHandle(Request request,
Response response)
Handles the call by distributing it to the next Restlet.
|
String |
getContactEmail()
Returns the email address of the administrator to contact in case of
error.
|
protected Representation |
getDefaultRepresentation(Status status,
Request request,
Response response)
Returns a representation for the given status.
In order to customize the default representation, this method can be overridden. |
Reference |
getHomeRef()
Returns the home URI to propose in case of error.
|
protected Representation |
getRepresentation(Status status,
Request request,
Response response)
Returns a representation for the given status.
In order to customize the default representation, this method can be overridden. |
protected Status |
getStatus(Throwable throwable,
Request request,
Response response)
Returns a status for a given exception or error.
|
protected String |
getStatusInfo(Status status)
Returns the status information to display in the default representation.
|
StatusService |
getStatusService()
Returns the helped status service.
|
boolean |
isOverwrite()
Deprecated.
Use
isOverwriting() instead. |
boolean |
isOverwriting()
Indicates if existing representations should be overwritten.
|
void |
setContactEmail(String email)
Sets the email address of the administrator to contact in case of error.
|
void |
setHomeRef(Reference homeRef)
Sets the home URI to propose in case of error.
|
void |
setOverwrite(boolean overwriting)
Deprecated.
Use
setOverwriting(boolean) instead. |
void |
setOverwriting(boolean overwriting)
Indicates if existing representations should be overwritten.
|
void |
setStatusService(StatusService statusService)
Sets the helped status service.
|
beforeHandle, getNext, handle, hasNext, setNext, setNext, start, stop
finalize, getApplication, getAuthor, getContext, getDescription, getLogger, getName, getOwner, isStarted, isStopped, setAuthor, setContext, setDescription, setName, setOwner
public StatusFilter(Context context, boolean overwriting, String email, Reference homeRef)
context
- The context.overwriting
- Indicates whether an existing representation should be
overwritten.email
- Email address of the administrator to contact in case of
error.homeRef
- The home URI to propose in case of error.public StatusFilter(Context context, StatusService statusService)
context
- The context.statusService
- The helped status service.public void afterHandle(Request request, Response response)
afterHandle
in class Filter
request
- The request to handle.response
- The response to update.protected int doHandle(Request request, Response response)
getStatus(Throwable, Request, Response)
method is
invoked.public String getContactEmail()
protected Representation getDefaultRepresentation(Status status, Request request, Response response)
status
- The status to represent.request
- The request handled.response
- The response updated.public Reference getHomeRef()
protected Representation getRepresentation(Status status, Request request, Response response)
status
- The status to represent.request
- The request handled.response
- The response updated.protected Status getStatus(Throwable throwable, Request request, Response response)
Status.SERVER_ERROR_INTERNAL
status including the related error
or exception and logs a severe message.throwable
- The exception or error caught.request
- The request handled.response
- The response updated.protected String getStatusInfo(Status status)
status
- The status.getDefaultRepresentation(Status, Request, Response)
public StatusService getStatusService()
@Deprecated public boolean isOverwrite()
isOverwriting()
instead.public boolean isOverwriting()
public void setContactEmail(String email)
email
- The email address.public void setHomeRef(Reference homeRef)
homeRef
- The home URI.@Deprecated public void setOverwrite(boolean overwriting)
setOverwriting(boolean)
instead.overwriting
- True if existing representations should be overwritten.public void setOverwriting(boolean overwriting)
overwriting
- True if existing representations should be overwritten.public void setStatusService(StatusService statusService)
statusService
- The helped status service.Copyright © 2005–2016. All rights reserved.