Package com.edustructures.sifworks

Core classes and interfaces of the SIFWorks® ADK® for Java.

See:
Description

Interface Summary

DataObjectInputStream	DataObjectInputStream is supplied to message handlers to allow agents to stream an arbitrarily large set of SIFDataObjects from SIF_Response and SIF_Event messages.
DataObjectOutputStream	DataObjectOutputStream is supplied to the Publisher.onRequest message handler to allow agents to stream an arbitrarily large set of SIFDataObjects when responding to SIF_Request messages.
DTD	Classes that implement the DTD interface provide information about the schema of elements and attributes.
ElementDef	Encapsulates metadata for a SIF element or attribute.
ElementVersionInfo	Represents information about an ElementDef that is specific to a version of SIF
ISIFElement
MessageInfo	Provides information about an XML message, such as envelope and header attributes, the source of the message, and optionally the raw XML document that comprises the message.
MessagingListener	The base interface for all listener interfaces related to the exchange of messages over the underlying messaging infrastructure.
Provisioner	Provisioner is a common interface implemented by the Agent, Zone, and Topic classes.
Publisher	The Publisher interface is implemented by classes that respond to queries (SIF_Requests).
QueryResults	The QueryResults interface is implemented by classes that process the results of queries initiated by the agent.
ReportObjectOutputStream	The ReportObjectOutputStream is implemented by the ADK to supply agents with a means of streaming arbitrarily large SIF Data Objects responses for SIF_ReportObject queries in SIF 1.5 and later.
ReportPublisher	The ReportPublisher interface is implemented by message handler classes that respond to requests for SIF_ReportObject.
RequestInfo	Represents information cached by the ADK about a specific SIF_Request
SIFMessagingListener	A MessagingListener that can be implemented to receive notification when when SIF-related messaging activity takes place.
SIFObjectLink
Subscriber	The Subscriber message handler interface is implemented by classes that wish to process SIF_Event messages received from a zone.
Topic	Aggregates publish, subscribe, and query activity across multiple zones.
TopicFactory	Creates Topic objects and provides access to the topics that have been created during this session of the agent.
TypedValueBuilder
UndeliverableMessageHandler	Called when the ADK cannot dispatch an inbound message to a message handler.
ValueBuilder	Classes that implement the ValueBuilder interface evaluate an arbitrary expression to produce a string value.
Zone	A Zone is a logical grouping of applications that exchange data through the Schools Interoperability Framework.
ZoneFactory	Creates Zone objects and provides access to the Zones created by an agent.

Class Summary

ADK	A global class representing the SIFWorks® ADK class framework.
ADKFlags	Flags and constants used throughout the ADK.
ADKProperties	The abstract base class for agent and zone properties.
Agent	The base class for a SIF Agent.
AgentProperties	Properties describing the operational settings of the agent or a zone.
Condition	A query condition.
ConditionGroup	A group of query conditions.
DefaultValueBuilder	The default ValueBuilder implementation evaluates an expression to produce a string value.
Element	The abstract base class for all element and attribute classes in the SIF Data Objects library.
Event	Encapsulates a SIF Event.
HttpProperties	Properties for the HTTP transport protocol.
HttpsProperties	Properties for the HTTPS transport protocol.
ProvisioningOptions
PublishingOptions	Encapsulates all of the optional behavior that a publisher is able to support.
Query	Encapsulates a SIF Query.
QueryResultsOptions	Encapsulates a set of provisioning options for a QueryResults handler
ReportPublishingOptions	* Encapsulates all of the optional behavior that a publisher is able to support.
SIFActionList<T extends SIFKeyedElement>	Represents a repeatable element list in SIF, in which each item is identifed with a key.
SIFBoolean	Wraps a Java Boolean Type in an immutable instance that can be used to construct a SIFSimpleType to represent properties in SIF data objects.
SIFContext	Contains behavior and implementation details for each SIF Context officially supported by the ADK
SIFDataObject	The abstract base class for all root-level SIF Data Object classes.
SIFDataObjectXML	A SIFDataObject implementation that wraps raw XML messages.
SIFDate	Wraps a Java Calendar in an immutable instance that can be used to construct a SIFSimpleType to represent properties in SIF data objects
SIFDateTime
SIFDaysOfWeek	A value representing one or more days of the week in SIF format.
SIFDecimal
SIFDTD	Metadata for the Schools Interoperability Framework (SIF)
SIFDuration
SIFElement	The abstract base class for all SIF Elements.
SIFEncryption	Provides easy read and write access to encrypted passwords in the Authentication object
SIFEnum	Describes the acceptable values for an enumerated SIF attribute or element
SIFErrorCodes	Defines SIF 1.0r1 error category and code constants.
SIFFormatter	A class that converts native datatypes supported by SIF to their textual representation.
SIFInt	Wraps a Java Integer Type in an immutable instance that can be used to construct a SIFSimpleType to represent properties in SIF data objects.
SIFKeyedElement
SIFKeyedList<T extends SIFKeyedElement>
SIFList<T extends SIFElement>
SIFMessageInfo	Encapsulates information about a SIF_Message, including its payload type, header fields, and raw XML message content.
SIFMessagePayload	A specialization of SIFElement for SIF infrastructure messages such as SIF_Register, SIF_Request, and SIF_Event.
SIFParser	Parses a SIF message or Data Object into a SIFElement object graph.
SIFResponseSender	Helper class to send SIF_Response messages when an agent defers automatic sending of responses in its implementation of the Publisher.onRequest message handler.
SIFSimpleType<T>	Wraps a Java Simple Type in an immutable instance that can be used to construct SimpleFields that represent properties in SIF data objects.
SIFStatusCodes	Defines SIF 1.0r1 status code constants.
SIFString	Wraps a Java String in an immutable instance that can be used to construct a SIFSimpleType to represent properties in SIF data objects
SIFTime
SIFTypeConverter<T>
SIFTypeConverters
SIFVersion	Encapsulates a SIF version number.
SIFWriter	Renders a SIFElement to an XML stream in SIF format.
SimpleField<T>	A simple field value.
SubscriptionOptions	Encapsulates the set of Subscription options supported by a given subscriber
TrackQueryResults	Synchronously issues one or more SIF Requests to a zone or topic and returns the results to the calling thread as they are received.
TrackQueryResultsData	Encapsulates result data returned by the TrackQueryResults class.
TransportProperties	Properties describing operational settings of a transport protocol.

Enum Summary

AgentMessagingMode	The messaging mode in effect for the agent.
AgentProvisioningMode	Refer to the Developer Guide for more information on the ADK's provisioning modes.
ComparisonOperators	Operators used to control how an element value is compared in a SIF_Query
EventAction
GroupOperators	Operators used to logically group condition groups
SIFDataType	An enumeration of XSD datatypes supported by the ADK
SIFErrorCategory	The list of codes defined by SIF for SIF_Category element in SIF_Error

Exception Summary

ADKException	The base class for all exception classes defined by the ADK.
ADKMessagingException	Exception signaling that an error has occurred processing a message.
ADKParsingException	Signals an error parsing SIF message or datatype content
ADKQueueException	Exception signaling that an error has occurred in the Agent Queue.
ADKSchemaException	Thrown when an element or attribute is referenced but does not exist.
ADKTransportException	Exception signaling that an error has occurred in a transport protocol.
ADKUnknownOperatorException
ADKZoneNotConnectedException	Exception signaling that a method was called on a Zone instance but the zone is not in a connected state.
SIFException	SIFException describes a SIF error condition.

Error Summary

ADKNotSupportedException

Signals an operation is not supported.

Package com.edustructures.sifworks Description

Core classes and interfaces of the SIFWorks® ADK® for Java.