net.sf.provisioner.requests
Class FailedRequest

java.lang.Object
  net.sf.provisioner.requests.Request
      net.sf.provisioner.requests.FailedRequest

public class FailedRequest
extends Request

A request that performs no operation when sendRequest is called, then returns a response object with a custom error message. The message typically details user configuration errors (e.g. no network element name specified.)

Version:

$Revision: 1 $

Author:

g_pearson

Constructor Summary

FailedRequest(java.lang.String errorMessage)
Creates a FailedRequest with a custom error message.

Method Summary

Response

sendRequest() Returns a failed response containing the error message passed to the constructor.

Methods inherited from class net.sf.provisioner.requests.Request

filterElements, filterParameters, storeParameter, storeParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FailedRequest

public FailedRequest(java.lang.String errorMessage)

Creates a FailedRequest with a custom error message.

Parameters:

the - human-readable reason for the request's failure.

Method Detail

sendRequest

public Response sendRequest()
                     throws java.lang.Exception

Returns a failed response containing the error message passed to the constructor.

Specified by:

sendRequest in class Request

Throws:

java.lang.Exception