Package Org.IdentityConnectors.Framework.Common.Objects

Namespaces
package	Filters

Classes
class	BigDecimal
	Placeholder since C# doesn't have a BigInteger More...
class	BigInteger
	Placeholder since C# doesn't have a BigInteger More...
class	ConnectorAttribute
	Represents a named collection of values within a resource object, although the simplest case is a name-value pair (e.g., email, employeeID). Values can be empty, null, or set with various types. Empty and null are supported because it makes a difference on some resources (in particular database resources). The developer of a Connector will use an builder to construct an instance of ConnectorAttribute. More...
class	ConnectorAttributeBuilder
class	ConnectorAttributeInfo
class	ConnectorAttributeInfoBuilder
	Simplifies the process of building 'AttributeInfo' objects. More...
class	ConnectorAttributeInfoUtil
class	ConnectorAttributesAccessor
	Attributes Accessor convenience methods for accessing attributes. More...
class	ConnectorAttributeUtil
interface	ConnectorMessages
	Message catalog for a given connector. More...
class	ConnectorObject
class	ConnectorObjectBuilder
class	CultureInfoCache
class	EmbeddedObject
	An More...
class	EmbeddedObjectBuilder
	Builder class to create a EmbeddedObject. More...
class	FileName
	Placeholder for java.io.File since C#'s FileInfo class throws exceptions if the file doesn't exist. More...
class	Name
class	NameUtil
class	ObjectClass
class	ObjectClassInfo
class	ObjectClassInfoBuilder
	Used to help facilitate the building of ObjectClassInfo objects. More...
class	ObjectClassUtil
class	OperationalAttributeInfos
	ConnectorAttributeInfo for each operational attribute.
class	OperationalAttributes
	Operational attributes have special meaning and cannot be represented by pure operations.
class	OperationOptionInfo
class	OperationOptionInfoBuilder
class	OperationOptions
	Arbitrary options to be passed into various operations. More...
class	OperationOptionsBuilder
	Builder for OperationOptions. More...
class	PredefinedAttributeInfos
class	PredefinedAttributes
	List of well known or pre-defined attributes.
class	QualifiedUid
	A fully-qualified uid. More...
class	Schema
	Determines the objects supported by a Org.IdentityConnectors.Framework.Spi.Connector. More...
class	SchemaBuilder
	Simple builder class to help facilitate creating a Schema object. More...
class	Script
	Represents a script in a scripting language. More...
class	ScriptBuilder
	Builder for Script. More...
class	ScriptContext
	Encapsulates a script and all of its parameters. More...
class	ScriptContextBuilder
	Builds an ScriptContext. More...
class	SyncDelta
	Represents a change to an object in a resource. More...
class	SyncDeltaBuilder
	Builder for SyncDelta. More...
class	SyncToken
	Abstract "place-holder" for synchronization. More...
class	Uid

Enumerations
enum	SyncDeltaType { SyncDeltaType.CREATE_OR_UPDATE, SyncDeltaType.DELETE }
	The type of change. More...

Functions
delegate bool	ResultsHandler (ConnectorObject obj)
	Encapsulate the handling of each object returned by the search. More...
delegate bool	SyncResultsHandler (SyncDelta delta)
	Called to handle a delta in the stream. More...

Enumeration Type Documentation

enum Org.IdentityConnectors.Framework.Common.Objects.SyncDeltaType

The type of change.

Enumerator
CREATE_OR_UPDATE	The change represents either a create or an update in the resource. These are combined into a single value because: Many resources will not be able to distinguish a create from an update. Those that have an audit log will be able to. However, many implementations will only have the current record and a modification timestamp. Regardless of whether or not the resource can distinguish the two cases, the application needs to distinguish.
DELETE	The change represents a DELETE in the resource

Function Documentation

delegate bool Org.IdentityConnectors.Framework.Common.Objects.ResultsHandler

(

ConnectorObject

obj

)

Encapsulate the handling of each object returned by the search.

delegate bool Org.IdentityConnectors.Framework.Common.Objects.SyncResultsHandler

(

SyncDelta

delta

)

Called to handle a delta in the stream.

Will be called multiple times, once for each result. Although a callback, this is still invoked synchronously. That is, it is guaranteed that following a call to SyncApiOp.Sync(ObjectClass, SyncToken, SyncResultsHandler, OperationOptions) no more invocations to Handle(SyncDelta) will be performed.

Parameters

delta

The change

Returns

True iff the application wants to continue processing more results.

Exceptions

Exception

If the application encounters an exception. This will stop the interation and the exception will be propogated back to the application.