|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.openspml.message.SpmlResponse
The base class for all class' representing SPML response messages.
Field Summary | |
static java.lang.String |
ERROR_CUSTOM_ERROR
Error code indicating that a PSP specific error was returned. |
static java.lang.String |
ERROR_MALFORMED_REQUEST
Error code indicating a request formatting error. |
static java.lang.String |
ERROR_NO_SUCH_IDENTIFIER
Error code indicating that the identifier provided in the request did not match an object managed by the server. |
static java.lang.String |
ERROR_NO_SUCH_REQUEST
Error code indicating that the the identifier for an extended request was not recognized. |
static java.lang.String |
ERROR_UNSUPPORTED_IDENTIFIER_TYPE
Error code indicating that an identifier type used in the request is not supported by the server. |
static java.lang.String |
ERROR_UNSUPPORTED_OPERATION
Error code indicating that the requested operation is not supported by the server. |
static java.lang.String |
RESULT_FAILURE
Result code representing failure. |
static java.lang.String |
RESULT_PENDING
Result code indicating that the request is still pending. |
static java.lang.String |
RESULT_SUCCESS
Result codes representing success. |
Fields inherited from interface org.openspml.message.Constants |
ACTION_PREFIX,
ENUM_PREFIX |
Constructor Summary | |
SpmlResponse()
|
Method Summary | |
void |
addExtendedErrorMessage(java.lang.String s)
Add an extended error message as an operational attribute. |
static SpmlResponse |
createResponseForRequest(org.openspml.message.Element domel)
Static method to create an empty response object that corresponds to an request element. |
static SpmlResponse |
createResponseForRequest(XmlElement e)
Static method to create an empty response object that corresponds to an request element. |
void |
dumpFile(java.lang.String name)
Handy function to call in the debugger. |
java.lang.String |
getError()
|
java.lang.String |
getErrorMessage()
|
java.util.List |
getExtendedErrorMessages()
|
Attribute |
getOperationalAttribute(java.lang.String name)
|
java.util.List |
getOperationalAttributes()
|
java.lang.Object |
getOperationalAttributeValue(java.lang.String name)
|
java.lang.String |
getRequestId()
|
java.lang.String |
getResult()
|
boolean |
isFailure()
|
static SpmlResponse |
parseResponse(org.openspml.message.Element domel)
Static method to parse any root SPML response. |
static SpmlResponse |
parseResponse(java.lang.String xml)
Static method to parse the XML for one of the SpmlResponse classes and return the correct object. |
static SpmlResponse |
parseResponse(XmlElement e)
Static method to parse any root SPML response. |
void |
removeOperationalAttribute(java.lang.String name)
|
void |
setError(java.lang.String s)
|
void |
setErrorMessage(java.lang.String s)
|
void |
setErrorMessage(java.lang.Throwable t)
|
void |
setOperationalAttribute(Attribute a)
|
void |
setOperationalAttribute(java.lang.String name,
java.lang.Object value)
|
void |
setOperationalAttributes(java.util.List l)
|
void |
setOperationalAttributes(java.util.Map src)
Sets the list of attributes from a map of name/value pairs. |
void |
setRequestId(java.lang.String s)
|
void |
setResult(java.lang.String s)
|
void |
throwErrors()
Examine the response for errors. |
java.lang.String |
toXml()
|
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String RESULT_SUCCESS
public static final java.lang.String RESULT_FAILURE
public static final java.lang.String RESULT_PENDING
public static final java.lang.String ERROR_MALFORMED_REQUEST
public static final java.lang.String ERROR_UNSUPPORTED_OPERATION
public static final java.lang.String ERROR_UNSUPPORTED_IDENTIFIER_TYPE
public static final java.lang.String ERROR_NO_SUCH_IDENTIFIER
public static final java.lang.String ERROR_NO_SUCH_REQUEST
public static final java.lang.String ERROR_CUSTOM_ERROR
Constructor Detail |
public SpmlResponse()
Method Detail |
public void setRequestId(java.lang.String s)
public void setResult(java.lang.String s)
public void setError(java.lang.String s)
public void setErrorMessage(java.lang.String s)
public void setErrorMessage(java.lang.Throwable t)
public void addExtendedErrorMessage(java.lang.String s)
public void setOperationalAttributes(java.util.List l)
public void setOperationalAttributes(java.util.Map src)
public void setOperationalAttribute(Attribute a)
public void setOperationalAttribute(java.lang.String name, java.lang.Object value)
public void removeOperationalAttribute(java.lang.String name)
public java.lang.String getResult()
public boolean isFailure()
public java.lang.String getError()
public java.lang.String getErrorMessage()
public java.lang.String getRequestId()
public java.util.List getExtendedErrorMessages()
public java.util.List getOperationalAttributes()
public Attribute getOperationalAttribute(java.lang.String name)
public java.lang.Object getOperationalAttributeValue(java.lang.String name)
public void throwErrors() throws SpmlException
public java.lang.String toXml()
public static SpmlResponse parseResponse(java.lang.String xml) throws SpmlException
public static SpmlResponse parseResponse(org.openspml.message.Element domel)
public static SpmlResponse parseResponse(XmlElement e)
public static SpmlResponse createResponseForRequest(org.openspml.message.Element domel)
public static SpmlResponse createResponseForRequest(XmlElement e)
public void dumpFile(java.lang.String name)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |