s3i_flutter
library
Classes
AccessToken
Represents an Access Token from OAuth2.0/OpenID Connect.
ActiveBrokerInterface
The ActiveBrokerInterface is the baseclass for all broker interfaces
which inform the user asynchronous (via a callback) when a new message is
available.
AND
A LogicalQuery : Ensures that all given queries match.
Attachment
Represents a S3I::B::Attachment - an optional field of a UserMessage .
AttributeValueMessage
Represents a S3I::B::AttributeValueMessage - used to modify specific
data at an other thing in the S3I.
AuthenticationManager
Base class for the different authentication approaches to
the S3I-IdentityProvider.
BrokerAmqpConnector
This ActiveBrokerInterface implementation uses the native messaging
protocol of the S3I-Broker: AMQP.
BrokerInterface
The baseclass for all communication interfaces with the S3I-Broker.
ClientIdentity
Represents a simple Client in the OpenID-Connect terms for authentication
at the S3I-IdentityProvider.
CreateAttributeMessage
Represents a S3I::B::GetValueMessage - used to create a specific value.
DeleteAttributeMessage
Represents a S3I::B::DeleteAttributeMessage - used to delete a specific
value.
DirObject
Represents an Object in the S3I-Directory data model.
Endpoint
Represents an Endpoint in the S3I-Directory data model.
EQ
A RelationalQuery : Filter property values equal to value .
EXISTS
A Relational Query operator: Filter property values (jsonPointer )
which exist.
FieldQuery
Represents a the field filter parameter in a query.
GE
A RelationalQuery : Filter property values greater than or equal
to value .
GetValueMessage
Represents a S3I::B::GetValueMessage - used to get a specific value.
GetValueReply
Represents a S3I::B::GetValueReply - used to answer a GetValueRequest.
GetValueRequest
Represents a S3I::B::GetValueRequest - used to request to get a
specific value.
GT
A RelationalQuery : Filter property values greater than value .
IN
A Relational Query operator: Filter property values which contains at least
one of the listed values .
JsonWebToken
The base class for all JWTs in the S3I.
LE
A RelationalQuery : Filter property values less than or equal to value .
LIKE
A RelationalQuery : Filter property values which are like (similar)
to value .
Link
Represents a Link in the S3I-Directory data model.
Location
Represents a Location in the S3I-Directory data model.
LogicalQuery
Represents a query with the logical operators: AND & OR.
LT
A RelationalQuery : Filter property values less than value .
NamespaceQuery
Represents a the namespace filter parameter in a query.
NE
A RelationalQuery : Filter property values not equal to value .
NOT
A Logical Query operator: Negates the given query.
OAuthProxyFlow
Uses the S3I-OAuthProxy to obtain an access and refresh token.
OptionQuery
Represents additional options for a query to the S3I-Directory/Repository.
OR
A LogicalQuery : Ensures that at least one of the given queries match.
PassiveBrokerInterface
The PassiveBrokerInterface is the baseclass for all broker interfaces
where the user needs to call a method to see if a new message is available.
PolicyEntry
A specific Policy for one Entry in the directory or repository.
PolicyGroup
A specific Group in a policy entry.
PolicyResource
The protected Resource of a ditto policy group.
PolicySubject
The Subject of a ditto policy group.
RefreshToken
Represents a Refresh Token from OAuth2.0/OpenID Connect.
RelationalQuery
Represents a query with relational operators.
RQLQuery
Base class for all RQL query classes.
S3ICore
The main communication class to the S3I.
ServiceMessage
Represents a S3I::B::ServiceMessage - used to invoke service functions
or receive service answers.
ServiceReply
Used to return the results of a specific service function.
ServiceRequest
Used to invoke a specific service function with optional parameters.
SetValueMessage
Represents a S3I::B::SetValueMessage - used to set a specific value.
SortConfig
Represents one specific sort option to a specified property.
Thing
Represents a Thing in the S3I-Directory data model.
UserMessage
Represents a S3I::B::UserMessage - used for communication between two
real users.
Val
Represents a Query value in RQL.
Value
Represents a Value in the S3I-Directory data model.
Functions
assembleQuery (String base , {RQLQuery ?rqlFilter , NamespaceQuery ?namespaceQuery , FieldQuery ?fieldQuery , OptionQuery ?optionQuery → String
Returns a String which includes the base and the given
rqlFilter, namespaceQuery, fieldQuery and optionQuery if they
aren't null.
getActiveBrokerDefaultConnector (AuthenticationManager authManager , {Map <String dynamic > args = const <String, dynamic>{} → ActiveBrokerInterface
Creates a new BrokerAmqpConnector .
getActiveBrokerEventConnector (AuthenticationManager authManager , {Map <String dynamic > args = const <String, dynamic>{} → ActiveBrokerInterface
Creates a new BrokerAmqpConnector configured to be used for the
Event System.
Exceptions / Errors
InvalidJsonSchemaException
Exception thrown when a json document could not be parsed correctly.
JsonMissingKeyException
Exception thrown when a json document (Entry) is missing a key attribute
which is needed in the (f)ml40 structure.
MaxRetryException
Exception thrown if the maximum numbers of retries of an request is exceeded.
NetworkAuthenticationException
Exception thrown when a request could not be executed because there is no
valid AccessToken available (could not be issued).
NetworkResponseException
Exception thrown if a network request returned with an unexpected
status code
ParseException
Exception thrown when a piece of data could not be parsed correctly.
ResponseParsingException
Exception thrown when a request response could not be parsed correctly to
an Entry.
S3IException
Base class for all Exceptions in the s3i_flutter package.
