Package com.sage.orion.sdata.servlet

Interface Summary

AsyncRequestHandler
AsyncStatusListener	A status listener that provides callback methods to update the processing progress of this task.
Authenticator
ILanguageResource	An ILanguageResource provides the ability to get messages by language.
PagingControl	A class that implements the PagingControl interface provides information about which page of a feed is being requested.
PoolFinder	The PoolFinder interface defines a mechanism for getting ResourceKindPool based upon authorization tokens
ResourceContext
ResourceElement	Element in a resource tree
ResourceFactory
ResourceKind	The base interface for a resource kind.
ResourceKindPool	A ResourceKindPool represents a pool of ResourceKind that can be used to satisfy requests.
ResourceResponse
SDataConversation	SData to SData communication Interface
SDataExternalRequest
SDataProvider	This is the interface that all SData providers must implement.
SDataRequest	The SDataRequest interface exposes the incoming SData Request in terms of SData terminology.
SDataResourceKindInfo	Contains the information for a particular instance of a loaded resource kind.
SDataResponse
SDataSchema	a schema as understood by the SData specification.
ServiceOperation	The ServiveOperation interface provides the core definition of the interface.
TaskCallable	A task that returns a result and may throw an exception.
TrackingIDMap	The TrackingMap is a map designed to handle tracking numbers.

Class Summary

AbstractResourceFactory	The AbstractResourceFactory class provides a base implementation of ResourceFactory.
AbstractSDataExternalRequest	Abstract class for SData external request
Base64	Encodes and decodes to and from Base64 notation.
Base64.InputStream	A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream	A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
BaseServiceOperation	An abstract class that provides an adapter for the ServiceOperation interface.
BaseServiceOperation.FieldData	The set of field data complete with methods to retrieve it based upon FieldNames
BaseServiceOperation.FieldNames	The pair of field name and description.
BindVariables	This class act as a container for holding the bind variables.
ClassMapApplication	An SData application
DefaultPagingControl
FileSchema	This class generates the schema from a file.
IncludeSpecification	Deprecated. Use the QueryPayloadControl directly
IndexedPagingControl	A structure to hold the elements of any indexed paging control request.
IndexedPagingInfo	The implementation of PagingInfo for IndexedPaging links
JDBCHelper	JDBC-specific constants and helpers
JDBCHelper.RequestPayloadProcessedInfo	A read-only "struct-like" class that holds the processed information from the payload part of an SData insert (POST) or update (PUT) request.
JDBCResourceKind	An abstract class that handles generic functionalities in favor of it's implementors.
JDBCResourceKind.HTTPMethodsAuthorizator	The HTTPMethodsAuthorizator is used to check whether the ResourceKind supports the specific HTTP method.
JDBCResourceKind.ResourceAuthorizator	The ResourceAuthorizator is used to check whether the user has the privilege to manipulate the ResourceKind.
JDBCResourceKind.ResourceDataAuthorizator	The ResourceDataAuthorizator is used to check whether the user has the privilege to manipulate the specific data of the ResourceKind specified in the request.
JiBXParser	A helper class to parser xml files using the JiBX Library (http://jibx.sourceforge.net/).
KeyedPagingControl	A structure to hold the elements of any keyed paging control request.
KeyedPagingInfo	The implementation of PagingInfo for keyedPaging links
LanguageResource	A utility class that provides the service of getting a single language resource string
MaskBuilder	MaskBuilder assists in building a mask pattern for the schema restriction.
MaskDataTypeBuilder	Builds the data type for the mask, for example A-Fa-f0-9 of a mask [A-Fa-f0-9]{8} This class should be used in conjunction with MaskBuilder.
OpenSearchResult	An OpenSearch information block
OptionalMapFilenameFilter	Filename filter for optional map files.
OrderByParameter
PagingInfo	An interface responsible for helping out in creating paging links.
PayloadControlPath	The PayloadControlPath class provides a resource path description that can be used with the QueryPayloadControl class, to express positions in the resource tree.
PortletCategoriesResource	A utility class that provides the service of getting a single portletCategories information object given a portletCategories ID.
PortletCategoriesResourceHelper	A utility class that contains PortletCategories Resource related constants and/or utility methods.
PortletResource	A utility class that provides the service of getting a single portlet information object given a portlet ID.
PortletResourceHelper	A utility class that contains Portlet Resource related constants and/or utility methods.
QueryParameter
QueryPayloadControl	The QueryPayloadControl class represents the Query Payload Control concept in the SData Specification.
ResourceField
ResourceKindInfo	Class to hold the detailed information on a resource in the pool.
ResourceListResourceKind	Resource Kind that lists all the running resources on the system.
ResourceResponseImpl	the normal SDataResponse object
SchemaResponse	Implementation of ResourceResponse where the payload is a schema
SDataConstants	Constants in the SData system
SDataDiagnoses
SDataDiagnosis	an SData Diagnosis element
SDataExternalDeleteRequest	Make a delete request to delete an entry from the external SData server
SDataExternalGetRequest	Make a get request to get a single entry from the external SData server
SDataExternalPagingInfo	The implementation of PagingInfo for getting links
SDataExternalPostRequest	Make a post request to create an entry from the external SData server
SDataExternalQueryRequest	Make a query request to get a feed of entries from the external SData server
SDataExternalResponse	Class to get the response for the external request
SDataExternalResponseHelper	Helper class to create SDataExternalResponse object
SDataExternalSchema	This class generate schema from the external SData response
SDataExternalSchemaRequest	Make a schema request to get schema from the external SData server
SDataExternalTemplateRequest	Make a template request to initialize an entry from the external SData server
SDataExternalUpdateRequest	Make a update request to update an entry from the external SData server
SDataHelper	Class for general SData helper routines.
SDataKey	Handles the conversion between the SData form of a key and an array of key segments.
SDataMessages	Constants in the SData system
SDataProviderFactory	A factory for creating the SDataProvider classes.
SDataRelatedResource	A Resource related to another resource
SDataRequestEntry	The SDataRequestEntry class represents an sdata entry within a request (which is slightly different from the response form).
SDataRequestFeed	A feed provided in an SData request
SDataRequestImpl	TODO: Fill in Javadoc for SDataRequestImpl.
SDataResourceElement	The new replacement for the ResourceEntity and all the other stuff that goes with it.
SDataResourceElement.CDataCreator	Creator for the CData type of SDataResourceElement
SDataResourceElement.FieldCreator	Creator for the Field resource type.
SDataResourceElement.ReferenceCreator	Creator for the Field resource type.
SDataResourceElement.ReferenceListCreator	Creator for the Reference List type of resource.
SDataResponseEntry	An Atom Entry in an SData response.
SDataResponseFeed	An Atom Feed in an SData response.
SDataServer	Class holds elements to contact a web server
SDataServlet	The SDataServlet is the actual servlet.
SDataServletContext	A class to hold the information that we want to hold for the whole servlet.
SDataTracking
SDataWebConversation	SData to SData communication over HTTP protocol
ServiceField	Service field class
ServiceFieldBoolean	a ServiceField of type ServiceField.ServiceFieldType.BOOLEAN
ServiceFieldDecimal	ServiceFieldDecimal contains information of the ServiceField related to only Decimal field types.
ServiceFieldPresentItem	An item in the list of a service field's presentation items
ServiceFieldString	ServiceFieldString contains information of the ServiceField related to only String field types.
ServiceOperationHelper	This class is designed to contain helper routines for the SData Service Operations.
ServiceSchema	The ServiceSchema is a class that represents the schema of a service operation.
SystemApplicationContext
SystemHelper	A Utility class for servlet package that contains some static helper methods.
SystemProvider	SData Provider for handling System SData requests.
SystemResourcePool
TrackingIDInfo
TrackingIDMapImpl
TrackingPayload	The class controls behavior of the async sdata requests
XMLBoolean	A utility class for translating booleans to and from XML
XMLHelper	group of helper routines to make processing XML files easier.

Enum Summary

JDBCDatabaseType	Specifies the types of databases supported by our JDBC layer
MaskBuilder.CaseType
MaskBuilder.PrintCaseType
MaskBuilder.StringSegmentType
PagingControl.PagingMethod
QueryParameter.QueryType	The different query parameter types
ResourceElement.Navigation
ResourceElement.Type	An enumeration of the types of resource element
SDataConstants.KeyDirection	The possible directions for key-based indexing
SDataDiagnosis.Severity	Severity of the diagnosis entry
SDataRequest.SDataMethod	The possible types of SData request
SDataResourceElement.Type	TODO: Fill in Javadoc for Type.
SDataResourceKindInfo.Status	The status of the resource kind.
SDataServletContext.Mode	The mode that the servlet is running: Host, Deployed or Test
ServiceField.ServiceFieldPresentationType	Indicates the type of presentation information defined for a field.
ServiceField.ServiceFieldType	Service field types enum

Exception Summary

ForbiddenException	The ForbiddenException exception is to be thrown when the request has been provided valid authentication information but the caller is not permitted access to that resource for the operation in question.
IncompleteKeyInPayloadException	SData exception to be thrown when a payload used for updates (PUT) or for non auto-generated key inserts (POST) is missing key field values.
JDBCResourceConflictException	This class extends JDBCResourceKindSQLException instead of RuntimeException ,since having an ancestor makes the replacement possible to catch all descendants by using the single relevant ancestor
MalformedPayloadException	Class for a malformed Payload Exception.
MalformedURLException
MalformedURLQueryException
NoRecordsAffectedException
NotFoundException	SData exception to be thrown when a requested resource or property is not found.
NotFoundIntermediateException	NotFoundIntermediateException is an exception raised when an Intermediate Resource is not found .
NotSupportedHttpMethodException	SData exception to be thrown when an HTTP method used to execute the request is not supported.
PlatformException	There is some sort of defect in the platform
PopulateJDBCTableException	The class stands for exceptions thrown out during populating portal database.
ResourceKindNotFoundException
UnauthorizedException	The UnauthorizedException exception is to be thrown when a request requires authentication information of some sort and that information has not been provided.