Class RESTMessage

java.lang.Object

com.netscape.certsrv.base.RESTMessage

All Implemented Interfaces:

JSONSerializer

Direct Known Subclasses:

Account, CAInfo, CertEnrollmentRequest, Info, KeyArchivalRequest, KeyGenerationRequest, KeyRecoveryRequest, KRAInfo, PKIException.Data

public class RESTMessage
extends Object
implements JSONSerializer

This is a base class for some REST request/response messages. JSON mapping:

{
    "Attributes": {
        "Attribute": [
            {
                "name": ...,
                "value": ...
            },
            ...
        ]
    },
    "ClassName": ...
}

XML mapping:

<ResourceMessage>
    <Attributes>
        <Attribute name="...">...</Attribute>
        ...
    </Attributes>
    <ClassName>...</ClassName>
</ResourceMessage>

Author:

Ade Lee

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RESTMessage.Attribute
static class	RESTMessage.AttributeList
static class	RESTMessage.AttributeListDeserializer
static class	RESTMessage.AttributeListSerializer

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	attributes
protected String	className

Fields inherited from interface JSONSerializer

logger

Constructor Summary

Constructors

Constructor	Description
RESTMessage()
RESTMessage(Map<String,String[]> parameterMap)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static RESTMessage	fromDOM(Element element)
static void	fromDOM(Element element, RESTMessage resourceMessage)
static RESTMessage	fromXML(String xml)
String	getAttribute(String name)
RESTMessage.AttributeList	getAttributeList()
Collection<String>	getAttributeNames()
Map<String,String>	getAttributes()
String	getClassName()
int	hashCode()
String	removeAttribute(String name)
void	setAttribute(String name, String value)
void	setAttributeList(RESTMessage.AttributeList list)
void	setAttributes(Map<String,String> attributes)
void	setClassName(String className)
Element	toDOM(Document document)
void	toDOM(Document document, Element element)
String	toString()	Returns a string representation of the object.
String	toXML()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface JSONSerializer

toJSON

Field Details

attributes

protected Map<String,String> attributes

className

protected String className

Constructor Details

RESTMessage

public RESTMessage()

RESTMessage

public RESTMessage(Map<String,String[]> parameterMap)

Method Details

getClassName

public String getClassName()

setClassName

public void setClassName(String className)

getAttributes

public Map<String,String> getAttributes()

setAttributes

public void setAttributes(Map<String,String> attributes)

getAttributeList

public RESTMessage.AttributeList getAttributeList()

setAttributeList

public void setAttributeList(RESTMessage.AttributeList list)

getAttributeNames

public Collection<String> getAttributeNames()

getAttribute

public String getAttribute(String name)

setAttribute

public void setAttribute(String name,
 String value)

removeAttribute

public String removeAttribute(String name)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toDOM

public void toDOM(Document document,
 Element element)

toDOM

public Element toDOM(Document document)

fromDOM

public static void fromDOM(Element element,
 RESTMessage resourceMessage)

fromDOM

public static RESTMessage fromDOM(Element element)

toXML

public String toXML()
             throws Exception

Throws:

Exception

fromXML

public static RESTMessage fromXML(String xml)
                           throws Exception

Throws:

Exception

toString

public String toString()

Returns a string representation of the object. Do not serialize the REST message by default to avoid exposing sensitive info. Subclasses can override this method if it's safe.

Overrides:

toString in class Object