|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
AssociationElementParent | Any XDS element that contains zero or one child
<association> elements. |
AssociationElementsParent | Any XDS element that contains zero or more child
<association> elements. |
CommandElement | A XDS-encoded command. |
OptionsParent | A <driver-options> ,
<publisher-options> , or
<subscriber-options> element. |
ParamElement | Any element that contains driver option, driver state, or authentication information. |
ParamParent | A <driver-options> ,
<publisher-options> ,
<subscriber-options> , <driver-state> ,
<publisher-state> ,
<subscriber-state> , or
<authentication-info> element. |
PasswordElementParent | Any XDS element with zero or one child <password>
elements. |
QueryResultDocument | The document returned from method execute(XmlDocument,
XmlQueryProcessor) of interface XmlCommandProcessor or
method query(XmlDocument) of interface
XmlQueryProcessor in response to a <query>
command. |
ReadableDocument | Any XDS document that can be read from. |
SomeAttrElement | Any XDS element with an attr-name attribute. |
StateDocument | Any XDS document that can hold driver state information. |
StateParent | A <driver-state> , <publisher-state> ,
or <subscriber-state> element. |
StatusDocument | Any XDS document that can hold driver status information. |
StatusStateDocument | Any XDS document that can contain driver state and information. |
TextParent | Any XDS element that contains zero or more child text nodes. |
ValueElementsParent | Any XDS element that contains zero or more child <value>
elements. |
WriteableDocument | Any XDS document that can be written to. |
XDSDocument | A XDS-formatted, XML document. |
XDSElement | Any element defined in the XDS DTD. |
Class Summary | |
Constraint | Defines the set of legal values for a Parameter . |
ConstraintGroup | A mechanism for grouping Parameter Constraint s with logical operators (LogicalOp s). |
Constraints | A collection of Constraint s. |
DataType | An enumeration of Parameter data types. |
DescriptionElement | A <description> element. |
DNFormat | An enumeration of dn-format values. |
DocumentImpl | Superclass implementation of all XDS documents. |
DTD | A subset of the Data Type Definition for XDS XML. |
DTDVersion | An enumeration of values for the <nds> element's
dtdversion attribute. |
DynamicEnumConstraint | A constraint that lists the possible set of values for a
Parameter . |
ElementImpl | Superclass implementation of all elements. |
EnumConstraint | An constraint that lists the possible set of java.lang.String
values for a Parameter . |
EqualityOp | An equality operator [<, >, <=, >=]. |
ExceptionElement | An <exception> element. |
LogicalOp | A logical operator [OR, AND]. |
MultiRequiredConstraint | A constraint that excludes null or empty string from a
Parameter 's legal set of values. |
MultiUniqueConstraint | A constraint that ensures one or more scalar parameter's values are unique. |
MultiValueConstraint | Constrains a parameter so it can have more than one value. |
NonXDSElement | An element not defined in the XDS DTD -- most likely a parameter, state, or custom command element. |
Operator | An operator. |
Parameter | A convenience class used to extract values from a ParamElement . |
QueryScope | An enumeration of values for the <query> element's
scope attribute. |
RangeConstraint | A constraint that defines the possible range of values for a
Parameter . |
ReadAttrType | An enumeration of values for a <read-attr> element's
type attribute. |
RegExConstraint | A constraint that specifies a regular expression pattern for a
Parameter 's values. |
RequiredConstraint | A constraint that excludes null or empty string from a
Parameter 's legal set of values. |
SingleValueConstraint | Constrains a parameter to have at most one value. |
StatusLevel | An enumeration of values for a <status> element's
level attribute. |
StatusType | An enumeration of values for a <status> element's
type attribute. |
TypedEnumConstraint | A constraint that lists the possible set of typed values for a
Parameter . |
UniqueConstraint | A constraint that ensures a scalar parameter's values are unique. |
ValueType | An enumeration of the values for a <value> element's
type attribute. |
XDS | Package-exported constants. |
XDSAddAssociationElement | An <add-association> element. |
XDSAddAttrElement | An <add-attr> element. |
XDSAddElement | An <add> element. |
XDSAddValueElement | An <add-value> element. |
XDSAllowAttrElement | An <allow-attr> element. |
XDSAllowClassElement | An <allow-class> element. |
XDSAssociationElement | An <association> element. |
XDSAttrDefElement | An <attr-def> element. |
XDSAttrElement | An <attr> element. |
XDSAuthenticationInfoElement | An <authentication-info> element. |
XDSCheckObjectPasswordElement | A <check-object-password> element. |
XDSClassDefElement | A <class-def> element. |
XDSCommandDocument | The XmlDocument passed to method execute(XmlDocument,
XmlQueryProcessor) of interface XmlCommandProcessor . |
XDSCommandResultDocument | The XmlDocument returned from method execute(XmlDocument,
XmlQueryProcessor) of interface XmlCommandProcessor . |
XDSComponentElement | A <component> element. |
XDSContactElement | A <contact> element. |
XDSDeleteElement | A <delete> element. |
XDSDriverFilterElement | A <driver-filter> element. |
XDSDriverOptionsElement | A <driver-options> element. |
XDSDriverStateElement | A <driver-state> element. |
XDSHeartbeatDocument | A specific instance of the XmlDocument passed to method
execute(XmlDocument, XmlQueryProcessor) of interface
XmlCommandProcessor . |
XDSInitDocument | The XmlDocument passed to method init(XmlDocument)
of interfaces DriverShim , PublicationShim , and
SubscriptionShim and the getSchema(XmlDocument)
method of interface DriverShim . |
XDSInitParamsElement | An <init-params> element. |
XDSInstanceElement | An <instance> element. |
XDSModifyAssociationElement | A <modify-association> element. |
XDSModifyAttrElement | A <modify-attr> element. |
XDSModifyElement | A <modify> element. |
XDSModifyPasswordElement | A <modify-password> element. |
XDSMoveElement | A <move> element. |
XDSNewNameElement | A <new-name> element. |
XDSOldPasswordElement | An <old-password> element. |
XDSParentElement | A <parent> element. |
XDSPasswordElement | A <password> element. |
XDSProductElement | A <product> element. |
XDSPublisherOptionsElement | A <publisher-options> element. |
XDSPublisherStateElement | A <publisher-state> element. |
XDSQueryDocument | The XmlDocument passed to the query(XmlDocument)
method of interface XmlQueryProcessor . |
XDSQueryElement | A <query> element. |
XDSQueryExElement | A <query-ex> element. |
XDSQueryResultDocument | The XmlDocument returned from method
query(XmlDocument) of interface
XmlQueryProcessor . |
XDSQueryTokenElement | A <query-token> element. |
XDSReadAttrElement | A <read-attr> element. |
XDSReadParentElement | A <read-parent> element. |
XDSRemoveAllValuesElement | A <remove-all-values> element. |
XDSRemoveAssociationElement | Deprecated. Drivers should not issue this command. |
XDSRemoveValueElement | A <remove-value> element. |
XDSRenameElement | A <rename> element. |
XDSResultDocument | The XmlDocument returned from method
init(XmlDocument) of interfaces DriverShim ,
SubscriptionShim , and PublicationShim , method
start(XmlCommandProcessor) of interface
PublicationShim , and method shutdown(XmlDocument)
of interface DriverShim . |
XDSSchemaDefElement | A <schema-def> element. |
XDSSchemaResultDocument | The XmlDocument returned from the
getSchema(XmlDocument) method of interface
DriverShim . |
XDSSearchAttrElement | A <search-attr> element. |
XDSSearchClassElement | A <search-class> element. |
XDSServerElement | A <server> element. |
XDSSourceElement | A <source> element. |
XDSStatusElement | A <status> element. |
XDSSubscriberOptionsElement | A <subscriber-options> element. |
XDSSubscriberStateElement | A <subscriber-state> element. |
XDSUserElement | A <user> element. |
XDSValueElement | A <value> element. |
Exception Summary | |
XDSException | Exceptions thrown from this package that must be handled. |
XDSMethodInvocationContextException | This exception is thrown whenever a method is called out-of-context. |
XDSParameterException | This exception is thrown if a parameter constraint is violated. |
XDSParseException | This exception is thrown when a XDS document is empty, malformed, or invalid. |
A library that simplifies the consumption and production of XDS-formatted, XML documents.
The top-level API consists of 8 document classes:
XDSInitDocument:
This document is intended for use with the DriverShim
's,
PublicationShim
's, and SubscriptionShim
's
init(XmlDocument):XmlDocument
methods. XDSInitDocument represents
the document passed to this method.
XDSResultDocument:
This document is intended for use with the DriverShim
's,
PublicationShim
's, and SubscriptionShim
's
init(XmlDocument):XmlDocument
method, the
DriverShim.shutdown(XmlDocument):XmlDocument
method, and the
PublicationShim.start(XmlCommandProcessor):XmlDocument
interface.
The XDSResultDocument represents the document returned from these methods.
XDSCommandDocument, XDSCommandResultDocument:
These documents are intended for use with the XmlCommandProcessor
interface. XDSCommandDocument represents the document passed to the
XmlCommandProcessor.execute(XmlDocument, XmlQueryProcessor):XmlDocument
method. XDSCommandResultDocument represents the document returned from
this method. Since SubscriptionShim
interface is a
XmlCommandProcessor
, the XDSCommandDocument can be used to parse and
validate documents passed to the SubscriptionShim.execute(XmlDocument, XmlQueryProcessor):XmlDocument
method. The PublicationShim
interface is not a XmlCommandProcessor
. A reference to
a command processor is passed to the publisher, however, via the
PublicationShim.start(XmlCommandProcessor):XmlDocument
method.
XDSQueryDocument, XDSQueryResultDocument:
These documents are intended for use with the XmlQueryProcessor
interface. XDSQueryDocument represents the document passed to the
XmlQueryProcessor.query(XmlDocument):XmlDocument
method.
XDSQueryResultDocument represents the document returned from this method.
Since the PublicationShim
interface is a XmlQueryProcessor
,
the XDSQueryDocument can be used to parse and validate documents passed to the
PublicationShim.query(XmlDocument):XmlDocument
method. The
SubscriptionShim
interface is not a XmlQueryProcessor
.
A reference to a query processor is passed to the subscriber, however, via the
SubscriptionShim.execute(XmlDocument, XmlQueryProcessor):XmlDocument
method.
XDSSchemaResultDocument:
This document is intended for use with the
DriverShim.getSchema(XmlDocument):XmlDocument
method.
XDSSchemaResultDocument represents the document returned from this method.
XDSHeartbeatDocument:
This document is intended for use with the
PublicationShim.start(XmlCommandProcessor):XmlDocument
method.
This document is published periodically to indicate good publisher health.
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |