|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.service.Service
org.restlet.service.StatusService
public class StatusService
Service to handle error statuses. If an exception is thrown within your
application or Restlet code, it will be intercepted by this service if it is
enabled.
When an exception or an error is caught, the
getStatus(Throwable, Request, Response)
method is first invoked to
obtain the status that you want to set on the response. If this method isn't
overridden or returns null, the Status.SERVER_ERROR_INTERNAL
constant
will be set by default.
Also, when the status of a response returned is an error status (see
Status.isError()
, the
getRepresentation(Status, Request, Response)
method is then invoked
to give your service a chance to override the default error page.
If you want to customize the default behavior, you need to create a subclass
of StatusService that overrides some or all of the methods mentioned above.
Then, just create a instance of your class and set it on your Component or
Application via the setStatusService() methods.
Constructor Summary | |
---|---|
StatusService()
Constructor. |
|
StatusService(boolean enabled)
Constructor. |
Method Summary | |
---|---|
java.lang.String |
getContactEmail()
Returns the email address to contact in case of error. |
Reference |
getHomeRef()
Returns the home URI to propose in case of error. |
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 overriden. |
Status |
getStatus(java.lang.Throwable throwable,
Request request,
Response response)
Returns a status for a given exception or error. |
boolean |
isOverwrite()
Indicates if an existing entity should be overwritten. |
void |
setContactEmail(java.lang.String contactEmail)
Sets the email address to contact in case of error. |
void |
setHomeRef(Reference homeRef)
Sets the home URI to propose in case of error. |
void |
setOverwrite(boolean overwrite)
Indicates if an existing entity should be overwritten. |
Methods inherited from class org.restlet.service.Service |
---|
isEnabled, isStarted, isStopped, setEnabled, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StatusService()
public StatusService(boolean enabled)
enabled
- True if the service has been enabled.Method Detail |
---|
public java.lang.String getContactEmail()
public Reference getHomeRef()
public Representation getRepresentation(Status status, Request request, Response response)
status
- The status to represent.request
- The request handled.response
- The response updated.
public Status getStatus(java.lang.Throwable throwable, Request request, Response response)
Status.SERVER_ERROR_INTERNAL
status and logs a severe message.
throwable
- The exception or error caught.request
- The request handled.response
- The response updated.
public boolean isOverwrite()
public void setContactEmail(java.lang.String contactEmail)
contactEmail
- The email address to contact in case of error.public void setHomeRef(Reference homeRef)
homeRef
- The home URI to propose in case of error.public void setOverwrite(boolean overwrite)
overwrite
- True if an existing entity should be overwritten.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |