org.xins.client
Class UnacceptableRequestException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.xins.client.UnacceptableRequestException

All Implemented Interfaces:

Serializable

public final class UnacceptableRequestException

extends RuntimeException

Exception that indicates that a request for an API call is considered unacceptable on the application-level. For example, a mandatory input parameter may be missing.

Since:

XINS 1.2.0

Version:

$Revision: 1.21 $ $Date: 2006/08/28 09:12:31 $

Author:

Ernst de Haan

See Also:

Serialized Form

Constructor Summary

UnacceptableRequestException(AbstractCAPICallRequest request)
Constructs a new UnacceptableRequestException using the specified AbstractCAPICallRequest.

Method Summary

void	addAttributeCombo(String type, List attributes, String elementName) Adds an invalid combination of attributes.
void	addInvalidValueForType(String parameter, String type) Adds an invalid value for a specified type.
void	addInvalidValueForType(String attribute, String type, String element) Adds an invalid value for a specified type.
void	addMissingParameter(String parameter) Adds to the response a paramater that is missing.
void	addMissingParameter(String attribute, String element) Adds to the response an attribute that is missing in an element.
void	addParamCombo(String type, List parameters) Adds an invalid combination of parameters.
String	getMessage() Returns the message for this exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UnacceptableRequestException

public UnacceptableRequestException(AbstractCAPICallRequest request)

Constructs a new UnacceptableRequestException using the specified AbstractCAPICallRequest.

Parameters:

request - the AbstractCAPICallRequest that is considered unacceptable, may be null.

Method Detail

getMessage

public String getMessage()

Returns the message for this exception.

Returns:

the exception message, can be null.

addMissingParameter

public void addMissingParameter(String parameter)

Adds to the response a paramater that is missing.

Parameters:

parameter - the missing parameter.

addMissingParameter

public void addMissingParameter(String attribute,
                                String element)

Adds to the response an attribute that is missing in an element.

Parameters:

attribute - the missing attribute.

element - the element in which the attribute is missing.

addInvalidValueForType

public void addInvalidValueForType(String parameter,
                                   String type)

Adds an invalid value for a specified type.

Parameters:

parameter - the parameter passed by the user.

type - the type which this parameter should be compliant with.

addInvalidValueForType

public void addInvalidValueForType(String attribute,
                                   String type,
                                   String element)

Adds an invalid value for a specified type.

Parameters:

attribute - the attribute passed by the user.

type - the type which this parameter should be compliant with.

element - the element in which the attribute is missing.

addParamCombo

public void addParamCombo(String type,
                          List parameters)

Adds an invalid combination of parameters.

Parameters:

type - the type of the combination.

parameters - list of the parameters in the combination passed as a list of String objects.

addAttributeCombo

public void addAttributeCombo(String type,
                              List attributes,
                              String elementName)

Adds an invalid combination of attributes.

Parameters:

type - the type of the combination.

attributes - list of the attributes in the combination passed as a list of String objects.

elementName - the name of the element to which these attributes belong.

Since:

XINS 1.4.0