|
SienaXML (v.2.0.0) API documentation | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsiena.ThinClient
siena.xml.XMLClient
public class XMLClient
This is a client based on the example ThinClient class in Siena. It can be used as a front end to the XML translation process so that a user of the class can simply ask it to publish and XML notification and it will do the rest.
XMLProcessor
Constructor Summary | |
---|---|
XMLClient(java.lang.String server)
This a generic constructor for the class. |
Method Summary | |
---|---|
void |
clearUserRules()
This method will clear the user rules and use only the default rules when procsesing XML notifications. |
void |
publish(java.lang.String xmlNotification)
This method takes a XML notification and publishes it to the Siena server. |
void |
setStyleSheet(java.lang.String filename)
This method sets the stylesheet used by the XML notification. |
void |
setUserRules(java.lang.String filename)
This method sets the user's rules. |
void |
subscribe(java.lang.String xpath,
Notifiable n)
This method is used to subscribe to the XML notifications. |
void |
unsubscribe(java.lang.String xpath,
Notifiable n)
This method unsubscribes and XPath from the SIENA servers. |
void |
update(XMLSubscriptionHandler handler)
This method is used by the XMLSubscriptionHandler to notify the client when an XML notification has been matched to the subscription this client generated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLClient(java.lang.String server) throws siena.comm.InvalidSenderException
server
- the uri of the server to connect to
(e.g., "senp://host.domain.net:7654")
InvalidSenderException
- Is thrown when there is a problem connecting to the SIENA serverMethod Detail |
---|
public void publish(java.lang.String xmlNotification) throws siena.SienaException
xmlNotification
- This is the XML notification to be sent through the SIENA server network
SienaException
- This is thrown if there are problems translating the XML notification or sending it to a SIENA serverpublic void setStyleSheet(java.lang.String filename) throws java.io.IOException
filename
- The name of the file that contains the XSchema
IOException
- An IOException is thrown if processing the file containing the XSchema has a problem.public void setUserRules(java.lang.String filename) throws siena.SienaException
filename
- The name of the file that contains the users rules.
SienaException
- Thrown if a problem occurs when processing the user rules file.Rules#
public void clearUserRules()
public void update(XMLSubscriptionHandler handler)
update
in interface Observer
handler
- Reference to the XMLSubscriptionHandler that was being observered which issued the update.public void subscribe(java.lang.String xpath, Notifiable n) throws siena.SienaException
n
- The notifiable object which should be notified when an XML Notification has been recieved that matches the subscription.xpath
- A String containing the XPath subscription
siena.SienaException
- This is thrown when there is a problem translating the XPath into SIENA subscriptions.public void unsubscribe(java.lang.String xpath, Notifiable n) throws siena.SienaException
xpath
- The XPath subscription to removen
- The notifiable object that was associated with the XPath
SienaException
- This is thrown if an error occurs when trying to unsubscribe the subscription(s) from the SIENA server.
|
SienaXML (v.2.0.0) API documentation | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |