|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.openspml.message.SpmlRequest
The base class for all SPML request objects. It provides a request ID, request mode, and a collection of vendor specfific operational attributes.
Field Summary | |
static java.lang.String |
EXEC_ASYNCHRONOUS
|
static java.lang.String |
EXEC_SYNCHRONOUS
Internal constants for the execution type. |
Fields inherited from interface org.openspml.message.Constants |
ACTION_PREFIX,
ENUM_PREFIX |
Constructor Summary | |
SpmlRequest()
|
Method Summary | |
abstract SpmlResponse |
createResponse()
Build an empty SpmlRequest object that corresponds to this request. |
void |
dumpFile(java.lang.String name)
Handy function to call in the debugger. |
abstract java.lang.String |
getElementName()
Return the tag name for the request element. |
Identifier |
getIdentifier()
Return the target object identifier. |
java.lang.String |
getIdentifierString()
Return the target object identifier as a string. |
Attribute |
getOperationalAttribute(java.lang.String name)
Lookup an attribute by name. |
java.util.List |
getOperationalAttributes()
Return the list of operational attributes. |
java.lang.Object |
getOperationalAttributeValue(java.lang.String name)
|
java.lang.String |
getRequestId()
Return the optional request id. |
boolean |
isAsynchronous()
Return true if asynchronous execution was requested. |
static SpmlRequest |
parseRequest(org.openspml.message.Element domel)
Parse one of the "root" requests. |
static SpmlRequest |
parseRequest(XmlElement e)
Parse one of the "root" requests. |
void |
setAsynchronous(boolean b)
Set a flag indicating whether the request is to be performed asynchronously. |
void |
setIdentifier(Identifier id)
Sets the target object identifier. |
void |
setIdentifier(java.lang.String id)
Sets the target object identifier. |
void |
setOperationalAttribute(Attribute a)
Set one operational attribute specified as an Attribute object. |
void |
setOperationalAttribute(java.lang.String name,
java.lang.Object value)
Set an operational attribute specified as a name/value pair. |
void |
setOperationalAttributes(java.util.List l)
Set the list of operational attributes. |
void |
setRequestId(java.lang.String s)
Set the optional request id. |
java.lang.String |
toXml()
Render requst XML. |
void |
toXml(SpmlBuffer b)
Render requst XML into an existing buffer. |
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 EXEC_SYNCHRONOUS
public static final java.lang.String EXEC_ASYNCHRONOUS
Constructor Detail |
public SpmlRequest()
Method Detail |
public void setRequestId(java.lang.String s)
public void setAsynchronous(boolean b)
public void setOperationalAttributes(java.util.List l)
Attribute
objects.#Attribute
public void setOperationalAttribute(Attribute a)
#Attribute
public void setOperationalAttribute(java.lang.String name, java.lang.Object value)
Note that while the method allows values of any type, in practice this should be limited to String values until the specification is extended to support complex value types.
public void setIdentifier(Identifier id)
public void setIdentifier(java.lang.String id)
Identifier
object whose
type is GenericString
.public abstract SpmlResponse createResponse()
public java.lang.String getRequestId()
public boolean isAsynchronous()
public java.util.List getOperationalAttributes()
Attribute
objects.public Identifier getIdentifier()
#Identifier
public java.lang.String getIdentifierString()
public Attribute getOperationalAttribute(java.lang.String name)
public java.lang.Object getOperationalAttributeValue(java.lang.String name)
public abstract java.lang.String getElementName()
public java.lang.String toXml()
public void toXml(SpmlBuffer b)
public static SpmlRequest parseRequest(org.openspml.message.Element domel)
public static SpmlRequest parseRequest(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 |